mln::p_n_faces_fwd_piter< D, P > Class Template Reference

Forward iterator on the n-faces sites of an mln::p_complex<D, P>. More...

#include <p_n_faces_piter.hh>

Inheritance diagram for mln::p_n_faces_fwd_piter< D, P >:

List of all members.

Public Types
typedef Site_Proxy< void >	category
typedef p_n_faces_fwd_piter< D, P >	exact_t
typedef p_complex< D, P >	pset
	The associated site set type.
typedef p_complex< D, P >::site	site
	The associated site type (as a Site_Proxy).
typedef p_complex< D, P >	target
	The associated target type.
Public Member Functions
void	change_target (const p_complex< D, P > &s)
	Change the site set targeted by this iterator.
void	invalidate ()
bool	is_valid () const
void	next ()
	Go to the next element.
const p_complex< D, P >::psite &	p_hook_ () const
	Hook to the current location.
const p_complex< D, P > &	site_set () const
	Give the site set that this iterator browses.
void	start ()
const p_complex< D, P >::psite &	subj_ ()
	Give the subject (required by the Proxy interface).
const p_complex< D, P > *&	target_ ()
	Give the target address. It might be 0.
const p_complex< D, P >::site &	to_site () const
	Return the site it points to (as a Site_Proxy).
	p_n_faces_fwd_piter ()
	Construction and assignment.
	p_n_faces_fwd_piter (const p_complex< D, P > &pc, unsigned n)
unsigned	n () const
	Accessors.
void	set_n (unsigned n)
bool	is_valid_ () const
	Manipulation.
void	invalidate_ ()
	Invalidate the iterator.
void	start_ ()
	Start an iteration.
void	next_ ()
	Go to the next point.
Protected Attributes
iter	iter_
	The underlying complex iterator.
p_complex< D, P >::psite	p_
	The psite designated by this iterator.
const p_complex< D, P > *	s_
	The target.
Private Types
typedef p_n_faces_fwd_piter< D, P >	self_
typedef internal::p_complex_piter_base_ < topo::n_face_fwd_iter< D > , p_complex< D, P >, P, self_ >	super_

---

Detailed Description

template<unsigned D, typename P>
class mln::p_n_faces_fwd_piter< D, P >

Forward iterator on the n-faces sites of an mln::p_complex<D, P>.

---

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< p_n_faces_fwd_piter< D, P > >::category [inherited]

Reimplemented from mln::Proxy< p_n_faces_fwd_piter< D, P > >.

typedef p_n_faces_fwd_piter< D, P > mln::Object< p_n_faces_fwd_piter< D, P > >::exact_t [inherited]

typedef p_complex< D, P > mln::internal::site_set_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::pset [inherited]

The associated site set type.

template<unsigned D, typename P>

typedef p_n_faces_fwd_piter<D, P> mln::p_n_faces_fwd_piter< D, P >::self_ [private]

Reimplemented from mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D >, p_complex< D, P >, P, p_n_faces_fwd_piter< D, P > >.

typedef p_complex< D, P > ::site mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::site [inherited]

The associated site type (as a Site_Proxy).

template<unsigned D, typename P>

typedef internal::p_complex_piter_base_< topo::n_face_fwd_iter<D>, p_complex<D, P>, P, self_ > mln::p_n_faces_fwd_piter< D, P >::super_ [private]

Reimplemented from mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D >, p_complex< D, P >, P, p_n_faces_fwd_piter< D, P > >.

typedef p_complex< D, P > mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::target [inherited]

The associated target type.

---

Constructor & Destructor Documentation

template<unsigned D, typename P >

mln::p_n_faces_fwd_piter< D, P >::p_n_faces_fwd_piter

(

)

[inline]

Construction and assignment.

template<unsigned D, typename P >

mln::p_n_faces_fwd_piter< D, P >::p_n_faces_fwd_piter	(	const p_complex< D, P > &	pc,
		unsigned	n
	)			[inline]

References mln::p_n_faces_fwd_piter< D, P >::set_n().

---

Member Function Documentation

void mln::internal::site_set_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::change_target

(

const p_complex< D, P > &

s

)

[inherited]

Change the site set targeted by this iterator.

void mln::Site_Iterator< p_n_faces_fwd_piter< D, P > >::invalidate

(

)

[inherited]

void mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D > , p_complex< D, P > , P, p_n_faces_fwd_piter< D, P > >::invalidate_

(

)

[inherited]

Invalidate the iterator.

bool mln::Site_Iterator< p_n_faces_fwd_piter< D, P > >::is_valid

(

)

const [inherited]

bool mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D > , p_complex< D, P > , P, p_n_faces_fwd_piter< D, P > >::is_valid_

(

)

const [inherited]

Manipulation.

Test if the iterator is valid.

template<unsigned D, typename P >

unsigned mln::p_n_faces_fwd_piter< D, P >::n

(

)

const [inline]

Accessors.

Shortcuts to face_'s accessors.

References mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D >, p_complex< D, P >, P, p_n_faces_fwd_piter< D, P > >::iter_, and mln::topo::n_face_fwd_iter< D >::n().

void mln::Site_Iterator< p_n_faces_fwd_piter< D, 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.

void mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D > , p_complex< D, P > , P, p_n_faces_fwd_piter< D, P > >::next_

(

)

[inherited]

Go to the next point.

const p_complex< D, P > ::psite& mln::internal::site_set_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::p_hook_

(

)

const [inherited]

Hook to the current location.

template<unsigned D, typename P >

void mln::p_n_faces_fwd_piter< D, P >::set_n

(

unsigned

n

)

[inline]

References mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D >, p_complex< D, P >, P, p_n_faces_fwd_piter< D, P > >::iter_, and mln::topo::n_face_fwd_iter< D >::set_n().

Referenced by mln::p_n_faces_fwd_piter< D, P >::p_n_faces_fwd_piter().

const p_complex< D, P > & mln::internal::site_set_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::site_set

(

)

const [inherited]

Give the site set that this iterator browses.

void mln::Site_Iterator< p_n_faces_fwd_piter< D, P > >::start

(

)

[inherited]

void mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D > , p_complex< D, P > , P, p_n_faces_fwd_piter< D, P > >::start_

(

)

[inherited]

Start an iteration.

const p_complex< D, P > ::psite& mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::subj_

(

)

[inherited]

Give the subject (required by the Proxy interface).

const p_complex< D, P > *& mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::target_

(

)

[inherited]

Give the target address. It might be 0.

const p_complex< D, P > ::site& mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::to_site

(

)

const [inherited]

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

---

Member Data Documentation

iter mln::internal::p_complex_piter_base_< topo::n_face_fwd_iter< D > , p_complex< D, P > , P, p_n_faces_fwd_piter< D, P > >::iter_ [protected, inherited]

The underlying complex iterator.

Referenced by mln::p_n_faces_fwd_piter< D, P >::n(), and mln::p_n_faces_fwd_piter< D, P >::set_n().

p_complex< D, P > ::psite mln::internal::site_set_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::p_ [protected, inherited]

The psite designated by this iterator.

const p_complex< D, P > * mln::internal::site_iterator_base< p_complex< D, P > , p_n_faces_fwd_piter< D, P > >::s_ [protected, inherited]

The target.