Documentation class for mln::Site_Iterator. More...
#include <point_iterator.hh>
Inheritance diagram for mln::doc::Site_Iterator< E >:
Public Types | |
| typedef void | psite |
| Point_Site associated type. | |
Public Member Functions | |
| void | invalidate () |
| Invalidate the iterator. | |
| bool | is_valid () const |
| Returns true if the iterator is valid, that is, designates an element. | |
| void | next_ () |
| Go to the next element. | |
| operator psite () const | |
| Conversion into a point-site. | |
| void | start () |
| Start an iteration. | |
Detailed Description
template<typename E>
struct mln::doc::Site_Iterator< E >
Documentation class for mln::Site_Iterator.
- See also:
- mln::Site_Iterator
Definition at line 37 of file point_iterator.hh.
Member Typedef Documentation
template<typename E >
| typedef void mln::doc::Site_Iterator< E >::psite |
Point_Site associated type.
- Invariant:
- This type has to derive from mln::Point_Site.
Definition at line 43 of file point_iterator.hh.
Member Function Documentation
template<typename E >
| void mln::doc::Iterator< E >::invalidate | ( | ) | [inherited] |
Invalidate the iterator.
template<typename E >
| bool mln::doc::Iterator< E >::is_valid | ( | ) | const [inherited] |
Returns true if the iterator is valid, that is, designates an element.
template<typename E >
| void mln::doc::Iterator< E >::next_ | ( | ) | [inherited] |
Go to the next element.
Make the iterator jump from the current element to the next one. The current element is thus updated.
template<typename E >
| mln::doc::Site_Iterator< E >::operator psite | ( | ) | const |
Conversion into a point-site.
- Returns:
- A point site.
template<typename E >
| void mln::doc::Iterator< E >::start | ( | ) | [inherited] |
Start an iteration.
Make the iterator designate the first element if it exists. If this first element does not exist, the iterator is not valid.
