#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 Functions
(Note that these are not member functions.)
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

using Index = IndexT

Definition at line 10 of file ringbuffer.hpp.

Constructor & Destructor Documentation

◆ CircularIndices()

CircularIndices	(	Index	zerobased,
		Index	circular
	)

inline

Definition at line 11 of file ringbuffer.hpp.

Friends And Related Function Documentation

◆ operator==()

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

Note: Only valid for two indices in the same range.

Definition at line 19 of file ringbuffer.hpp.

◆ operator!=()

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

Note: Only valid for two indices in the same range.

Definition at line 25 of file ringbuffer.hpp.

Member Data Documentation

◆ zerobased

Index zerobased

Definition at line 13 of file ringbuffer.hpp.

◆ circular

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