mln::internal::site_iterator_base< S, E > Struct Template Reference

A base class for site iterators. More...

#include <site_iterator_base.hh>

Inherits mln::Site_Iterator< E >, and internal::proxy_impl< const S::psite &, E >.

Inherited by mln::internal::piter_adaptor_< Pi, S, E >, mln::internal::site_relative_iterator_base< S, E, C >, and mln::internal::site_set_iterator_base< S, E >.

List of all members.

Public Types
typedef Site_Proxy< void >	category
typedef E	exact_t
typedef S::site	site
	The associated site type (as a Site_Proxy).
typedef S	target
	The associated target type.
Public Member Functions
void	invalidate ()
bool	is_valid () const
void	next ()
	Go to the next element.
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_iterator_base ()
Protected Attributes
const S *	s_
	The target.
Private Types
typedef proxy_impl< const typename S::psite &, E >	super_

---

Detailed Description

template<typename S, typename E>
struct mln::internal::site_iterator_base< S, E >

A base class for site iterators.

NEVER DIRECTLY DERIVE FROM THIS CLASS.

Instead derive EITHER from site_set_iterator_base OR from site_relative_iterator_base OR from piter_adaptor_.

Parameter S is the targeted "site set definition" type. It can be either a Site_Set, a Window, or a Neighborhood.

Definition at line 57 of file site_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< mln::p_run_psite< P > >, mln::Pseudo_Site< mln::p_indexed_psite< S > >, mln::Pseudo_Site< mln::p_vertices_psite< G, F > >, mln::Pseudo_Site< mln::faces_psite< N, D, P > >, mln::Pseudo_Site< mln::complex_psite< D, G > >, mln::Pseudo_Site< mln::p_double_psite< S, Sp > >, and mln::Pseudo_Site< mln::p_edges_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 172 of file object.hh.

template<typename S, typename E>

typedef S ::site mln::internal::site_iterator_base< S, E >::site

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename S, typename E>

typedef proxy_impl< const typename S ::psite&, E> mln::internal::site_iterator_base< S, E >::super_ [private]

Reimplemented in mln::box_runend_piter< P >, mln::box_runstart_piter< P >, mln::complex_neighborhood_fwd_piter< I, G, N >, mln::complex_neighborhood_bkd_piter< I, G, N >, mln::complex_window_fwd_piter< I, G, W >, mln::complex_window_bkd_piter< I, G, W >, mln::hexa_fwd_piter_< S >, mln::graph_window_if_piter< S, W, I >, mln::graph_window_piter< S, W, I >, mln::internal::p_complex_piter_base_< I, S, P, E >, mln::internal::piter_identity_< Pi, E >, mln::mixed_neighb_fwd_niter< W >, mln::mixed_neighb_bkd_niter< W >, mln::neighb_fwd_niter< W >, mln::neighb_bkd_niter< W >, mln::p_complex_faces_fwd_piter_< N, D, P >, mln::p_complex_faces_bkd_piter_< N, D, P >, mln::p_faces_fwd_piter_< N, D, P >, mln::p_faces_bkd_piter_< N, D, P >, mln::box_fwd_piter_< P >, mln::box_bkd_piter_< P >, mln::p_centered_piter< W >, mln::p_complex_fwd_piter_< D, G >, mln::p_complex_bkd_piter_< D, G >, mln::p_double_piter< S, I1, I2 >, mln::p_graph_piter< S, I >, mln::p_if_piter_< Pi, S, F >, mln::p_n_faces_fwd_piter< D, P >, mln::p_n_faces_bkd_piter< D, P >, mln::p_run_fwd_piter_< P >, mln::p_run_bkd_piter_< P >, mln::p_transformed_piter< Pi, S, F >, mln::morpho::tree::up_site_piter< T >, mln::morpho::tree::dn_site_piter< T >, mln::morpho::tree::up_node_piter< T >, mln::morpho::tree::dn_node_piter< T >, mln::morpho::tree::up_leaf_piter< T >, mln::morpho::tree::dn_leaf_piter< T >, mln::morpho::tree::depth1st_piter< T >, mln::win::multiple_qiter< W, F >, mln::win::multiple_size_qiter< n, W, F >, mln::internal::p_complex_piter_base_< mln::topo::n_face_fwd_iter< D >, mln::p_complex< D, P >, P, mln::p_n_faces_fwd_piter< D, P > >, mln::internal::p_complex_piter_base_< mln::topo::face_bkd_iter< D >, mln::p_complex< D, G >, G::site, mln::p_complex_bkd_piter_< D, G > >, mln::internal::p_complex_piter_base_< mln::topo::faces_bkd_iter_< N, D >, mln::p_complex< D, P >, P, mln::p_complex_faces_bkd_piter_< N, D, P > >, mln::internal::p_complex_piter_base_< mln::topo::n_face_bkd_iter< D >, mln::p_complex< D, P >, P, mln::p_n_faces_bkd_piter< D, P > >, mln::internal::p_complex_piter_base_< mln::topo::face_fwd_iter< D >, mln::p_complex< D, G >, G::site, mln::p_complex_fwd_piter_< D, G > >, mln::internal::p_complex_piter_base_< mln::topo::faces_bkd_iter_< N, D >, mln::p_faces< N, D, P >, P, mln::p_faces_bkd_piter_< N, D, P > >, mln::internal::p_complex_piter_base_< mln::topo::faces_fwd_iter_< N, D >, mln::p_faces< N, D, P >, P, mln::p_faces_fwd_piter_< N, D, P > >, mln::internal::p_complex_piter_base_< mln::topo::faces_fwd_iter_< N, D >, mln::p_complex< D, P >, P, mln::p_complex_faces_fwd_piter_< N, D, P > >, mln::internal::piter_identity_< T::nodes_t::bkd_piter, mln::morpho::tree::dn_node_piter< T > >, mln::internal::piter_identity_< T::sites_t::fwd_piter, mln::morpho::tree::dn_site_piter< T > >, mln::internal::piter_identity_< T::sites_t::bkd_piter, mln::morpho::tree::up_site_piter< T > >, mln::internal::piter_identity_< T::leaves_t::fwd_piter, mln::morpho::tree::up_leaf_piter< T > >, mln::internal::piter_identity_< T::nodes_t::fwd_piter, mln::morpho::tree::up_node_piter< T > >, and mln::internal::piter_identity_< T::leaves_t::bkd_piter, mln::morpho::tree::dn_leaf_piter< T > >.

