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

mln::p_complex< D, G > Class Template Reference
[Complex based]

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

#include <p_complex.hh>

Inheritance diagram for mln::p_complex< D, G >:
Inheritance graph

List of all members.

Public Types

typedef Site_Set< void > category
typedef p_complex< D, G > exact_t
typedef subject< complex_psite
< D, G > >::ret 
site
 Site associated type.

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_empty () const
 Test if the site set is empty.
bool is_valid () const
 Is this site set valid?
std::size_t memory_size () const
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.

Private Types

typedef p_complex< D, G > self_
typedef
internal::site_set_base_
< complex_psite< D, G >, self_
super_

Private Attributes

topo::complex< D > cplx_
 The complex on which this pset is built.
geom_
 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:
D The dimension of the complex.
G A 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.

typedef Site_Set<void> mln::Site_Set< p_complex< D, G > >::category [inherited]

Reimplemented from mln::Object< p_complex< D, G > >.

Definition at line 67 of file mln/core/concept/site_set.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.

typedef p_complex< D, G > mln::Object< p_complex< D, G > >::exact_t [inherited]

Definition at line 173 of file object.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.

template<unsigned D, typename G>
typedef p_complex<D, G> mln::p_complex< D, G >::self_ [private]

Definition at line 119 of file p_complex.hh.

typedef subject<complex_psite< D, G > >::ret mln::internal::site_set_base_< complex_psite< D, G > , p_complex< D, G > >::site [inherited]

Site associated type.

Definition at line 55 of file site_set_base.hh.

template<unsigned D, typename G>
typedef internal::site_set_base_< complex_psite<D, G>, self_ > mln::p_complex< D, G >::super_ [private]

Definition at line 120 of file p_complex.hh.


Constructor & Destructor Documentation

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

Construct a complex psite set from a complex.

Parameters:
cplx The complex upon which the complex psite set is built.
geom FIXME

Definition at line 231 of file p_complex.hh.


Member Function Documentation

template<unsigned D, typename G >
topo::complex< D > & mln::p_complex< D, G >::cplx (  )  const
template<unsigned D, typename G >
topo::complex< D > & mln::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.

References mln::p_complex< D, G >::is_valid().

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

Return the geometry of the complex.

Definition at line 309 of file p_complex.hh.

Referenced by mln::complex_psite< D, G >::update_().

template<unsigned D, typename G >
bool mln::p_complex< D, G >::has ( const psite p  )  const [inline]
bool mln::internal::site_set_base_< complex_psite< D, G > , p_complex< D, G > >::is_empty (  )  const [inherited]

Test if the site set is empty.

This final method dispatches to is_empty_ whose default implementation relies on the 'nsites' method.

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

Is this site set valid?

Definition at line 263 of file p_complex.hh.

Referenced by mln::p_complex< D, G >::cplx(), and mln::p_complex< D, G >::has().

template<unsigned D, typename G >
std::size_t mln::p_complex< D, G >::memory_size (  )  const [inline]

Definition at line 284 of file p_complex.hh.

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

Return the number of faces in the complex.

Definition at line 247 of file p_complex.hh.

Referenced by mln::p_complex< D, G >::nsites().

template<unsigned D, typename G >
unsigned mln::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.

Referenced by mln::complex_image< D, G, V >::complex_image().

template<unsigned D, typename G >
unsigned mln::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.

References mln::p_complex< D, G >::nfaces().


Member Data Documentation

template<unsigned D, typename G>
topo::complex<D> mln::p_complex< D, G >::cplx_ [mutable, private]

The complex on which this pset is built.

Definition at line 199 of file p_complex.hh.

template<unsigned D, typename G>
G mln::p_complex< D, G >::geom_ [private]

Geometry of the complex.

Definition at line 201 of file p_complex.hh.