Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::p_complex< D, G > Class Template Reference

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

#include <p_complex.hh>

Inherits mln::internal::site_set_base_< complex_psite< D, G >, p_complex< D, G > >.

Public Types

typedef super_::site element
 Associated types.
 
typedef complex_psite< D, G > psite
 Point_Site associated type.
 
typedef p_complex_fwd_piter_
< D, G > 
fwd_piter
 Forward Site_Iterator associated type.
 
typedef p_complex_bkd_piter_
< D, G > 
bkd_piter
 Backward Site_Iterator associated type.
 
typedef fwd_piter piter
 Site_Iterator associated type.
 

Public Member Functions

bool has (const psite &p) const
 Does this site set has p?
 
bool is_valid () const
 Is this site set valid?
 
unsigned nfaces () const
 Return the number of faces in the complex.
 
unsigned nfaces_of_dim (unsigned n) const
 Return the number of n-faces in the complex.
 
unsigned nsites () const
 Return The number of sites of the set, i.e., the number of faces.
 
 p_complex (const topo::complex< D > &cplx, const G &geom)
 Construct a complex psite set from a complex.
 
topo::complex< D > & cplx () const
 Accessors.
 
topo::complex< D > & cplx ()
 Return the complex associated to the p_complex domain (mutable version).
 
const G & geom () const
 Return the geometry of the complex.
 

Detailed Description

template<unsigned D, typename G>
class mln::p_complex< D, G >

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

Template Parameters
DThe dimension of the complex.
GA function object type, associating localization information (geometry) to each face of the complex.
See Also
mln::geom::complex_geometry. A complex psite set based on the N-faces of a complex.

Definition at line 116 of file p_complex.hh.

Member Typedef Documentation

template<unsigned D, typename G>
typedef p_complex_bkd_piter_<D, G> mln::p_complex< D, G >::bkd_piter

Backward Site_Iterator associated type.

Definition at line 141 of file p_complex.hh.

template<unsigned D, typename G>
typedef super_ ::site mln::p_complex< D, G >::element

Associated types.

Element associated type.

Definition at line 132 of file p_complex.hh.

template<unsigned D, typename G>
typedef p_complex_fwd_piter_<D, G> mln::p_complex< D, G >::fwd_piter

Forward Site_Iterator associated type.

Definition at line 138 of file p_complex.hh.

template<unsigned D, typename G>
typedef fwd_piter mln::p_complex< D, G >::piter

Site_Iterator associated type.

Definition at line 144 of file p_complex.hh.

template<unsigned D, typename G>
typedef complex_psite<D, G> mln::p_complex< D, G >::psite

Point_Site associated type.

Definition at line 135 of file p_complex.hh.

Constructor & Destructor Documentation

template<unsigned D, typename G >
p_complex< D, G >::p_complex ( const topo::complex< D > &  cplx,
const G &  geom 
)
inline

Construct a complex psite set from a complex.

Parameters
cplxThe complex upon which the complex psite set is built.
geomFIXME

Definition at line 231 of file p_complex.hh.

Member Function Documentation

template<unsigned D, typename G >
topo::complex< D > & p_complex< D, G >::cplx ( ) const

Accessors.

Return the complex associated to the p_complex domain (const version)

Definition at line 293 of file p_complex.hh.

Referenced by mln::complex_psite< D, G >::change_target(), mln::complex_psite< D, G >::complex_psite(), and mln::operator==().

template<unsigned D, typename G >
topo::complex< D > & p_complex< D, G >::cplx ( )

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

Definition at line 301 of file p_complex.hh.

template<unsigned D, typename G >
const G & p_complex< D, G >::geom ( ) const

Return the geometry of the complex.

Definition at line 309 of file p_complex.hh.

template<unsigned D, typename G >
bool p_complex< D, G >::has ( const psite p) const
inline

Does this site set has p?

Definition at line 271 of file p_complex.hh.

References mln::complex_psite< D, G >::is_valid(), and mln::complex_psite< D, G >::site_set().

template<unsigned D, typename G >
bool p_complex< D, G >::is_valid ( ) const
inline

Is this site set valid?

Definition at line 263 of file p_complex.hh.

template<unsigned D, typename G >
unsigned p_complex< D, G >::nfaces ( ) const
inline

Return the number of faces in the complex.

Definition at line 247 of file p_complex.hh.

template<unsigned D, typename G >
unsigned p_complex< D, G >::nfaces_of_dim ( unsigned  n) const
inline

Return the number of n-faces in the complex.

Definition at line 255 of file p_complex.hh.

template<unsigned D, typename G >
unsigned p_complex< D, G >::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 239 of file p_complex.hh.