SkelGIS  3.0
skelgis::iterator_step< T, R > Struct Template Reference

List of all members.

Public Member Functions

 iterator_step ()
 default constructor of the iterator
 iterator_step (const unsigned int r, const unsigned int w, int s=1, int n=1)
 constructor of the iterator
 iterator_step (const iterator_step< T, R > &it)
 constructor of the iterator from another iterator
 ~iterator_step ()
 Destructor of the iterator.
iterator_step< T, R > & operator++ ()
 operator ++ pre-incrementation of the iterator
iterator_step< T, R > & operator++ (int)
 operator ++ post-incrementation of the iterator
iterator_step< T, R > & operator= (iterator_step< T, R > right)
 operator = of the iterator
bool operator== (const iterator_step< T, R > &toTest)
 operator == of the iterator
bool operator!= (const iterator_step< T, R > &toTest)
 operator != of the iterator
bool operator<= (const iterator_step< T, R > &toComp)
 operator <= of the iterator
bool operator< (const iterator_step< T, R > &toComp)
 operator < of the iterator
bool operator>= (const iterator_step< T, R > &toComp)
 operator >= of the iterator
bool operator> (const iterator_step< T, R > &toComp)
 operator > of the iterator

Public Attributes

unsigned int _rank
unsigned int _width
int _step
int _nb
int _cpt

Detailed Description

template<class T, int R>
struct skelgis::iterator_step< T, R >

Definition at line 10 of file iterator_step.hpp.


Constructor & Destructor Documentation

template<class T, int R>
skelgis::iterator_step< T, R >::iterator_step ( const unsigned int  r,
const unsigned int  w,
int  s = 1,
int  n = 1 
) [inline]

constructor of the iterator

Parameters:
ris the initial rank to assign to the iterator
wis the DMatrix width to assign to the iterator
sis the step value to jump
nis the number of elements to read before the jump

Definition at line 32 of file iterator_step.hpp.

template<class T, int R>
skelgis::iterator_step< T, R >::iterator_step ( const iterator_step< T, R > &  it) [inline]

constructor of the iterator from another iterator

Parameters:
itis the other iterator instance from which to construct the new one

Definition at line 39 of file iterator_step.hpp.


Member Function Documentation

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator!= ( const iterator_step< T, R > &  toTest) [inline]

operator != of the iterator

This operation checks the inequality of two iterators with their rank values.

Returns:
true if the two iterator do not have the same rank. False otherwize.

Definition at line 136 of file iterator_step.hpp.

template<class T, int R>
iterator_step<T,R>& skelgis::iterator_step< T, R >::operator++ ( ) [inline]

operator ++ pre-incrementation of the iterator

This operation increments the position of the iterator in the DMatrix.

Returns:
a reference to the resulting iterator itself

Definition at line 51 of file iterator_step.hpp.

template<class T, int R>
iterator_step<T,R>& skelgis::iterator_step< T, R >::operator++ ( int  ) [inline]

operator ++ post-incrementation of the iterator

This operation increments the position of the iterator in the DMatrix.

Returns:
a reference to the resulting iterator itself

Definition at line 80 of file iterator_step.hpp.

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator< ( const iterator_step< T, R > &  toComp) [inline]

operator < of the iterator

This operation checks if the current iterator rank is smaller than the other one.

Returns:
true is the current iterator rank is smaller. False otherwize.

Definition at line 152 of file iterator_step.hpp.

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator<= ( const iterator_step< T, R > &  toComp) [inline]

operator <= of the iterator

This operation checks if the current iterator rank is smaller or equal to the other one.

Returns:
true is the current iterator rank is smaller or equal. False otherwize.

Definition at line 144 of file iterator_step.hpp.

template<class T, int R>
iterator_step<T,R>& skelgis::iterator_step< T, R >::operator= ( iterator_step< T, R >  right) [inline]

operator = of the iterator

This operation assigns another iterator informations to the current one.

Returns:
a reference to the resulting iterator itself

Definition at line 111 of file iterator_step.hpp.

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator== ( const iterator_step< T, R > &  toTest) [inline]

operator == of the iterator

This operation checks the equality of two iterators with their rank values.

Returns:
true if the two iterator have the same rank. False otherwize.

Definition at line 128 of file iterator_step.hpp.

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator> ( const iterator_step< T, R > &  toComp) [inline]

operator > of the iterator

This operation checks if the current iterator rank is biger than the other one.

Returns:
true is the current iterator rank is biger. False otherwize.

Definition at line 168 of file iterator_step.hpp.

template<class T, int R>
bool skelgis::iterator_step< T, R >::operator>= ( const iterator_step< T, R > &  toComp) [inline]

operator >= of the iterator

This operation checks if the current iterator rank is biger or equal to the other one.

Returns:
true is the current iterator rank is biger or equal. False otherwize.

Definition at line 160 of file iterator_step.hpp.


Member Data Documentation

template<class T, int R>
int skelgis::iterator_step< T, R >::_cpt

counter to know how much elements has been read for know

Definition at line 18 of file iterator_step.hpp.

template<class T, int R>
int skelgis::iterator_step< T, R >::_nb

number of contiguous elements to read

Definition at line 17 of file iterator_step.hpp.

template<class T, int R>
unsigned int skelgis::iterator_step< T, R >::_rank

current rank of the iterator

Definition at line 14 of file iterator_step.hpp.

template<class T, int R>
int skelgis::iterator_step< T, R >::_step

number of elements to jump after a read of _nb elements

Definition at line 16 of file iterator_step.hpp.

template<class T, int R>
unsigned int skelgis::iterator_step< T, R >::_width

width of the DMatrix associated to this iterator

Definition at line 15 of file iterator_step.hpp.


The documentation for this struct was generated from the following file:
 All Classes Files Functions Variables Defines