guanaqo::CircularIndices< IndexT > Struct Template Reference

#include <guanaqo/ringbuffer.hpp>

Detailed Description

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

Definition at line 13 of file ringbuffer.hpp.

Collaboration diagram for guanaqo::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 guanaqo::CircularIndices< IndexT >::Index = IndexT

Definition at line 14 of file ringbuffer.hpp.

Constructor & Destructor Documentation

CircularIndices()

template<class IndexT = size_t>

guanaqo::CircularIndices< IndexT >::CircularIndices ( Index zerobased, Index circular )

inline

Definition at line 15 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 23 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 29 of file ringbuffer.hpp.

Member Data Documentation

zerobased

template<class IndexT = size_t>

Index guanaqo::CircularIndices< IndexT >::zerobased

Definition at line 17 of file ringbuffer.hpp.

circular

template<class IndexT = size_t>

Index guanaqo::CircularIndices< IndexT >::circular

Definition at line 18 of file ringbuffer.hpp.

---

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

• include/guanaqo/ringbuffer.hpp