CircularIndices< IndexT > Struct Template Reference

#include <alpaqa/util/ringbuffer.hpp>

Detailed Description

template<class IndexT = size_t>
struct alpaqa::CircularIndices< IndexT >

Definition at line 9 of file ringbuffer.hpp.

Collaboration diagram for CircularIndices< IndexT >:

Public Types
using	Index = IndexT

Public Member Functions
	CircularIndices (Index zerobased, Index circular)

Public Attributes
Index	zerobased
Index	circular

Related Symbols
(Note that these are not member symbols.)
template<class IndexT >
bool	operator== (CircularIndices< IndexT > a, CircularIndices< IndexT > b)
template<class IndexT >
bool	operator!= (CircularIndices< IndexT > a, CircularIndices< IndexT > b)

Member Typedef Documentation

Index

template<class IndexT = size_t>

using Index = IndexT

Definition at line 10 of file ringbuffer.hpp.

Constructor & Destructor Documentation

CircularIndices()

template<class IndexT = size_t>

CircularIndices ( Index  zerobased, Index  circular  )

inline

Definition at line 11 of file ringbuffer.hpp.

Friends And Related Symbol Documentation

operator==()

template<class IndexT >

bool operator== ( CircularIndices< IndexT >  a, CircularIndices< IndexT >  b  )

related

Note

Only valid for two indices in the same range.

Definition at line 19 of file ringbuffer.hpp.

operator!=()

template<class IndexT >

bool operator!= ( CircularIndices< IndexT >  a, CircularIndices< IndexT >  b  )

related

Note

Only valid for two indices in the same range.

Definition at line 25 of file ringbuffer.hpp.

Member Data Documentation

zerobased

template<class IndexT = size_t>

Index zerobased

Definition at line 13 of file ringbuffer.hpp.

circular

template<class IndexT = size_t>

Index circular

Definition at line 14 of file ringbuffer.hpp.

---

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

• src/alpaqa/include/alpaqa/util/ringbuffer.hpp