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).

Definition at line 77 of file p_faces.hh.

---

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.

Definition at line 110 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>

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

Associated types.

Element associated type.

Definition at line 99 of file p_faces.hh.

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.

Definition at line 106 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>

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

Site_Iterator associated type.

Definition at line 113 of file p_faces.hh.

template<unsigned N, unsigned D, typename P>

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

Point_Site associated type.

Definition at line 102 of file p_faces.hh.

---

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.

Definition at line 192 of file p_faces.hh.

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.

Definition at line 201 of file p_faces.hh.

---

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).

Definition at line 257 of file p_faces.hh.

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).

Definition at line 265 of file p_faces.hh.

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?

Definition at line 227 of file p_faces.hh.

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.

Definition at line 219 of file p_faces.hh.

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'.)

Definition at line 211 of file p_faces.hh.

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