$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::internal::piter_identity_< Pi, E > Class Template Reference

#include <mln/core/internal/piter_identity.hh>

Public Member Functions

void change_target (const S &s)
void invalidate ()
void invalidate_ ()
bool is_valid () const
bool is_valid_ () const
void next ()
void next_ ()
const S::psite & p_hook_ () const
void pi_change_target_ (const S &s)
void start ()
void start_ ()
const S::psite & subj_ ()
const S *& target_ ()
const S::site & to_site () const

Protected Member Functions

 piter_identity_ ()
 piter_identity_ (const Pi &piter)

Protected Attributes

Pi pi_
const S * s_

Public Types

typedef Site_Proxy< void > category
typedef E exact_t
typedef S::site site
typedef S target

Detailed Description

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

Definition at line 51 of file piter_identity.hh.

Constructor & Destructor Documentation

template<typename Pi, typename E>
mln::internal::piter_identity_< Pi, E >::piter_identity_ ( )
protected

Constructor without argument.

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

Constructor from a point iterator piter.

Member Function Documentation

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

Change the site set targeted by this iterator.

template<typename E>
void mln::Site_Iterator< E >::invalidate ( )
inherited
template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::invalidate_ ( )
inherited

Invalidate the iterator.

template<typename E>
bool mln::Site_Iterator< E >::is_valid ( ) const
inherited
template<typename Pi, typename S, typename E>
bool mln::internal::piter_adaptor_< Pi, S, E >::is_valid_ ( ) const
inherited

INTERNAL_API Test the iterator validity.

template<typename E>
void mln::Site_Iterator< E >::next ( )
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.
template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::next_ ( )
inherited

Go to the next point.

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

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

Hook to the current location.

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

Change the site set targeted by pi_.

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

template<typename E>
void mln::Site_Iterator< E >::start ( )
inherited

Reimplemented in mln::hexa_fwd_piter_< S >.

template<typename Pi, typename S, typename E>
void mln::internal::piter_adaptor_< Pi, S, E >::start_ ( )
inherited

Start an iteration.

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

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

INTERNAL_API 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< mixed_neighb< W >, neighb_bkd_niter< W >, mixed_neighb< W >::psite >, mln::internal::site_relative_iterator_base< W, graph_window_piter< S, W, I >, W::center_t >, mln::internal::site_relative_iterator_base< neighb< W >, neighb_bkd_niter< W >, neighb< W >::psite >, 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 >, neighb< W >::psite >, mln::internal::site_relative_iterator_base< W, graph_window_if_piter< S, W, I > >, mln::internal::site_relative_iterator_base< mixed_neighb< W >, neighb_fwd_niter< W >, mixed_neighb< W >::psite >, 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< N, E, N::psite >, 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 > >, and mln::internal::site_relative_iterator_base< V, dpsites_fwd_piter< V > >.

template<typename S, typename E>
const S*& mln::internal::site_iterator_base< S, E >::target_ ( )
inherited

Give the target address. It might be 0.

template<typename S, typename E>
const S ::site& mln::internal::site_iterator_base< S, E >::to_site ( ) const
inherited

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

Member Data Documentation

template<typename Pi, typename S, typename E>
Pi mln::internal::piter_adaptor_< Pi, S, E >::pi_
protectedinherited

The adaptee site iterator.

Definition at line 92 of file piter_adaptor.hh.

template<typename S, typename E>
const S* mln::internal::site_iterator_base< S, E >::s_
protectedinherited

The target.

Definition at line 91 of file site_iterator_base.hh.

Member Typedef Documentation

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

Definition at line 68 of file site_proxy.hh.

template<typename E>
typedef E mln::Object< E >::exact_t
inherited

Definition at line 105 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 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.