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

Algebraic face handle in a complex; the face dimension is dynamic. More...

#include <algebraic_face.hh>

Inheritance diagram for mln::topo::algebraic_face< D >:
Inheritance graph

Public Member Functions

 algebraic_face ()
 Build a non-initialized algebraic face handle.
 
 algebraic_face (complex< D > &complex, unsigned n, unsigned face_id, bool sign)
 Build an algebraic face handle from complex and face_id.
 
 algebraic_face (const face< D > &f, bool sign)
 Build an algebraic face handle from an mln::face.
 
template<unsigned N>
 algebraic_face (const algebraic_n_face< N, D > &f)
 Build a face handle from an mln::topo::algebraic_n_face.
 
void invalidate ()
 Invalidate this handle.
 
bool is_valid () const
 Is this handle valid?
 
bool sign () const
 Accessors.
 
void set_sign (bool sign)
 Set the sign of this face.
 
complex< D > cplx () const
 Accessors.
 
unsigned n () const
 Return the dimension of the face.
 
unsigned face_id () const
 Return the id of the face.
 
void set_cplx (const complex< D > &cplx)
 Set the complex the face belongs to.
 
void set_n (unsigned n)
 Set the dimension of the face.
 
void inc_n ()
 Increment the dimension of the face.
 
void dec_n ()
 Decrement the dimension of the face.
 
void set_face_id (unsigned face_id)
 Set the id of the face.
 
void inc_face_id ()
 Increment the id of the face.
 
void dec_face_id ()
 Decrement the id of the face.
 
template<unsigned N>
face_data< N, D > & data () const
 Return the mln::topo::face_data pointed by this handle.
 
std::vector< algebraic_face< D > > lower_dim_adj_faces () const
 Return an array of face handles pointing to adjacent (n-1)-faces.
 
std::vector< algebraic_face< D > > higher_dim_adj_faces () const
 Return an array of face handles pointing to adjacent (n+1)-faces.
 

Detailed Description

template<unsigned D>
class mln::topo::algebraic_face< D >

Algebraic face handle in a complex; the face dimension is dynamic.

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

Definition at line 60 of file algebraic_face.hh.

Constructor & Destructor Documentation

template<unsigned D>
algebraic_face< D >::algebraic_face ( )
inline

Build a non-initialized algebraic face handle.

Definition at line 157 of file algebraic_face.hh.

template<unsigned D>
algebraic_face< D >::algebraic_face ( complex< D > &  complex,
unsigned  n,
unsigned  face_id,
bool  sign 
)
inline

Build an algebraic face handle from complex and face_id.

Definition at line 164 of file algebraic_face.hh.

template<unsigned D>
algebraic_face< D >::algebraic_face ( const face< D > &  f,
bool  sign 
)
inline

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

Definition at line 174 of file algebraic_face.hh.

References mln::topo::face< D >::n().

template<unsigned D>
template<unsigned N>
algebraic_face< D >::algebraic_face ( const algebraic_n_face< N, D > &  f)
inline

Build a face handle from an mln::topo::algebraic_n_face.

Definition at line 184 of file algebraic_face.hh.

Member Function Documentation

template<unsigned D>
complex< D > face< D >::cplx ( ) const
inlineinherited

Accessors.

Return the complex the face belongs to.

Definition at line 224 of file face.hh.

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

template<unsigned D>
template<unsigned N>
face_data< N, D > & face< D >::data ( ) const
inlineinherited

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

Definition at line 305 of file face.hh.

template<unsigned D>
void face< D >::dec_face_id ( )
inlineinherited

Decrement the id of the face.

Definition at line 296 of file face.hh.

template<unsigned D>
void face< D >::dec_n ( )
inlineinherited

Decrement the dimension of the face.

Definition at line 272 of file face.hh.

template<unsigned D>
unsigned face< D >::face_id ( ) const
inlineinherited

Return the id of the face.

Definition at line 240 of file face.hh.

Referenced by mln::geom::complex_geometry< D, P >::operator()(), and mln::topo::operator==().

template<unsigned D>
std::vector< algebraic_face< D > > face< D >::higher_dim_adj_faces ( ) const
inlineinherited

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

Definition at line 370 of file face.hh.

template<unsigned D>
void face< D >::inc_face_id ( )
inlineinherited

Increment the id of the face.

Definition at line 288 of file face.hh.

template<unsigned D>
void face< D >::inc_n ( )
inlineinherited

Increment the dimension of the face.

Definition at line 264 of file face.hh.

template<unsigned D>
void face< D >::invalidate ( )
inlineinherited

Invalidate this handle.

Definition at line 215 of file face.hh.

template<unsigned D>
bool face< D >::is_valid ( ) const
inlineinherited

Is this handle valid?

Definition at line 207 of file face.hh.

template<unsigned D>
std::vector< algebraic_face< D > > face< D >::lower_dim_adj_faces ( ) const
inlineinherited

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

Definition at line 357 of file face.hh.

template<unsigned D>
unsigned face< D >::n ( ) const
inlineinherited

Return the dimension of the face.

Definition at line 232 of file face.hh.

Referenced by mln::topo::algebraic_face< D >::algebraic_face(), mln::geom::complex_geometry< D, P >::operator()(), and mln::topo::operator==().

template<unsigned D>
void face< D >::set_cplx ( const complex< D > &  cplx)
inlineinherited

Set the complex the face belongs to.

Definition at line 248 of file face.hh.

template<unsigned D>
void face< D >::set_face_id ( unsigned  face_id)
inlineinherited

Set the id of the face.

Definition at line 280 of file face.hh.

template<unsigned D>
void face< D >::set_n ( unsigned  n)
inlineinherited

Set the dimension of the face.

Definition at line 256 of file face.hh.

template<unsigned D>
void algebraic_face< D >::set_sign ( bool  sign)
inline

Set the sign of this face.

Definition at line 203 of file algebraic_face.hh.

template<unsigned D>
bool algebraic_face< D >::sign ( ) const
inline

Accessors.

Return the sign of this face.

Definition at line 195 of file algebraic_face.hh.

Referenced by mln::topo::operator==().