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

Iterator class. More...

#include <iterator_line.hpp>

List of all members.

Public Member Functions

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

Public Attributes

unsigned int _rank
unsigned int _width

Detailed Description

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

Iterator class.

template of the line iterator of SkelGIS. This is the first specialization of line 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 20 of file iterator_line.hpp.


Constructor & Destructor Documentation

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

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


Member Function Documentation

template<class T, int R>
iterator<T,R> skelgis::iterator_line< T, R >::begin ( ) [inline]

begin method of the line iterator

This method returns an iterator on the first element of the current line of the DMatrix. This iterator is then used until the end() method of the line iterator is reached.

Returns:
an iterator on the first element of the current line on the DMatrix

Definition at line 172 of file iterator_line.hpp.

template<class T, int R>
iterator_cont<T,R> skelgis::iterator_line< T, R >::begin_cont ( ) [inline]

begin_cont method of the line iterator

This method returns an iterator contiguous on the first element of the current line of the DMatrix. This iterator is then used until the end() method of the line iterator is reached.

Returns:
an iterator_cont on the first element of the current line on the DMatrix

Definition at line 180 of file iterator_line.hpp.

template<class T, int R>
iterator<T,R> skelgis::iterator_line< T, R >::end ( ) [inline]

end method of the line iterator

This method returns the end iterator on the current line of the DMatrix.

Returns:
the end iterator of the current line on the DMatrix

Definition at line 188 of file iterator_line.hpp.

template<class T, int R>
iterator_cont<T,R> skelgis::iterator_line< T, R >::end_cont ( ) [inline]

end_cont method of the line iterator

This method returns the end contiguous iterator on the current line of the DMatrix.

Returns:
the end_cont iterator of the current line on the DMatrix

Definition at line 196 of file iterator_line.hpp.

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

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

template<class T, int R>
iterator_line<T,R>& skelgis::iterator_line< 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_line.hpp.

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

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

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

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

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

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

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

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


Member Data Documentation

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

current rank of the iterator

Definition at line 24 of file iterator_line.hpp.

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

width of the DMatrix associated to this iterator

Definition at line 25 of file iterator_line.hpp.


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