aimsdata  5.1.2
Neuroimaging data handling
aims::cyclic_iterator< TContainer > Class Template Reference

A cyclic iterator is an iterator that goes back to the begining of the container when it reaches the end. More...

#include <aims/utility/cyclic_iterator.h>

Inheritance diagram for aims::cyclic_iterator< TContainer >:
Collaboration diagram for aims::cyclic_iterator< TContainer >:

Public Types

typedef detail::cyclic_iterator_base< typename TContainer::iterator > Base
 

Public Member Functions

 cyclic_iterator ()
 
 cyclic_iterator (TContainer &c)
 
 cyclic_iterator (TContainer &c, const typename TContainer::iterator &i)
 
- Public Member Functions inherited from aims::detail::cyclic_iterator_base< TContainer::iterator >
 cyclic_iterator_base ()
 
 cyclic_iterator_base (TContainer &c)
 
 cyclic_iterator_base (TContainer &c, const TContainer::iterator &i)
 NB: it is assumed that i does point on one of the element of c (end() accepted) More...
 
std::iterator_traits< TContainer::iterator >::reference operator* ()
 
const std::iterator_traits< TContainer::iterator >::reference operator* () const
 
void operator++ ()
 
void operator-- ()
 
bool operator!= (const TContainer::iterator &i)
 

Detailed Description

template<typename TContainer>
class aims::cyclic_iterator< TContainer >

A cyclic iterator is an iterator that goes back to the begining of the container when it reaches the end.

Definition at line 129 of file cyclic_iterator.h.

Member Typedef Documentation

◆ Base

template<typename TContainer >
typedef detail::cyclic_iterator_base<typename TContainer::iterator> aims::cyclic_iterator< TContainer >::Base

Definition at line 133 of file cyclic_iterator.h.

Constructor & Destructor Documentation

◆ cyclic_iterator() [1/3]

template<typename TContainer >
aims::cyclic_iterator< TContainer >::cyclic_iterator ( )
inline

Definition at line 135 of file cyclic_iterator.h.

◆ cyclic_iterator() [2/3]

template<typename TContainer >
aims::cyclic_iterator< TContainer >::cyclic_iterator ( TContainer &  c)
inline

Definition at line 136 of file cyclic_iterator.h.

◆ cyclic_iterator() [3/3]

template<typename TContainer >
aims::cyclic_iterator< TContainer >::cyclic_iterator ( TContainer &  c,
const typename TContainer::iterator &  i 
)
inline

Definition at line 137 of file cyclic_iterator.h.


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