SkelGIS  3.0
skelgis::iterator< T, 0 > Struct Template Reference

Iterator class. More...

#include <iterator.hpp>

List of all members.

Public Member Functions

 iterator ()
 default constructor of the iterator
 iterator (const unsigned int r)
 constructor of the iterator
 iterator (const iterator< T, 0 > &it)
 constructor of the iterator from another iterator
 ~iterator ()
 Destructor of the iterator.
iterator< T, 0 > & operator++ ()
 operator ++ pre-incrementation of the iterator
iterator< T, 0 > & operator++ (int)
 operator ++ post-incrementation of the iterator
iterator< T, 0 > & operator+= (int _d)
 operator += of the iterator
iterator< T, 0 > & operator-- ()
 operator -- pre-decrementation of the iterator
iterator< T, 0 > & operator-- (int)
 operator -- post-decrementation of the iterator
iterator< T, 0 > & operator-= (int _d)
 operator -= of the iterator
iterator< T, 0 > & operator= (iterator< T, 0 > right)
 operator = of the iterator
bool operator== (const iterator< T, 0 > &toTest)
 operator = of the iterator
bool operator!= (const iterator< T, 0 > &toTest)
 operator != of the iterator
bool operator<= (const iterator< T, 0 > &toComp)
 operator <= of the iterator
bool operator< (const iterator< T, 0 > &toComp)
 operator <= of the iterator
bool operator>= (const iterator< T, 0 > &toComp)
 operator >= of the iterator
bool operator> (const iterator< T, 0 > &toComp)
 operator > of the iterator

Public Attributes

unsigned int _rank

Detailed Description

template<class T>
struct skelgis::iterator< T, 0 >

Iterator class.

template of the basic iterator of SkelGIS. This is the second specialization of iterator class.

Template Parameters:
Tis the type of data stored in the DMatrix to manipulate with the iterator R is specialized with the value 0

Definition at line 219 of file iterator.hpp.


Constructor & Destructor Documentation

template<class T >
skelgis::iterator< T, 0 >::iterator ( const unsigned int  r) [inline]

constructor of the iterator

Parameters:
ris the initial rank to assign to the iterator

Definition at line 234 of file iterator.hpp.

template<class T >
skelgis::iterator< T, 0 >::iterator ( const iterator< T, 0 > &  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 241 of file iterator.hpp.


Member Function Documentation

template<class T >
bool skelgis::iterator< T, 0 >::operator!= ( const iterator< T, 0 > &  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 322 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::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 253 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::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 261 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::operator+= ( int  _d) [inline]

operator += of the iterator

This operation increments the position of the iterator with a given index and assigns the new rank to the current iterator.

Returns:
a reference to the resulting iterator itself

Definition at line 269 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::operator-- ( ) [inline]

operator -- pre-decrementation of the iterator

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

Returns:
a reference to the resulting iterator itself

Definition at line 277 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::operator-- ( int  ) [inline]

operator -- post-decrementation of the iterator

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

Returns:
a reference to the resulting iterator itself

Definition at line 285 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::operator-= ( int  _d) [inline]

operator -= of the iterator

This operation decrements the position of the iterator with a given index and assigns the new rank to the current iterator.

Returns:
a reference to the resulting iterator itself

Definition at line 293 of file iterator.hpp.

template<class T >
bool skelgis::iterator< T, 0 >::operator< ( const iterator< T, 0 > &  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 338 of file iterator.hpp.

template<class T >
bool skelgis::iterator< T, 0 >::operator<= ( const iterator< T, 0 > &  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 330 of file iterator.hpp.

template<class T >
iterator<T,0>& skelgis::iterator< T, 0 >::operator= ( iterator< T, 0 >  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 301 of file iterator.hpp.

template<class T >
bool skelgis::iterator< T, 0 >::operator== ( const iterator< T, 0 > &  toTest) [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 314 of file iterator.hpp.

template<class T >
bool skelgis::iterator< T, 0 >::operator> ( const iterator< T, 0 > &  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 354 of file iterator.hpp.

template<class T >
bool skelgis::iterator< T, 0 >::operator>= ( const iterator< T, 0 > &  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 346 of file iterator.hpp.


Member Data Documentation

template<class T >
unsigned int skelgis::iterator< T, 0 >::_rank

current rank of the iterator

Definition at line 223 of file iterator.hpp.


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