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

mln::p_indexed_fwd_piter< S > Class Template Reference

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

#include <p_array.hh>

Inheritance diagram for mln::p_indexed_fwd_piter< S >:
Inheritance graph

List of all members.

Public Types

typedef Site_Proxy< void > category
typedef p_indexed_fwd_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.
void change_target_ (const S &s)
 Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).
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_fwd_piter (const S &s)
 Constructor.
 p_indexed_fwd_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_fwd_piter< S > self
typedef
internal::site_set_iterator_base
< S, self
super

Detailed Description

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

Forward iterator on sites of an indexed site set.

Definition at line 235 of file p_array.hh.


Member Typedef Documentation

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

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

Definition at line 63 of file site_proxy.hh.

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

Definition at line 173 of file object.hh.

The associated site set type.

Definition at line 57 of file site_set_iterator_base.hh.

template<typename S>
typedef p_indexed_fwd_piter<S> mln::p_indexed_fwd_piter< S >::self [private]

Definition at line 240 of file p_array.hh.

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

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

template<typename S>
typedef internal::site_set_iterator_base<S, self> mln::p_indexed_fwd_piter< S >::super [private]

Definition at line 241 of file p_array.hh.

The associated target type.

Definition at line 61 of file site_iterator_base.hh.


Constructor & Destructor Documentation

template<typename S >
mln::p_indexed_fwd_piter< S >::p_indexed_fwd_piter (  )  [inline]

Constructor with no argument.

Definition at line 629 of file p_array.hh.

template<typename S >
mln::p_indexed_fwd_piter< S >::p_indexed_fwd_piter ( const S &  s  )  [inline]

Member Function Documentation

void mln::internal::site_set_iterator_base< S, p_indexed_fwd_piter< S > >::change_target ( const S &  s  )  [inherited]

Change the site set targeted by this iterator.

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

void mln::internal::site_set_iterator_base< S, p_indexed_fwd_piter< S > >::change_target_ ( const S &  s  )  [inherited]

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

template<typename S >
int mln::p_indexed_fwd_piter< S >::index (  )  const [inline]

Return the current index.

Definition at line 676 of file p_array.hh.

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

void mln::Site_Iterator< p_indexed_fwd_piter< S > >::invalidate (  )  [inherited]
template<typename S >
void mln::p_indexed_fwd_piter< S >::invalidate_ (  )  [inline]
bool mln::Site_Iterator< p_indexed_fwd_piter< S > >::is_valid (  )  const [inherited]
template<typename S >
bool mln::p_indexed_fwd_piter< S >::is_valid_ (  )  const [inline]
void mln::Site_Iterator< p_indexed_fwd_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_fwd_piter< S >::next_ (  )  [inline]

Go to the next point.

Definition at line 668 of file p_array.hh.

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

const S ::psite& mln::internal::site_set_iterator_base< S, p_indexed_fwd_piter< S > >::p_hook_ (  )  const [inherited]

Hook to the current location.

const S& mln::internal::site_set_iterator_base< S, p_indexed_fwd_piter< S > >::site_set (  )  const [inherited]

Give the site set that this iterator browses.

void mln::Site_Iterator< p_indexed_fwd_piter< S > >::start (  )  [inherited]
template<typename S >
void mln::p_indexed_fwd_piter< S >::start_ (  )  [inline]

Start an iteration.

Definition at line 660 of file p_array.hh.

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

const S ::psite& mln::internal::site_iterator_base< S, p_indexed_fwd_piter< S > >::subj_ (  )  [inherited]

Give the subject (required by the Proxy interface).

const S*& mln::internal::site_iterator_base< S, p_indexed_fwd_piter< S > >::target_ (  )  [inherited]

Give the target address. It might be 0.

const S ::site& mln::internal::site_iterator_base< S, p_indexed_fwd_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_fwd_piter< S > >::p_ [protected, inherited]
const S* mln::internal::site_iterator_base< S, p_indexed_fwd_piter< S > >::s_ [protected, inherited]