guanaqo develop
Utilities for scientific software
Loading...
Searching...
No Matches
guanaqo::CircularRange< IndexT > Class Template Reference

#include <guanaqo/ringbuffer.hpp>

Detailed Description

template<class IndexT>
class guanaqo::CircularRange< IndexT >

Definition at line 153 of file ringbuffer.hpp.

Collaboration diagram for guanaqo::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

template<class IndexT>
using guanaqo::CircularRange< IndexT >::Index = IndexT

Definition at line 155 of file ringbuffer.hpp.

◆ Indices

template<class IndexT>
using guanaqo::CircularRange< IndexT >::Indices = CircularIndices<Index>

Definition at line 156 of file ringbuffer.hpp.

◆ const_iterator

template<class IndexT>
using guanaqo::CircularRange< IndexT >::const_iterator = CircularIndexIterator<Index>

Definition at line 161 of file ringbuffer.hpp.

◆ iterator

template<class IndexT>
using guanaqo::CircularRange< IndexT >::iterator = const_iterator

Definition at line 162 of file ringbuffer.hpp.

◆ const_reverse_iterator

template<class IndexT>
using guanaqo::CircularRange< IndexT >::const_reverse_iterator = ReverseCircularIndexIterator<Index>

Definition at line 164 of file ringbuffer.hpp.

◆ reverse_iterator

template<class IndexT>
using guanaqo::CircularRange< IndexT >::reverse_iterator = const_reverse_iterator

Definition at line 165 of file ringbuffer.hpp.

Constructor & Destructor Documentation

◆ CircularRange()

template<class IndexT>
guanaqo::CircularRange< IndexT >::CircularRange ( Index size,
Index idx1,
Index idx2,
Index max )
inline

Definition at line 158 of file ringbuffer.hpp.

Member Function Documentation

◆ begin()

template<class IndexT>
iterator guanaqo::CircularRange< IndexT >::begin ( ) const
inline

Definition at line 167 of file ringbuffer.hpp.

Here is the caller graph for this function:

◆ end()

template<class IndexT>
iterator guanaqo::CircularRange< IndexT >::end ( ) const
inline

Definition at line 168 of file ringbuffer.hpp.

Here is the caller graph for this function:

◆ cbegin()

template<class IndexT>
const_iterator guanaqo::CircularRange< IndexT >::cbegin ( ) const
inline

Definition at line 169 of file ringbuffer.hpp.

Here is the call graph for this function:

◆ cend()

template<class IndexT>
const_iterator guanaqo::CircularRange< IndexT >::cend ( ) const
inline

Definition at line 170 of file ringbuffer.hpp.

Here is the call graph for this function:

◆ rbegin()

template<class IndexT>
reverse_iterator guanaqo::CircularRange< IndexT >::rbegin ( ) const
inline

Definition at line 172 of file ringbuffer.hpp.

Here is the call graph for this function:

◆ rend()

template<class IndexT>
reverse_iterator guanaqo::CircularRange< IndexT >::rend ( ) const
inline

Definition at line 173 of file ringbuffer.hpp.

Here is the call graph for this function:

◆ crbegin()

template<class IndexT>
const_reverse_iterator guanaqo::CircularRange< IndexT >::crbegin ( ) const
inline

Definition at line 174 of file ringbuffer.hpp.

Here is the call graph for this function:

◆ crend()

template<class IndexT>
const_reverse_iterator guanaqo::CircularRange< IndexT >::crend ( ) const
inline

Definition at line 177 of file ringbuffer.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ size

template<class IndexT>
Index guanaqo::CircularRange< IndexT >::size
private

Definition at line 182 of file ringbuffer.hpp.

◆ idx1

template<class IndexT>
Index guanaqo::CircularRange< IndexT >::idx1
private

Definition at line 183 of file ringbuffer.hpp.

◆ idx2

template<class IndexT>
Index guanaqo::CircularRange< IndexT >::idx2
private

Definition at line 183 of file ringbuffer.hpp.

◆ max

template<class IndexT>
Index guanaqo::CircularRange< IndexT >::max
private

Definition at line 184 of file ringbuffer.hpp.


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