$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::p_complex< D, G > Class Template Reference

#include <mln/core/site_set/p_complex.hh>

Public Member Functions

 p_complex (const topo::complex< D > &cplx, const G &geom)
bool has (const psite &p) const
bool is_empty () const
bool is_valid () const
std::size_t memory_size () const
unsigned nfaces () const
unsigned nfaces_of_dim (unsigned n) const
unsigned nsites () const
topo::complex< D > & cplx () const
topo::complex< D > & cplx ()
const G & geom () const

Public Types

typedef Site_Set< void > category
typedef p_complex< D, G > exact_t
typedef subject< complex_psite
< D, G > >::ret 
site
typedef super_::site element
typedef complex_psite< D, G > psite
typedef p_complex_fwd_piter_
< D, G > 
fwd_piter
typedef p_complex_bkd_piter_
< D, G > 
bkd_piter
typedef fwd_piter piter

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.

Constructor & Destructor Documentation

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

Construct a complex psite set from a complex.

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

Member Function Documentation

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

Accessors.

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

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

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

Return the geometry of the complex.

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

Does this site set has p?

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

Is this site set valid?

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

Return the number of faces in the complex.

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

Return the number of n-faces in the complex.

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

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

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

Definition at line 74 of file 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 105 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.

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 58 of file site_set_base.hh.