Public Member Functions

mln::p_faces< N, D, P > Struct Template Reference
[Graph based]

A complex psite set based on a the N-faces of a complex of dimension D (a D-complex). More...

#include <p_faces.hh>

Inherits site_set_base_< faces_psite< N, D, P >, p_faces< N, D, P > >.

List of all members.

Public Types

typedef super_::site element
 Associated types.
typedef faces_psite< N, D, P > psite
 Point_Site associated type.
typedef p_faces_fwd_piter_< N,
D, P > 
fwd_piter
 Forward Site_Iterator associated type.
typedef p_faces_bkd_piter_< N,
D, P > 
bkd_piter
 Backward Site_Iterator associated type.
typedef fwd_piter piter
 Site_Iterator associated type.

Public Member Functions

bool is_valid () const
 Is this site set valid?
unsigned nfaces () const
 Return The number of faces in the complex.
unsigned nsites () const
 Return The number of sites of the set, i.e., the number of faces.
 p_faces (const topo::complex< D > &cplx)
 Construct a faces psite set from an mln::complex.
 p_faces (const p_complex< D, P > &pc)
 Construct a faces psite set from an mln::p_complex.

topo::complex< D > & cplx () const
 Accessors.
topo::complex< D > & cplx ()
 Return the complex associated to the p_faces domain (mutable version).

Detailed Description

template<unsigned N, unsigned D, typename P>
struct mln::p_faces< N, D, P >

A complex psite set based on a the N-faces of a complex of dimension D (a D-complex).


Member Typedef Documentation

template<unsigned N, unsigned D, typename P>
typedef p_faces_bkd_piter_<N, D, P> mln::p_faces< N, D, P >::bkd_piter

Backward Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>
typedef super_ ::site mln::p_faces< N, D, P >::element

Associated types.

Element associated type.

template<unsigned N, unsigned D, typename P>
typedef p_faces_fwd_piter_<N, D, P> mln::p_faces< N, D, P >::fwd_piter

Forward Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>
typedef fwd_piter mln::p_faces< N, D, P >::piter

Site_Iterator associated type.

template<unsigned N, unsigned D, typename P>
typedef faces_psite<N, D, P> mln::p_faces< N, D, P >::psite

Point_Site associated type.


Constructor & Destructor Documentation

template<unsigned N, unsigned D, typename P >
mln::p_faces< N, D, P >::p_faces ( const topo::complex< D > &  cplx  )  [inline]

Construct a faces psite set from an mln::complex.

Parameters:
cplx The complex upon which the complex psite set is built.
template<unsigned N, unsigned D, typename P >
mln::p_faces< N, D, P >::p_faces ( const p_complex< D, P > &  pc  )  [inline]

Construct a faces psite set from an mln::p_complex.

Parameters:
pc The complex upon which the complex psite set is built.

Member Function Documentation

template<unsigned N, unsigned D, typename P >
topo::complex< D > & mln::p_faces< N, D, P >::cplx (  )  const

Accessors.

Return the complex associated to the p_faces domain (const version).

References mln::p_faces< N, D, P >::is_valid().

Referenced by mln::faces_psite< N, D, P >::change_target(), and mln::operator==().

template<unsigned N, unsigned D, typename P >
topo::complex< D > & mln::p_faces< N, D, P >::cplx (  ) 

Return the complex associated to the p_faces domain (mutable version).

References mln::p_faces< N, D, P >::is_valid().

template<unsigned N, unsigned D, typename P >
bool mln::p_faces< N, D, P >::is_valid (  )  const [inline]

Is this site set valid?

Referenced by mln::p_faces< N, D, P >::cplx().

template<unsigned N, unsigned D, typename P >
unsigned mln::p_faces< N, D, P >::nfaces (  )  const [inline]

Return The number of faces in the complex.

Referenced by mln::p_faces< N, D, P >::nsites().

template<unsigned N, unsigned D, typename P >
unsigned mln::p_faces< N, D, P >::nsites (  )  const [inline]

Return The number of sites of the set, i.e., the number of faces.

(Required by the mln::Site_Set concept, since the property trait::site_set::nsites::known of this site set is set to `known'.)

References mln::p_faces< N, D, P >::nfaces().