A base class for iterators on site sets. More...

#include <site_set_iterator_base.hh>

Inheritance diagram for mln::internal::site_set_iterator_base< S, E >:

Public Types
typedef Site_Proxy< void >	category
typedef E	exact_t
typedef S	pset
	The associated site set type.
typedef S::site	site
	The associated site type (as a Site_Proxy).
typedef S	target
	The associated target type.
Public Member Functions
void	change_target (const S &s)
	Change the site set targeted by this iterator.
void	change_target_ (const S &s)
	Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).
void	invalidate ()
bool	is_valid () const
void	next ()
	Go to the next element.
const S::psite &	p_hook_ () const
	Hook to the current location.
const S &	site_set () const
	Give the site set that this iterator browses.
void	start ()
const S::psite &	subj_ ()
	Give the subject (required by the Proxy interface).
const S *&	target_ ()
	Give the target address. It might be 0.
const S::site &	to_site () const
	Return the site it points to (as a Site_Proxy).
Protected Member Functions
	site_set_iterator_base ()
	Constructor without argument.
Protected Attributes
S::psite	p_
	The psite designated by this iterator.
const S *	s_
	The target.

Detailed Description

template<typename S, typename E>
class mln::internal::site_set_iterator_base< S, E >

A base class for iterators on site sets.

Parameter S is the targeted site set type.

IMPORTANT: Sub-classes have to define start_, next_, is_valid_ and invalidate_. They may also define change_target_.

Definition at line 52 of file site_set_iterator_base.hh.

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 > >.

Definition at line 63 of file site_proxy.hh.

template<typename E>

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

Definition at line 173 of file object.hh.

template<typename S, typename E>

typedef S mln::internal::site_set_iterator_base< S, E >::pset

The associated site set type.

Definition at line 57 of file site_set_iterator_base.hh.

template<typename S, typename E>

typedef S ::site mln::internal::site_iterator_base< S, E >::site [inherited]

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename S, typename E>

typedef S mln::internal::site_iterator_base< S, E >::target [inherited]

The associated target type.

Definition at line 61 of file site_iterator_base.hh.

Constructor & Destructor Documentation

template<typename S , typename E >

mln::internal::site_set_iterator_base< S, E >::site_set_iterator_base ( ) [inline, protected]

Constructor without argument.

Definition at line 86 of file site_set_iterator_base.hh.

Member Function Documentation

template<typename S, typename E >

void mln::internal::site_set_iterator_base< S, E >::change_target ( const S & s ) [inline]

Change the site set targeted by this iterator.

Reimplemented in mln::p_double_piter< S, I1, I2 >.

Definition at line 102 of file site_set_iterator_base.hh.

References mln::exact(), mln::Site_Iterator< E >::invalidate(), and mln::internal::site_iterator_base< S, E >::s_.

Referenced by mln::p_double_piter< S, I1, I2 >::change_target(), and mln::internal::p_complex_piter_base_< I, S, P, E >::p_complex_piter_base_().

template<typename S, typename E >

void mln::internal::site_set_iterator_base< S, E >::change_target_ ( const S & s ) [inline]

Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).

Definition at line 117 of file site_set_iterator_base.hh.

template<typename E >

void mln::Site_Iterator< E >::invalidate ( ) [inline, inherited]

Definition at line 112 of file site_iterator.hh.

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

Referenced by mln::internal::site_relative_iterator_base< S, E, C >::center_at(), mln::internal::site_set_iterator_base< S, E >::change_target(), mln::internal::site_relative_iterator_base< S, E, C >::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, inherited]

Definition at line 101 of file site_iterator.hh.

References mln::exact().

Referenced by mln::Site_Iterator< E >::invalidate(), mln::Site_Iterator< E >::next(), mln::internal::site_relative_iterator_base< S, E, C >::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, C >::start_(), mln::internal::p_complex_piter_base_< I, S, P, E >::start_(), mln::internal::site_relative_iterator_base< S, E, C >::update(), and mln::internal::p_complex_piter_base_< I, S, P, E >::update_().

template<typename E >

void mln::Site_Iterator< E >::next ( ) [inline, inherited]

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.