A base class for point iterator adaptors. More...
#include <piter_adaptor.hh>
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_. | |
| piter_adaptor_ () | |
| Constructor without argument. | |
| piter_adaptor_ (const Pi &piter) | |
Constructor from a point iterator piter. | |
| 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 Attributes | |
| Pi | pi_ |
| The adaptee site iterator. | |
| const S * | s_ |
| The target. | |
Detailed Description
template<typename Pi, typename S, typename E>
class mln::internal::piter_adaptor_< Pi, S, E >
A base class for point iterator adaptors.
Parameter Pi is the type of the point iterator adaptee; parameter E is the exact type.
Member Typedef Documentation
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 > >.
typedef E mln::Object< E >::exact_t [inherited] |
typedef S ::site mln::internal::site_iterator_base< S, E >::site [inherited] |
The associated site type (as a Site_Proxy).
typedef S mln::internal::site_iterator_base< S, E >::target [inherited] |
The associated target type.
Constructor & Destructor Documentation
| mln::internal::piter_adaptor_< Pi, S, E >::piter_adaptor_ | ( | ) | [inline] |
Constructor without argument.
| mln::internal::piter_adaptor_< Pi, S, E >::piter_adaptor_ | ( | const Pi & | piter | ) | [inline] |
Constructor from a point iterator piter.
References mln::internal::piter_adaptor_< Pi, S, E >::invalidate_().
Member Function Documentation
| void mln::internal::piter_adaptor_< Pi, S, E >::change_target | ( | const S & | s | ) | [inline] |
Change the site set targeted by this iterator.
References mln::exact(), mln::Site_Iterator< E >::invalidate(), and mln::internal::site_iterator_base< S, E >::s_.
Referenced by mln::morpho::tree::dn_leaf_piter< T >::dn_leaf_piter(), mln::morpho::tree::dn_node_piter< T >::dn_node_piter(), mln::morpho::tree::dn_site_piter< T >::dn_site_piter(), mln::p_if_piter_< Pi, S, F >::p_if_piter_(), mln::morpho::tree::up_leaf_piter< T >::up_leaf_piter(), and mln::morpho::tree::up_node_piter< T >::up_node_piter().
| void mln::Site_Iterator< E >::invalidate | ( | ) | [inline, inherited] |
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().
| void mln::internal::piter_adaptor_< Pi, S, E >::invalidate_ | ( | ) | [inline] |
Invalidate the iterator.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
Referenced by mln::internal::piter_adaptor_< Pi, S, E >::piter_adaptor_().
| bool mln::Site_Iterator< E >::is_valid | ( | ) | const [inline, inherited] |
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_().
| bool mln::internal::piter_adaptor_< Pi, S, E >::is_valid_ | ( | ) | const [inline] |
Test the iterator validity.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
| 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.
References mln::exact(), and mln::Site_Iterator< E >::is_valid().
| void mln::internal::piter_adaptor_< Pi, S, E >::next_ | ( | ) | [inline] |
Go to the next point.
Reimplemented in mln::hexa_fwd_piter_< S >, and mln::p_if_piter_< Pi, S, F >.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
| const S::psite & mln::internal::piter_adaptor_< Pi, S, E >::p_hook_ | ( | ) | const [inline] |
Hook to the current location.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
| void mln::internal::piter_adaptor_< Pi, S, E >::pi_change_target_ | ( | const S & | s | ) | [inline] |
Change the site set targeted by pi_.
This default impl is a no-op. This method might be overridden.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
| void mln::Site_Iterator< E >::start | ( | ) | [inline, inherited] |
References mln::exact().
| void mln::internal::piter_adaptor_< Pi, S, E >::start_ | ( | ) | [inline] |
Start an iteration.
Reimplemented in mln::p_if_piter_< Pi, S, F >.
References mln::internal::piter_adaptor_< Pi, S, E >::pi_.
| 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 >, mln::internal::site_relative_iterator_base< W, graph_window_piter< S, W, I > >, mln::internal::site_relative_iterator_base< multiple< W, F >, multiple_qiter< W, F > >, mln::internal::site_relative_iterator_base< V, dpsites_bkd_piter< V > >, mln::internal::site_relative_iterator_base< neighb< W >, neighb_fwd_niter< W > >, mln::internal::site_relative_iterator_base< W, graph_window_if_piter< S, W, I > >, mln::internal::site_relative_iterator_base< W, complex_window_fwd_piter< I, G, W > >, mln::internal::site_relative_iterator_base< W, complex_window_bkd_piter< I, G, W > >, mln::internal::site_relative_iterator_base< multiple_size< n, W, F >, multiple_size_qiter< n, W, F > >, mln::internal::site_relative_iterator_base< N, complex_neighborhood_bkd_piter< I, G, N > >, mln::internal::site_relative_iterator_base< N, complex_neighborhood_fwd_piter< I, G, N > >, mln::internal::site_relative_iterator_base< neighb< W >, neighb_bkd_niter< W > >, and mln::internal::site_relative_iterator_base< V, dpsites_fwd_piter< V > >.
References mln::exact().
| const S *& mln::internal::site_iterator_base< S, E >::target_ | ( | ) | [inline, inherited] |
Give the target address. It might be 0.
| 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).
References mln::exact().
Member Data Documentation
Pi mln::internal::piter_adaptor_< Pi, S, E >::pi_ [protected] |
The adaptee site iterator.
Referenced by mln::internal::piter_adaptor_< Pi, S, E >::invalidate_(), mln::internal::piter_adaptor_< Pi, S, E >::is_valid_(), mln::internal::piter_adaptor_< Pi, S, E >::next_(), mln::p_if_piter_< Pi, S, F >::next_(), mln::internal::piter_adaptor_< Pi, S, E >::p_hook_(), mln::internal::piter_adaptor_< Pi, S, E >::pi_change_target_(), mln::p_if_piter_< Pi, S, F >::pi_change_target_(), mln::internal::piter_adaptor_< Pi, S, E >::start_(), and mln::p_if_piter_< Pi, S, F >::start_().
const S* mln::internal::site_iterator_base< S, E >::s_ [protected, inherited] |
The target.
Referenced by 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(), mln::p_transformed_piter< Pi, S, F >::change_target(), mln::p_transformed_piter< Pi, S, F >::next_(), mln::p_if_piter_< Pi, S, F >::next_(), mln::internal::site_set_iterator_base< S, E >::site_set(), mln::internal::site_relative_iterator_base< S, E >::site_set(), mln::p_transformed_piter< Pi, S, F >::start_(), mln::p_if_piter_< Pi, S, F >::start_(), and mln::internal::site_relative_iterator_base< S, E >::update().
