Public Types | Public Member Functions | Protected Attributes | Private Types

mln::neighb_bkd_niter< W > Class Template Reference

#include <neighb.hh>

Inheritance diagram for mln::neighb_bkd_niter< W >:
Inheritance graph

List of all members.

Public Types

typedef Site_Proxy< void > category
typedef neighb_bkd_niter< W > exact_t
typedef neighb< W >::site site
 The associated site type (as a Site_Proxy).
typedef neighb< W > target
 The associated target type.

Public Member Functions

const neighb< W >::psite & center () const
 The psite around which this iterator moves.
void center_at (const P &c)
void change_target (const neighb< W > &s)
 Change the site set targeted by this iterator.
W::psite compute_p_ () const
 Compute the current psite.
void do_next_ ()
 Go to the next point.
void do_start_ ()
 Start an iteration.
void invalidate ()
void invalidate_ ()
 Invalidate the iterator.
bool is_valid () const
bool is_valid_ () const
 Test the iterator validity.
template<typename P >
 neighb_bkd_niter (const neighb< W > &nbh, const P &c)
 neighb_bkd_niter ()
void next ()
 Go to the next element.
void next_ ()
 Go to the next point.
const neighb< W >::psite & p_hook_ () const
 Hook to the current location.
const neighb< W > & site_set () const
 Give the site set (neighborhood or window) that this iterator browses.
void start ()
void start_ ()
 Start an iteration.
const neighb< W >::psite & subj_ ()
 This overriding is very useful: it adds a test to prevent getting an invalid iterator when its center has moved.
const neighb< W > *& target_ ()
 Give the target address. It might be 0.
const neighb< W >::siteto_site () const
 Return the site it points to (as a Site_Proxy).
neighb_bkd_niter< W > & update ()
 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.

Protected Attributes

const neighb< W >::psite * c_
 A pointer to the center psite around which this iterator moves.
W::bkd_qiter i_
const neighb< W > * s_
 The target.

Private Types

typedef
internal::neighb_niter_base< W,
neighb< W >, typename
W::bkd_qiter, neighb_bkd_niter
< W > > 
super_

Detailed Description

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

Definition at line 126 of file mln/core/neighb.hh.


Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< neighb_bkd_niter< W > >::category [inherited]

Reimplemented from mln::Proxy< neighb_bkd_niter< W > >.

Definition at line 63 of file site_proxy.hh.

typedef neighb_bkd_niter< W > mln::Object< neighb_bkd_niter< W > >::exact_t [inherited]

Definition at line 173 of file object.hh.

typedef neighb< W > ::site mln::internal::site_iterator_base< neighb< W > , neighb_bkd_niter< W > >::site [inherited]

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename W >
typedef internal::neighb_niter_base<W,neighb<W>, typename W ::bkd_qiter,neighb_bkd_niter<W> > mln::neighb_bkd_niter< W >::super_ [private]

Definition at line 132 of file mln/core/neighb.hh.

typedef neighb< W > mln::internal::site_iterator_base< neighb< W > , neighb_bkd_niter< W > >::target [inherited]

The associated target type.

Definition at line 61 of file site_iterator_base.hh.


Constructor & Destructor Documentation

template<typename W >
mln::neighb_bkd_niter< W >::neighb_bkd_niter (  )  [inline]

Definition at line 214 of file mln/core/neighb.hh.

template<typename W >
template<typename P >
mln::neighb_bkd_niter< W >::neighb_bkd_niter ( const neighb< W > &  nbh,
const P &  c 
) [inline]

Member Function Documentation

const neighb< W >::psite & mln::internal::site_relative_iterator_base< neighb< W > , neighb_bkd_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_bkd_niter< W > , neighb< W >::psite >::center_at ( const P &  c  )  [inherited]
void mln::internal::site_relative_iterator_base< neighb< W > , neighb_bkd_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::bkd_qiter , neighb_bkd_niter< W > >::compute_p_ (  )  const [inherited]

Compute the current psite.

void mln::internal::neighb_niter_base< W, neighb< W > , W::bkd_qiter , neighb_bkd_niter< W > >::do_next_ (  )  [inherited]

Go to the next point.

void mln::internal::neighb_niter_base< W, neighb< W > , W::bkd_qiter , neighb_bkd_niter< W > >::do_start_ (  )  [inherited]

Start an iteration.

void mln::Site_Iterator< neighb_bkd_niter< W > >::invalidate (  )  [inherited]
void mln::internal::neighb_niter_base< W, neighb< W > , W::bkd_qiter , neighb_bkd_niter< W > >::invalidate_ (  )  [inherited]

Invalidate the iterator.

bool mln::Site_Iterator< neighb_bkd_niter< W > >::is_valid (  )  const [inherited]
bool mln::internal::neighb_niter_base< W, neighb< W > , W::bkd_qiter , neighb_bkd_niter< W > >::is_valid_ (  )  const [inherited]

Test the iterator validity.

void mln::Site_Iterator< neighb_bkd_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_bkd_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_bkd_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_bkd_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_bkd_niter< W > >::start (  )  [inherited]
void mln::internal::site_relative_iterator_base< neighb< W > , neighb_bkd_niter< W > , neighb< W >::psite >::start_ (  )  [inherited]

Start an iteration.

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

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_bkd_niter< W > >.

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

Give the target address. It might be 0.

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

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

neighb_bkd_niter< W > & mln::internal::site_relative_iterator_base< neighb< W > , neighb_bkd_niter< W > , neighb< W >::psite >::update (  )  [inherited]

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_bkd_niter< W > , neighb< W >::psite >::c_ [protected, inherited]

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

Definition at line 108 of file site_relative_iterator_base.hh.

W::bkd_qiter mln::internal::neighb_niter_base< W, neighb< W > , W::bkd_qiter , neighb_bkd_niter< W > >::i_ [protected, inherited]

Definition at line 76 of file neighb_niter_base.hh.

Referenced by mln::neighb_bkd_niter< W >::neighb_bkd_niter().

const neighb< W > * mln::internal::site_iterator_base< neighb< W > , neighb_bkd_niter< W > >::s_ [protected, inherited]

The target.

Definition at line 90 of file site_iterator_base.hh.