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

Iterator class. More...

#include <iterator_phb.hpp>

List of all members.

Public Member Functions

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

Iterator class.

template of the down physical border iterator of SkelGIS. This is the first specialization of iterator_phb_down 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 454 of file iterator_phb.hpp.


Constructor & Destructor Documentation

template<class T, int R>
skelgis::iterator_phb_down< T, R >::iterator_phb_down ( 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 471 of file iterator_phb.hpp.

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


Member Function Documentation

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

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

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

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

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

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

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

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

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


Member Data Documentation

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

current rank of the iterator

Definition at line 458 of file iterator_phb.hpp.

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

width of the DMatrix associated to this iterator

Definition at line 459 of file iterator_phb.hpp.


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