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

#include <mln/core/neighb.hh>

Public Member Functions

 neighb_fwd_niter ()
template<typename P >
 neighb_fwd_niter (const neighb< W > &nbh, const P &c)
const neighb< W >::psitecenter () const
void center_at (const P &c)
void change_target (const neighb< W > &s)
W::psite compute_p_ () const
void do_next_ ()
void do_start_ ()
void invalidate ()
void invalidate_ ()
bool is_valid () const
bool is_valid_ () const
void next ()
void next_ ()
const neighb< W >::psitep_hook_ () const
const neighb< W > & site_set () const
void start ()
void start_ ()
const neighb< W >::psitesubj_ ()
const neighb< W > *& target_ ()
const neighb< W >::siteto_site () const
neighb_fwd_niter< W > & update ()

Protected Attributes

const neighb< W >::psitec_
W::fwd_qiter i_
const neighb< W > * s_

Public Types

typedef Site_Proxy< void > category
typedef neighb_fwd_niter< W > exact_t
typedef neighb< W >::site site
typedef neighb< W > target

Detailed Description

template<typename W>
class mln::neighb_fwd_niter< W >

Definition at line 100 of file neighb.hh.

Constructor & Destructor Documentation

template<typename W >
mln::neighb_fwd_niter< W >::neighb_fwd_niter ( )
template<typename W >
template<typename P >
mln::neighb_fwd_niter< W >::neighb_fwd_niter ( const neighb< W > &  nbh,
const P &  c 
)

Member Function Documentation

const neighb< W >::psite & mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::center ( ) const
inherited

The psite around which this iterator moves.

void mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::center_at ( const P &  c)
inherited
void mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::change_target ( const neighb< W > &  s)
inherited

Change the site set targeted by this iterator.

W ::psite mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::compute_p_ ( ) const
inherited

Compute the current psite.

void mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::do_next_ ( )
inherited

Go to the next point.

void mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::do_start_ ( )
inherited

Start an iteration.

void mln::Site_Iterator< neighb_fwd_niter< W > >::invalidate ( )
inherited
void mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::invalidate_ ( )
inherited

Invalidate the iterator.

bool mln::Site_Iterator< neighb_fwd_niter< W > >::is_valid ( ) const
inherited
bool mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::is_valid_ ( ) const
inherited

INTERNAL_API Test the iterator validity.

void mln::Site_Iterator< neighb_fwd_niter< W > >::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.
void mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::next_ ( )
inherited

Go to the next point.

const neighb< W > ::psite& mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::p_hook_ ( ) const
inherited

Hook to the current location.

const neighb< W > & mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::site_set ( ) const
inherited

Give the site set (neighborhood or window) that this iterator browses.

void mln::Site_Iterator< neighb_fwd_niter< W > >::start ( )
inherited
void mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::start_ ( )
inherited

INTERNAL_API Start an iteration.

const neighb< W > ::psite& mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::subj_ ( )
inherited

INTERNAL_API This overriding is very useful: it adds a test to prevent getting an invalid iterator when its center has moved.

Some sub-classes provide an update() method for the client to say that she really want to read the iterator just after the center has changed.

Reimplemented from mln::internal::site_iterator_base< neighb< W >, neighb_fwd_niter< W > >.

const neighb< W > *& mln::internal::site_iterator_base< neighb< W > , neighb_fwd_niter< W > >::target_ ( )
inherited

Give the target address. It might be 0.

const neighb< W > ::site& mln::internal::site_iterator_base< neighb< W > , neighb_fwd_niter< W > >::to_site ( ) const
inherited

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

Warning: this method is an advanced tool provided for very special occasions; if you are a regular user, you should never use it! Calling this method forces this relative iterator to synchronize with its center when it has just moved and when the relative iterator still makes sense.

Member Data Documentation

const neighb< W >::psite * mln::internal::site_relative_iterator_base< neighb< W > , neighb_fwd_niter< W > , neighb< W >::psite >::c_
protectedinherited

A pointer to the center psite around which this iterator moves.

Definition at line 113 of file site_relative_iterator_base.hh.

W::fwd_qiter mln::internal::neighb_niter_base< W, neighb< W > , W::fwd_qiter , neighb_fwd_niter< W > >::i_
protectedinherited

Definition at line 79 of file neighb_niter_base.hh.

const neighb< W > * mln::internal::site_iterator_base< neighb< W > , neighb_fwd_niter< W > >::s_
protectedinherited

The target.

Definition at line 91 of file site_iterator_base.hh.

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< neighb_fwd_niter< W > >::category
inherited

Definition at line 68 of file site_proxy.hh.

typedef neighb_fwd_niter< W > mln::Object< neighb_fwd_niter< W > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef neighb< W > ::site mln::internal::site_iterator_base< neighb< W > , neighb_fwd_niter< W > >::site
inherited

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

typedef neighb< W > mln::internal::site_iterator_base< neighb< W > , neighb_fwd_niter< W > >::target
inherited

The associated target type.

Definition at line 61 of file site_iterator_base.hh.