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

#include <mln/topo/algebraic_n_face.hh>

Public Member Functions

 algebraic_n_face ()
 algebraic_n_face (complex< D > &complex, unsigned face_id, bool sign)
 algebraic_n_face (const n_face< N, D > &f, bool sign)
void invalidate ()
bool is_valid () const
bool sign () const
void set_sign (bool sign)
complex< D > cplx () const
unsigned face_id () const
void set_cplx (const complex< D > &cplx)
unsigned n () const
void set_face_id (unsigned face_id)
void inc_face_id ()
void dec_face_id ()
face_data< N, D > & data () const
std::vector< algebraic_n_face
< N-1, D > > 
lower_dim_adj_faces () const
std::vector< algebraic_n_face
< N+1, D > > 
higher_dim_adj_faces () const

Public Types

typedef complex< D > complex_type

Detailed Description

template<unsigned N, unsigned D>
class mln::topo::algebraic_n_face< N, D >

Algebraic N-face handle in a complex.

Contrary to an mln::topo::algebraic_face, the dimension of an mln::topo::algebraic_n_face is fixed.

Definition at line 50 of file algebraic_n_face.hh.

Constructor & Destructor Documentation

template<unsigned N, unsigned D>
mln::topo::algebraic_n_face< N, D >::algebraic_n_face ( )

Build a non-initialized algebraic face handle.

template<unsigned N, unsigned D>
mln::topo::algebraic_n_face< N, D >::algebraic_n_face ( complex< D > &  complex,
unsigned  face_id,
bool  sign 
)

Build an algebraic face handle from complex and face_id.

template<unsigned N, unsigned D>
mln::topo::algebraic_n_face< N, D >::algebraic_n_face ( const n_face< N, D > &  f,
bool  sign 
)

Build an algebraic face handle from an mln::n_face.

Member Function Documentation

template<unsigned N, unsigned D>
complex<D> mln::topo::n_face< N, D >::cplx ( ) const
inherited

Accessors.

Return the complex the face belongs to.

template<unsigned N, unsigned D>
face_data<N, D>& mln::topo::n_face< N, D >::data ( ) const
inherited

Return the mln::topo::face_data pointed by this handle.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::dec_face_id ( )
inherited

Decrement the id of the face.

template<unsigned N, unsigned D>
unsigned mln::topo::n_face< N, D >::face_id ( ) const
inherited

Return the id of the face.

template<unsigned N, unsigned D>
std::vector< algebraic_n_face<N + 1, D> > mln::topo::n_face< N, D >::higher_dim_adj_faces ( ) const
inherited

Return an array of face handles pointing to adjacent (n+1)-faces.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::inc_face_id ( )
inherited

Increment the id of the face.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::invalidate ( )
inherited

Invalidate this handle.

template<unsigned N, unsigned D>
bool mln::topo::n_face< N, D >::is_valid ( ) const
inherited

Is this handle valid?

template<unsigned N, unsigned D>
std::vector< algebraic_n_face<N - 1, D> > mln::topo::n_face< N, D >::lower_dim_adj_faces ( ) const
inherited

Return an array of face handles pointing to adjacent (n-1)-faces.

template<unsigned N, unsigned D>
unsigned mln::topo::n_face< N, D >::n ( ) const
inherited

Return the dimension of the face.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::set_cplx ( const complex< D > &  cplx)
inherited

Set the complex the face belongs to.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::set_face_id ( unsigned  face_id)
inherited

Set the id of the face.

template<unsigned N, unsigned D>
void mln::topo::algebraic_n_face< N, D >::set_sign ( bool  sign)

Set the sign of this face.

template<unsigned N, unsigned D>
bool mln::topo::algebraic_n_face< N, D >::sign ( ) const

Accessors.

Return the sign of this face.

Member Typedef Documentation

template<unsigned N, unsigned D>
typedef complex<D> mln::topo::n_face< N, D >::complex_type
inherited

Definition at line 65 of file n_face.hh.