mln::internal::piter_identity_< Pi, E > Class Template Reference

A base class for site iterator identity adaptors. More...

#include <piter_identity.hh>

Inheritance diagram for mln::internal::piter_identity_< Pi, E >:

Inheritance graph

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 change_target (const S &s)
 Change the site set targeted by this iterator.
void invalidate ()
void invalidate_ ()
 Invalidate the iterator.
bool is_valid () const
bool is_valid_ () const
 Test the iterator validity.
void next ()
 Go to the next element.
void next_ ()
 Go to the next point.
const S::psite & p_hook_ () const
 Hook to the current location.
void pi_change_target_ (const S &s)
 Change the site set targeted by pi_.
void start ()
void start_ ()
 Start an iteration.
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

 piter_identity_ (const Pi &piter)
 Constructor from a point iterator piter.
 piter_identity_ ()
 Constructor without argument.

Protected Attributes

Pi pi_
 The adaptee site iterator.
const S * s_
 The target.

Private Types

typedef piter_adaptor_< Pi,
mln_pset(Pi), E > 
super_


Detailed Description

template<typename Pi, typename E>
class mln::internal::piter_identity_< Pi, E >

A base class for site iterator identity adaptors.

Parameter Pi is the type of the site iterator adaptee; parameter E is the exact type.

Definition at line 48 of file piter_identity.hh.


Member Typedef Documentation

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

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 [inherited]

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename Pi, typename E>
typedef piter_adaptor_< Pi, mln_pset(Pi), E > mln::internal::piter_identity_< Pi, E >::super_ [private]

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 Pi, typename E>
mln::internal::piter_identity_< Pi, E >::piter_identity_ (  )  [inline, protected]

Constructor without argument.

Definition at line 68 of file piter_identity.hh.

template<typename Pi, typename E>
mln::internal::piter_identity_< Pi, E >::piter_identity_ ( const Pi &  piter  )  [inline, protected]

Constructor from a point iterator piter.

Definition at line 74 of file piter_identity.hh.


Member Function Documentation

template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::change_target ( const S &  s  )  [inline, inherited]

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

template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::invalidate_ (  )  [inline, inherited]

Invalidate the iterator.

Definition at line 119 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

Referenced by mln::internal::piter_adaptor_< Pi, S, E >::piter_adaptor_().

template<typename E>
bool mln::Site_Iterator< E >::is_valid (  )  const [inline, inherited]

template<typename Pi, typename S, typename E>
bool mln::internal::piter_adaptor_< Pi, S, E >::is_valid_ (  )  const [inline, inherited]

Test the iterator validity.

Definition at line 111 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

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 Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::next_ (  )  [inline, inherited]

Go to the next point.

Reimplemented in mln::hexa_fwd_piter_< S >, and mln::p_if_piter_< Pi, S, F >.

Definition at line 135 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

template<typename Pi, typename S, typename E>
const S::psite & mln::internal::piter_adaptor_< Pi, S, E >::p_hook_ (  )  const [inline, inherited]

Hook to the current location.

Definition at line 143 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::pi_change_target_ ( const S &  s  )  [inline, inherited]

Change the site set targeted by pi_.

This default impl is a no-op. This method might be overridden.

Definition at line 164 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

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 Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::start_ (  )  [inline, inherited]

Start an iteration.

Reimplemented in mln::p_if_piter_< Pi, S, F >.

Definition at line 127 of file piter_adaptor.hh.

References mln::internal::piter_adaptor_< Pi, S, E >::pi_.

template<typename S, typename E>
const S::psite & mln::internal::site_iterator_base< S, E >::subj_ (  )  [inline, inherited]

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, inherited]

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, inherited]

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 Pi, typename S, typename E>
Pi mln::internal::piter_adaptor_< Pi, S, E >::pi_ [protected, inherited]

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

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


Generated on Sun Apr 25 02:02:44 2010 for Milena (Olena) by  doxygen 1.5.6