Definition at line 94 of file site_iterator_base.hh.

template<typename S, typename E>

typedef S mln::internal::site_iterator_base< S, E >::target

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_iterator_base< S, E >::site_iterator_base

(

)

[inline, protected]

Definition at line 102 of file site_iterator_base.hh.

---

Member Function Documentation

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(), mln::p_transformed_piter< Pi, S, F >::change_target(), and mln::morpho::tree::depth1st_piter< T >::start_().

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::graph_window_piter< S, W, I >::init_(), mln::graph_window_if_piter< S, W, I >::init_(), mln::complex_window_bkd_piter< I, G, W >::init_(), mln::complex_window_fwd_piter< I, G, W >::init_(), mln::complex_neighborhood_bkd_piter< I, G, N >::init_(), mln::complex_neighborhood_fwd_piter< I, G, N >::init_(), mln::Site_Iterator< E >::invalidate(), mln::Site_Iterator< E >::next(), mln::internal::site_relative_iterator_base< S, E, C >::next_(), mln::p_graph_piter< S, I >::next_(), mln::internal::p_complex_piter_base_< I, S, P, E >::next_(), mln::morpho::tree::depth1st_piter< T >::next_(), mln::internal::p_complex_piter_base_< I, S, P, E >::p_complex_piter_base_(), mln::p_graph_piter< S, I >::p_graph_piter(), mln::internal::site_relative_iterator_base< S, E, C >::start_(), mln::p_graph_piter< S, I >::start_(), mln::internal::p_complex_piter_base_< I, S, P, E >::start_(), mln::internal::site_relative_iterator_base< S, E, C >::update(), mln::p_graph_piter< S, I >::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.

Precondition:

The iterator is valid.

Definition at line 92 of file site_iterator.hh.

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

Referenced by mln::morpho::tree::depth1st_piter< T >::start_().

template<typename E>

void mln::Site_Iterator< E >::start

(

)

[inline, inherited]

Reimplemented in mln::hexa_fwd_piter_< S >.

Definition at line 123 of file site_iterator.hh.

References mln::exact().

template<typename S, typename E>

const S::psite & mln::internal::site_iterator_base< S, E >::subj_

(

)

[inline]

Give the subject (required by the Proxy interface).

