CircularRange< IndexT > Class Template Reference

#include <alpaqa/include/alpaqa/util/ringbuffer.hpp>

Detailed Description

template<class IndexT>
class alpaqa::CircularRange< IndexT >

Definition at line 146 of file ringbuffer.hpp.

Collaboration diagram for CircularRange< IndexT >:

Public Types
using	Index = IndexT
using	Indices = CircularIndices< Index >
using	const_iterator = CircularIndexIterator< Index >
using	iterator = const_iterator
using	const_reverse_iterator = ReverseCircularIndexIterator< Index >
using	reverse_iterator = const_reverse_iterator

Public Member Functions
	CircularRange (Index size, Index idx1, Index idx2, Index max)
iterator	begin () const
iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
reverse_iterator	rbegin () const
reverse_iterator	rend () const
const_reverse_iterator	crbegin () const
const_reverse_iterator	crend () const

Private Attributes
Index	size
Index	idx1
Index	idx2
Index	max

Member Typedef Documentation

Index

using Index = IndexT

Definition at line 148 of file ringbuffer.hpp.

Indices

using Indices = CircularIndices<Index>

Definition at line 149 of file ringbuffer.hpp.

const_iterator

using const_iterator = CircularIndexIterator<Index>

Definition at line 154 of file ringbuffer.hpp.

iterator

using iterator = const_iterator

Definition at line 155 of file ringbuffer.hpp.

const_reverse_iterator

using const_reverse_iterator = ReverseCircularIndexIterator<Index>

Definition at line 157 of file ringbuffer.hpp.

reverse_iterator

using reverse_iterator = const_reverse_iterator

Definition at line 158 of file ringbuffer.hpp.

Constructor & Destructor Documentation

CircularRange()

CircularRange ( Index  size, Index  idx1, Index  idx2, Index  max  )

inline

Definition at line 151 of file ringbuffer.hpp.

Member Function Documentation

begin()

iterator begin ( ) const

inline

Definition at line 160 of file ringbuffer.hpp.

Here is the caller graph for this function:

end()

iterator end ( ) const

inline

Definition at line 161 of file ringbuffer.hpp.

Here is the caller graph for this function:

cbegin()

const_iterator cbegin ( ) const

inline

Definition at line 162 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

cend()

const_iterator cend ( ) const

inline

Definition at line 163 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

rbegin()

reverse_iterator rbegin ( ) const

inline

Definition at line 165 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

rend()

reverse_iterator rend ( ) const

inline

Definition at line 166 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

crbegin()

const_reverse_iterator crbegin ( ) const

inline

Definition at line 167 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

crend()

const_reverse_iterator crend ( ) const

inline

Definition at line 170 of file ringbuffer.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

size

Index size

private

Definition at line 175 of file ringbuffer.hpp.

idx1

Index idx1

private

Definition at line 176 of file ringbuffer.hpp.

idx2

Index idx2

private

Definition at line 176 of file ringbuffer.hpp.

max

Index max

private

Definition at line 177 of file ringbuffer.hpp.

---

The documentation for this class was generated from the following file:

• ringbuffer.hpp