mln::p_indexed_bkd_piter< S > Class Template Reference

Backward iterator on sites of an indexed site set. More...

#include <p_array.hh>

Inheritance diagram for mln::p_indexed_bkd_piter< S >:

List of all members.

Public Types
typedef Site_Proxy< void >	category
typedef p_indexed_bkd_piter< S >	exact_t
typedef S	pset
	The associated site set type.
typedef S::site	site
	The associated site type (as a Site_Proxy).
typedef S	target
	The associated target type.
Public Member Functions
void	change_target (const S &s)
	Change the site set targeted by this iterator.
int	index () const
	Return the current index.
void	invalidate ()
void	invalidate_ ()
	Invalidate the iterator.
bool	is_valid () const
bool	is_valid_ () const
	Test if the iterator is valid.
void	next ()
	Go to the next element.
void	next_ ()
	Go to the next point.
const S::psite &	p_hook_ () const
	Hook to the current location.
	p_indexed_bkd_piter (const S &s)
	Constructor.
	p_indexed_bkd_piter ()
	Constructor with no argument.
const S &	site_set () const
	Give the site set that this iterator browses.
void	start ()
void	start_ ()
	Start an iteration.
const S::psite &	subj_ ()
	Give the subject (required by the Proxy interface).
const S *&	target_ ()
	Give the target address. It might be 0.
const S::site &	to_site () const
	Return the site it points to (as a Site_Proxy).
Protected Attributes
S::psite	p_
	The psite designated by this iterator.
const S *	s_
	The target.
Private Types
typedef p_indexed_bkd_piter< S >	self
typedef internal::site_set_iterator_base < S, self >	super

---

Detailed Description

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

Backward iterator on sites of an indexed site set.

---

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< p_indexed_bkd_piter< S > >::category [inherited]

Reimplemented from mln::Proxy< p_indexed_bkd_piter< S > >.

typedef p_indexed_bkd_piter< S > mln::Object< p_indexed_bkd_piter< S > >::exact_t [inherited]

typedef S mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::pset [inherited]

The associated site set type.

template<typename S>

typedef p_indexed_bkd_piter<S> mln::p_indexed_bkd_piter< S >::self [private]

typedef S ::site mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::site [inherited]

The associated site type (as a Site_Proxy).

template<typename S>

typedef internal::site_set_iterator_base<S, self> mln::p_indexed_bkd_piter< S >::super [private]

typedef S mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::target [inherited]

The associated target type.

---

Constructor & Destructor Documentation

template<typename S >

mln::p_indexed_bkd_piter< S >::p_indexed_bkd_piter

(

)

[inline]

Constructor with no argument.

template<typename S >

mln::p_indexed_bkd_piter< S >::p_indexed_bkd_piter

(

const S &

s

)

[inline]

Constructor.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::change_target().

---

Member Function Documentation

void mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::change_target

(

const S &

s

)

[inherited]

Change the site set targeted by this iterator.

Referenced by mln::p_indexed_bkd_piter< S >::p_indexed_bkd_piter().

template<typename S >

int mln::p_indexed_bkd_piter< S >::index

(

)

const [inline]

Return the current index.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_.

void mln::Site_Iterator< p_indexed_bkd_piter< S > >::invalidate

(

)

[inherited]

template<typename S >

void mln::p_indexed_bkd_piter< S >::invalidate_

(

)

[inline]

Invalidate the iterator.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_.

bool mln::Site_Iterator< p_indexed_bkd_piter< S > >::is_valid

(

)

const [inherited]

template<typename S >

bool mln::p_indexed_bkd_piter< S >::is_valid_

(

)

const [inline]

Test if the iterator is valid.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_, and mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::s_.

void mln::Site_Iterator< p_indexed_bkd_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::p_indexed_bkd_piter< S >::next_

(

)

[inline]

Go to the next point.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_.

const S ::psite& mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_hook_

(

)

const [inherited]

Hook to the current location.

const S& mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::site_set

(

)

const [inherited]

Give the site set that this iterator browses.

void mln::Site_Iterator< p_indexed_bkd_piter< S > >::start

(

)

[inherited]

template<typename S >

void mln::p_indexed_bkd_piter< S >::start_

(

)

[inline]

Start an iteration.

References mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_, and mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::s_.

const S ::psite& mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::subj_

(

)

[inherited]

Give the subject (required by the Proxy interface).

const S*& mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::target_

(

)

[inherited]

Give the target address. It might be 0.

const S ::site& mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::to_site

(

)

const [inherited]

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

---

Member Data Documentation

S ::psite mln::internal::site_set_iterator_base< S, p_indexed_bkd_piter< S > >::p_ [protected, inherited]

The psite designated by this iterator.

Referenced by mln::p_indexed_bkd_piter< S >::index(), mln::p_indexed_bkd_piter< S >::invalidate_(), mln::p_indexed_bkd_piter< S >::is_valid_(), mln::p_indexed_bkd_piter< S >::next_(), and mln::p_indexed_bkd_piter< S >::start_().

const S* mln::internal::site_iterator_base< S, p_indexed_bkd_piter< S > >::s_ [protected, inherited]

The target.

Referenced by mln::p_indexed_bkd_piter< S >::is_valid_(), and mln::p_indexed_bkd_piter< S >::start_().