Reimplemented in mln::internal::site_relative_iterator_base< S, E, C >, mln::internal::site_relative_iterator_base< N, mln::complex_neighborhood_fwd_piter< I, G, N > >, mln::internal::site_relative_iterator_base< V, mln::dpsites_bkd_piter< V > >, mln::internal::site_relative_iterator_base< W, mln::graph_window_if_piter< S, W, I > >, mln::internal::site_relative_iterator_base< mln::mixed_neighb< W >, mln::neighb_fwd_niter< W >, mln::mixed_neighb< W >::psite >, mln::internal::site_relative_iterator_base< V, mln::dpsites_fwd_piter< V > >, mln::internal::site_relative_iterator_base< mln::win::multiple< W, F >, mln::win::multiple_qiter< W, F > >, mln::internal::site_relative_iterator_base< W, mln::complex_window_bkd_piter< I, G, W > >, mln::internal::site_relative_iterator_base< N, mln::complex_neighborhood_bkd_piter< I, G, N > >, mln::internal::site_relative_iterator_base< mln::neighb< W >, mln::neighb_fwd_niter< W >, mln::neighb< W >::psite >, mln::internal::site_relative_iterator_base< mln::win::multiple_size< n, W, F >, mln::win::multiple_size_qiter< n, W, F > >, mln::internal::site_relative_iterator_base< W, mln::graph_window_piter< S, W, I >, W::center_t >, mln::internal::site_relative_iterator_base< N, E, N::psite >, mln::internal::site_relative_iterator_base< W, mln::complex_window_fwd_piter< I, G, W > >, mln::internal::site_relative_iterator_base< mln::mixed_neighb< W >, mln::neighb_bkd_niter< W >, mln::mixed_neighb< W >::psite >, and mln::internal::site_relative_iterator_base< mln::neighb< W >, mln::neighb_bkd_niter< W >, mln::neighb< W >::psite >.

Definition at line 119 of file site_iterator_base.hh.

References mln::exact().

template<typename S, typename E>

const S *& mln::internal::site_iterator_base< S, E >::target_

(

)

[inline]

Give the target address. It might be 0.

Definition at line 127 of file site_iterator_base.hh.

template<typename S, typename E>

const S::site & mln::internal::site_iterator_base< S, E >::to_site

(

)

const [inline]

Return the site it points to (as a Site_Proxy).

Definition at line 110 of file site_iterator_base.hh.

References mln::exact().

---

Member Data Documentation

template<typename S, typename E>

const S* mln::internal::site_iterator_base< S, E >::s_ [protected]

The target.

Reimplemented in mln::graph_window_piter< S, W, I >.

Definition at line 90 of file site_iterator_base.hh.

Referenced by 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(), mln::p_transformed_piter< Pi, S, F >::change_target(), mln::win::multiple_size_qiter< n, W, F >::compute_p_(), mln::win::multiple_qiter< W, F >::compute_p_(), mln::dpsites_bkd_piter< V >::compute_p_(), mln::dpsites_fwd_piter< V >::compute_p_(), mln::dpsites_bkd_piter< V >::do_start_(), mln::p_run_fwd_piter_< P >::invalidate_(), mln::p_indexed_fwd_piter< S >::invalidate_(), mln::dpsites_fwd_piter< V >::invalidate_(), mln::box_runstart_piter< P >::invalidate_(), mln::box_runend_piter< P >::invalidate_(), mln::box_bkd_piter_< P >::invalidate_(), mln::box_fwd_piter_< P >::invalidate_(), mln::p_run_bkd_piter_< P >::is_valid_(), mln::p_run_fwd_piter_< P >::is_valid_(), mln::p_indexed_bkd_piter< S >::is_valid_(), mln::p_indexed_fwd_piter< S >::is_valid_(), mln::dpsites_fwd_piter< V >::is_valid_(), mln::box_runstart_piter< P >::is_valid_(), mln::box_runend_piter< P >::is_valid_(), mln::box_bkd_piter_< P >::is_valid_(), mln::box_fwd_piter_< P >::is_valid_(), mln::p_transformed_piter< Pi, S, F >::next_(), mln::p_if_piter_< Pi, S, F >::next_(), mln::morpho::tree::depth1st_piter< T >::next_(), mln::box_runstart_piter< P >::next_(), mln::box_runend_piter< P >::next_(), mln::box_bkd_piter_< P >::next_(), mln::box_fwd_piter_< P >::next_(), mln::p_double_piter< S, I1, I2 >::progress_(), mln::box_runstart_piter< P >::run_length(), mln::box_runend_piter< P >::run_length(), mln::internal::site_set_iterator_base< S, E >::site_set(), mln::internal::site_relative_iterator_base< S, E, C >::site_set(), mln::win::multiple_size_qiter< n, W, F >::size_(), mln::morpho::tree::depth1st_piter< T >::skip_children(), mln::p_transformed_piter< Pi, S, F >::start_(), mln::p_run_bkd_piter_< P >::start_(), mln::p_if_piter_< Pi, S, F >::start_(), mln::p_double_piter< S, I1, I2 >::start_(), mln::p_indexed_bkd_piter< S >::start_(), mln::morpho::tree::depth1st_piter< T >::start_(), mln::box_runstart_piter< P >::start_(), mln::box_runend_piter< P >::start_(), mln::box_bkd_piter_< P >::start_(), mln::box_fwd_piter_< P >::start_(), and mln::internal::site_relative_iterator_base< S, E, C >::update().