mln::Site_Iterator< E > Struct Template Reference

Base class for implementation of classes of iterator on points. More...

#include <site_iterator.hh>

Inheritance diagram for mln::Site_Iterator< E >:

List of all members.

Public Types
typedef Site_Proxy< void >	category
typedef E	exact_t
Public Member Functions
void	invalidate ()
bool	is_valid () const
void	next ()
	Go to the next element.
void	start ()
Protected Member Functions
	Site_Iterator ()

---

Detailed Description

template<typename E>
struct mln::Site_Iterator< E >

Base class for implementation of classes of iterator on points.

An iterator on points is an iterator that browse over a set of points.

See also:

mln::doc::Site_Iterator for a complete documentation of this class contents.

---

Member Typedef Documentation

template<typename E>

typedef Site_Proxy<void> mln::Site_Proxy< E >::category [inherited]

Reimplemented from mln::Proxy< E >.

Reimplemented in mln::Pseudo_Site< E >, mln::Pseudo_Site< complex_psite< D, G > >, mln::Pseudo_Site< p_edges_psite< G, F > >, mln::Pseudo_Site< p_indexed_psite< S > >, mln::Pseudo_Site< p_double_psite< S, Sp > >, mln::Pseudo_Site< faces_psite< N, D, P > >, mln::Pseudo_Site< p_run_psite< P > >, and mln::Pseudo_Site< p_vertices_psite< G, F > >.

template<typename E>

typedef E mln::Object< E >::exact_t [inherited]

---

Constructor & Destructor Documentation

template<typename E >

mln::Site_Iterator< E >::Site_Iterator

(

)

[inline, protected]

---

Member Function Documentation

template<typename E >

void mln::Site_Iterator< E >::invalidate

(

)

[inline]

References mln::exact(), and mln::Site_Iterator< E >::is_valid().

Referenced by mln::internal::site_relative_iterator_base< S, E >::center_at(), mln::internal::site_set_iterator_base< S, E >::change_target(), mln::internal::site_relative_iterator_base< S, E >::change_target(), mln::internal::piter_adaptor_< Pi, S, E >::change_target(), and mln::p_transformed_piter< Pi, S, F >::change_target().

template<typename E >

bool mln::Site_Iterator< E >::is_valid

(

)

const [inline]

References mln::exact().

Referenced by mln::Site_Iterator< E >::invalidate(), mln::Site_Iterator< E >::next(), mln::internal::site_relative_iterator_base< S, E >::next_(), mln::internal::p_complex_piter_base_< I, S, P, E >::next_(), mln::internal::p_complex_piter_base_< I, S, P, E >::p_complex_piter_base_(), mln::internal::site_relative_iterator_base< S, E >::start_(), mln::internal::p_complex_piter_base_< I, S, P, E >::start_(), mln::internal::site_relative_iterator_base< S, E >::update(), and mln::internal::p_complex_piter_base_< I, S, P, E >::update_().

template<typename E >

void mln::Site_Iterator< E >::next

(

)

[inline]

Go to the next element.

Warning:

This is a final method; iterator classes should not re-defined this method. The actual "next" operation has to be defined through the next_ method.

Precondition:

The iterator is valid.

References mln::exact(), and mln::Site_Iterator< E >::is_valid().

template<typename E >

void mln::Site_Iterator< E >::start

(

)

[inline]

References mln::exact().