mln::box_fwd_piter_< P > Class Template Reference

A generic forward iterator on points of boxes. More...

#include <box_piter.hh>

Inheritance diagram for mln::box_fwd_piter_< P >:

List of all members.

Public Types
enum	{ dim = P::dim }
typedef Site_Proxy< void >	category
typedef box_fwd_piter_< P >	exact_t
typedef box< P >	pset
	The associated site set type.
typedef box< P >::site	site
	The associated site type (as a Site_Proxy).
typedef box< P >	target
	The associated target type.
Public Member Functions
	box_fwd_piter_ ()
	Constructor without argument.
	box_fwd_piter_ (const mln::box< P > &b)
	Constructor.
void	change_target (const box< P > &s)
	Change the site set targeted by this iterator.
void	change_target_ (const box< P > &s)
	Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).
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 box< P >::psite &	p_hook_ () const
	Hook to the current location.
const box< P > &	site_set () const
	Give the site set that this iterator browses.
void	start ()
void	start_ ()
	Start an iteration.
const box< P >::psite &	subj_ ()
	Give the subject (required by the Proxy interface).
const box< P > *&	target_ ()
	Give the target address. It might be 0.
const box< P >::site &	to_site () const
	Return the site it points to (as a Site_Proxy).
Protected Attributes
box< P >::psite	p_
	The psite designated by this iterator.
const box< P > *	s_
	The target.
Private Types
typedef box_fwd_piter_< P >	self_
typedef internal::site_set_iterator_base < box< P >, self_ >	super_

---

Detailed Description

template<typename P>
class mln::box_fwd_piter_< P >

A generic forward iterator on points of boxes.

The parameter P is the type of points.

See also:

mln::box

Definition at line 48 of file box_piter.hh.

---

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< box_fwd_piter_< P > >::category [inherited]

Reimplemented from mln::Proxy< box_fwd_piter_< P > >.

Definition at line 63 of file site_proxy.hh.

typedef box_fwd_piter_< P > mln::Object< box_fwd_piter_< P > >::exact_t [inherited]

Definition at line 173 of file object.hh.

typedef box< P > mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::pset [inherited]

The associated site set type.

Definition at line 57 of file site_set_iterator_base.hh.

template<typename P >

typedef box_fwd_piter_<P> mln::box_fwd_piter_< P >::self_ [private]

Definition at line 51 of file box_piter.hh.

typedef box< P > ::site mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::site [inherited]

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename P >

typedef internal::site_set_iterator_base< box<P>, self_ > mln::box_fwd_piter_< P >::super_ [private]

Reimplemented from mln::internal::site_iterator_base< box< P >, box_fwd_piter_< P > >.

Definition at line 52 of file box_piter.hh.

typedef box< P > mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::target [inherited]

The associated target type.

Definition at line 61 of file site_iterator_base.hh.

---

Member Enumeration Documentation

template<typename P >

anonymous enum

Enumerator:

dim

Definition at line 57 of file box_piter.hh.

---

Constructor & Destructor Documentation

template<typename P >

mln::box_fwd_piter_< P >::box_fwd_piter_

(

)

[inline]

Constructor without argument.

Definition at line 141 of file box_piter.hh.

template<typename P >

mln::box_fwd_piter_< P >::box_fwd_piter_

(

const mln::box< P > &

b

)

[inline]

Constructor.

Parameters:

[in]

b

A box.

Definition at line 147 of file box_piter.hh.

References mln::internal::site_set_iterator_base< box< P >, box_fwd_piter_< P > >::change_target().

---

Member Function Documentation

void mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::change_target

(

const box< P > &

s

)

[inherited]

Change the site set targeted by this iterator.

Referenced by mln::box_fwd_piter_< P >::box_fwd_piter_().

void mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::change_target_

(

const box< P > &

s

)

[inherited]

Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).

void mln::Site_Iterator< box_fwd_piter_< P > >::invalidate

(

)

[inherited]

template<typename P >

void mln::box_fwd_piter_< P >::invalidate_

(

)

[inline]

Invalidate the iterator.

Definition at line 163 of file box_piter.hh.

References mln::internal::site_set_iterator_base< box< P >, box_fwd_piter_< P > >::p_, and mln::internal::site_iterator_base< box< P >, box_fwd_piter_< P > >::s_.

Referenced by mln::box_fwd_piter_< P >::next_().

bool mln::Site_Iterator< box_fwd_piter_< P > >::is_valid

(

)

const [inherited]

template<typename P >

bool mln::box_fwd_piter_< P >::is_valid_

(

)

const [inline]

Test the iterator validity.

Definition at line 155 of file box_piter.hh.

References mln::internal::site_set_iterator_base< box< P >, box_fwd_piter_< P > >::p_, and mln::internal::site_iterator_base< box< P >, box_fwd_piter_< P > >::s_.

void mln::Site_Iterator< box_fwd_piter_< P > >::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 P >

void mln::box_fwd_piter_< P >::next_

(

)

[inline]

Go to the next point.

Definition at line 179 of file box_piter.hh.

References mln::box_fwd_piter_< P >::dim, mln::box_fwd_piter_< P >::invalidate_(), mln::internal::site_set_iterator_base< box< P >, box_fwd_piter_< P > >::p_, and mln::internal::site_iterator_base< box< P >, box_fwd_piter_< P > >::s_.

const box< P > ::psite& mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::p_hook_

(

)

const [inherited]

Hook to the current location.

const box< P > & mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::site_set

(

)

const [inherited]

Give the site set that this iterator browses.

void mln::Site_Iterator< box_fwd_piter_< P > >::start

(

)

[inherited]

template<typename P >

void mln::box_fwd_piter_< P >::start_

(

)

[inline]

Start an iteration.

Definition at line 171 of file box_piter.hh.

References mln::internal::site_set_iterator_base< box< P >, box_fwd_piter_< P > >::p_, and mln::internal::site_iterator_base< box< P >, box_fwd_piter_< P > >::s_.

const box< P > ::psite& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::subj_

(

)

[inherited]

Give the subject (required by the Proxy interface).

const box< P > *& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::target_

(

)

[inherited]

Give the target address. It might be 0.

const box< P > ::site& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::to_site

(

)

const [inherited]

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

---

Member Data Documentation

box< P > ::psite mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::p_ [protected, inherited]

The psite designated by this iterator.

Definition at line 75 of file site_set_iterator_base.hh.

Referenced by mln::box_fwd_piter_< P >::invalidate_(), mln::box_fwd_piter_< P >::is_valid_(), mln::box_fwd_piter_< P >::next_(), and mln::box_fwd_piter_< P >::start_().

const box< P > * mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::s_ [protected, inherited]

The target.

Definition at line 90 of file site_iterator_base.hh.

Referenced by mln::box_fwd_piter_< P >::invalidate_(), mln::box_fwd_piter_< P >::is_valid_(), mln::box_fwd_piter_< P >::next_(), and mln::box_fwd_piter_< P >::start_().