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

Iterator contiguous class. More...

#include <iterator_cont.hpp>

List of all members.

Public Member Functions

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

Public Attributes

unsigned int _rank
unsigned int _width

Detailed Description

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

Iterator contiguous class.

template of the contiguous iterator of SkelGIS. This is the first specialization of iterator class.

Template Parameters:
Tis the type of data stored in the DMatrix to manipulate with the iterator
Ris the overlap distance needed by the calculation, and the same overlap than in the DMatrix to manipulate with this iterator.

Definition at line 17 of file iterator_cont.hpp.


Constructor & Destructor Documentation

template<class T, int R>
skelgis::iterator_cont< T, R >::iterator_cont ( const unsigned int  r,
const unsigned int  w 
) [inline]

constructor of the iterator

Parameters:
ris the initial rank to assign to the iterator
wis the DMatrix width to assign to the iterator

Definition at line 34 of file iterator_cont.hpp.

template<class T, int R>
skelgis::iterator_cont< T, R >::iterator_cont ( const iterator_cont< 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 41 of file iterator_cont.hpp.


Member Function Documentation

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator!= ( const iterator_cont< 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 108 of file iterator_cont.hpp.

template<class T, int R>
iterator_cont<T,R>& skelgis::iterator_cont< 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 53 of file iterator_cont.hpp.

template<class T, int R>
iterator_cont<T,R>& skelgis::iterator_cont< 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 69 of file iterator_cont.hpp.

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator< ( const iterator_cont< 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 124 of file iterator_cont.hpp.

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator<= ( const iterator_cont< 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 116 of file iterator_cont.hpp.

template<class T, int R>
iterator_cont<T,R>& skelgis::iterator_cont< T, R >::operator= ( iterator_cont< 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 86 of file iterator_cont.hpp.

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator== ( const iterator_cont< 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 100 of file iterator_cont.hpp.

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator> ( const iterator_cont< 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 140 of file iterator_cont.hpp.

template<class T, int R>
bool skelgis::iterator_cont< T, R >::operator>= ( const iterator_cont< 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 132 of file iterator_cont.hpp.


Member Data Documentation

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

current rank of the iterator

Definition at line 21 of file iterator_cont.hpp.

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

width of the DMatrix associated to this iterator

Definition at line 22 of file iterator_cont.hpp.


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