SISCone  2.0.5
Public Member Functions
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>

List of all members.

Public Member Functions

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

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

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

ctor with iniitalisation from iterators

Parameters:
herethe current position
beginthe first position
endthe last position

Definition at line 43 of file circulator.h.

template<class T>
siscone::circulator< T >::circulator ( const circulator< T > &  other)
inline

copy ctor

Parameters:
otherthe circulator to copy

Definition at line 47 of file circulator.h.


Member Function Documentation

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:
otherthe circulator to compare to the current one

Definition at line 82 of file circulator.h.

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:
otherthe circulator to compare to the current one

Definition at line 77 of file circulator.h.

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:
otherthe circulator to grab position from

Definition at line 51 of file circulator.h.

template<class T>
void siscone::circulator< T >::set_position ( pointer)
inline

set just the position without resetting the begin and end elements

Parameters:
pointerthe 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:
The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated on Wed May 30 2012 06:46:25 for SISCone by  Doxygen 1.8.1