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

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

Public Member Functions

 p_faces (const topo::complex< D > &cplx)
 p_faces (const p_complex< D, P > &pc)
bool has (const psite &p) const
bool is_empty () const
bool is_valid () const
std::size_t memory_size () const
unsigned nfaces () const
unsigned nsites () const
topo::complex< D > & cplx () const
topo::complex< D > & cplx ()

Public Types

typedef Site_Set< void > category
typedef p_faces< N, D, P > exact_t
typedef p_faces< N, D, P > self_
typedef subject< faces_psite
< N, D, P > >::ret 
site
typedef
internal::site_set_base_
< faces_psite< N, D, P >
, self_
super_
typedef super_::site element
typedef faces_psite< N, D, P > psite
typedef p_faces_fwd_piter_< N,
D, P > 
fwd_piter
typedef p_faces_bkd_piter_< N,
D, P > 
bkd_piter
typedef fwd_piter piter

Related Functions

(Note that these are not member functions.)

template<unsigned N, unsigned D, typename P >
bool operator<= (const p_faces< N, D, P > &lhs, const p_faces< N, D, P > &rhs)
template<unsigned N, unsigned D, typename P >
bool operator== (const p_faces< N, D, P > &lhs, const p_faces< N, D, P > &rhs)

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

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

Parameters
cplxThe 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)

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

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

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

template<unsigned N, unsigned D, typename P>
bool mln::p_faces< N, D, P >::has ( const psite p) const
bool mln::internal::site_set_base_< faces_psite< N, D, P > , p_faces< N, D, P > >::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 N, unsigned D, typename P>
bool mln::p_faces< N, D, P >::is_valid ( ) const

Is this site set valid?

template<unsigned N, unsigned D, typename P>
std::size_t mln::p_faces< N, D, P >::memory_size ( ) const
template<unsigned N, unsigned D, typename P>
unsigned mln::p_faces< N, D, P >::nfaces ( ) const

Return The number of faces in the complex.

template<unsigned N, unsigned D, typename P>
unsigned mln::p_faces< N, D, P >::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'.)

Friends And Related Function Documentation

template<unsigned N, unsigned D, typename P >
bool operator<= ( const p_faces< N, D, P > &  lhs,
const p_faces< N, D, P > &  rhs 
)
related

Inclusion of a mln::p_faces in another one.

This inclusion relation is very strict for the moment, since our infrastrure for complexs is simple: a mln::p_faces is included in another one if their are equal.

template<unsigned N, unsigned D, typename P >
bool operator== ( const p_faces< N, D, P > &  lhs,
const p_faces< N, D, P > &  rhs 
)
related

Comparison between two mln::p_faces's.

Two mln::p_faces's are considered equal if they share the same 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.

Definition at line 111 of file p_faces.hh.

typedef Site_Set<void> mln::Site_Set< p_faces< N, D, P > >::category
inherited

Definition at line 74 of file core/concept/site_set.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 100 of file p_faces.hh.

typedef p_faces< N, D, P > mln::Object< p_faces< N, D, P > >::exact_t
inherited

Definition at line 105 of file object.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 107 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 114 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 103 of file p_faces.hh.

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

Definition at line 82 of file p_faces.hh.

typedef subject<faces_psite< N, D, P > >::ret mln::internal::site_set_base_< faces_psite< N, D, P > , p_faces< N, D, P > >::site
inherited

Site associated type.

Definition at line 58 of file site_set_base.hh.

template<unsigned N, unsigned D, typename P>
typedef internal::site_set_base_< faces_psite<N, D, P>, self_ > mln::p_faces< N, D, P >::super_

Definition at line 83 of file p_faces.hh.