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

#include <mln/core/image/dmorph/hexa_piter.hh>

Public Member Functions

 hexa_fwd_piter_ (const box2d_h &subset)
void change_target (const S &s)
void invalidate ()
void invalidate_ ()
bool is_valid () const
bool is_valid_ () const
void next ()
void next_ ()
 operator point2d_h () const
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 Attributes

S::fwd_piter pi_
const S * s_

Public Types

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

Detailed Description

template<typename S>
class mln::hexa_fwd_piter_< S >

A generic forward iterator on points of subsets.

Parameter S is a point set type; parameter F is a function from point to Boolean.

See Also
mln::hexa

Definition at line 52 of file hexa_piter.hh.

Constructor & Destructor Documentation

template<typename S >
mln::hexa_fwd_piter_< S >::hexa_fwd_piter_ ( const box2d_h subset)

Constructor from a subset of points.

Member Function Documentation

void mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::change_target ( const S &  s)
inherited

Change the site set targeted by this iterator.

void mln::Site_Iterator< hexa_fwd_piter_< S > >::invalidate ( )
inherited
void mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::invalidate_ ( )
inherited

Invalidate the iterator.

bool mln::Site_Iterator< hexa_fwd_piter_< S > >::is_valid ( ) const
inherited
bool mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::is_valid_ ( ) const
inherited

INTERNAL_API Test the iterator validity.

void mln::Site_Iterator< hexa_fwd_piter_< S > >::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 S >
void mln::hexa_fwd_piter_< S >::next_ ( )

INTERNAL_API Go to the next point.

Reimplemented from mln::internal::piter_adaptor_< S::fwd_piter, S, hexa_fwd_piter_< S > >.

template<typename S >
mln::hexa_fwd_piter_< S >::operator point2d_h ( ) const
const S ::psite& mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::p_hook_ ( ) const
inherited

Hook to the current location.

void mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::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 S >
void mln::hexa_fwd_piter_< S >::start ( )

Start an iteration.

Reimplemented from mln::Site_Iterator< hexa_fwd_piter_< S > >.

void mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::start_ ( )
inherited

Start an iteration.

const S ::psite& mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::subj_ ( )
inherited

INTERNAL_API Give the subject (required by the Proxy interface).

const S*& mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::target_ ( )
inherited

Give the target address. It might be 0.

const S ::site& mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::to_site ( ) const
inherited

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

Member Data Documentation

S::fwd_piter mln::internal::piter_adaptor_< S::fwd_piter , S, hexa_fwd_piter_< S > >::pi_
protectedinherited

The adaptee site iterator.

Definition at line 92 of file piter_adaptor.hh.

const S* mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::s_
protectedinherited

The target.

Definition at line 91 of file site_iterator_base.hh.

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< hexa_fwd_piter_< S > >::category
inherited

Definition at line 68 of file site_proxy.hh.

typedef hexa_fwd_piter_< S > mln::Object< hexa_fwd_piter_< S > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef S ::site mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::site
inherited

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

typedef S mln::internal::site_iterator_base< S, hexa_fwd_piter_< S > >::target
inherited

The associated target type.

Definition at line 61 of file site_iterator_base.hh.