siscone::circulator< T > Class Template Reference

a circulator that is foreseen to take as template member either a pointer or an iterator; More...

#include <circulator.h>

Public Member Functions
	circulator (T here, T begin, T end)
	ctor with iniitalisation from iterators More...
	circulator (const circulator< T > &other)
	copy ctor More...
void	set_position (const circulator< T > &other)
	set just the position without resetting the begin and end elements More...
void	set_position (T pointer)
	set just the position without resetting the begin and end elements More...
T	operator() ()
	get the current object More...
circulator< T > &	operator++ ()
	position incrementation More...
circulator< T > &	operator-- ()
	position decrementation More...
bool	operator== (const circulator &other) const
	check if the current elements are the same NB: for efficiency, this checks only the here element More...
bool	operator!= (const circulator &other) const
	check if the current elements are different NB: for efficiency, this checks only the here element More...

Detailed Description

template<class T>
class siscone::circulator< T >

a circulator that is foreseen to take as template member either a pointer or an iterator;

Definition at line 36 of file circulator.h.

Constructor & Destructor Documentation

circulator() [1/2]

template<class T >

siscone::circulator< T >::circulator ( T  here, T  begin, T  end  )

inline

ctor with iniitalisation from iterators

Parameters

here	the current position
begin	the first position
end	the last position

Definition at line 43 of file circulator.h.

circulator() [2/2]

template<class T >

siscone::circulator< T >::circulator ( const circulator< T > &  other )

inline

copy ctor

Parameters

other

the circulator to copy

Definition at line 47 of file circulator.h.

Member Function Documentation

operator!=()

template<class T >

bool siscone::circulator< T >::operator!= ( const circulator< T > &  other ) const

inline

check if the current elements are different NB: for efficiency, this checks only the here element

Parameters

other

the circulator to compare to the current one

Definition at line 82 of file circulator.h.

operator()()

template<class T >

T siscone::circulator< T >::operator() ( )

inline

get the current object

Definition at line 58 of file circulator.h.

operator++()

template<class T >

circulator< T > & siscone::circulator< T >::operator++ ( )

inline

position incrementation

Definition at line 61 of file circulator.h.

operator--()

template<class T >

circulator< T > & siscone::circulator< T >::operator-- ( )

inline

position decrementation

Definition at line 68 of file circulator.h.

operator==()

template<class T >

bool siscone::circulator< T >::operator== ( const circulator< T > &  other ) const

inline

check if the current elements are the same NB: for efficiency, this checks only the here element

Parameters

other

the circulator to compare to the current one

Definition at line 77 of file circulator.h.

set_position() [1/2]

template<class T >

void siscone::circulator< T >::set_position ( const circulator< T > &  other )

inline

set just the position without resetting the begin and end elements

Parameters

other

the circulator to grab position from

Definition at line 51 of file circulator.h.

set_position() [2/2]

template<class T >

void siscone::circulator< T >::set_position ( T  pointer )

inline

set just the position without resetting the begin and end elements

Parameters

pointer

the iterator to use as the new position

Definition at line 55 of file circulator.h.

---

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

• siscone/circulator.h