mln::topo::n_face< N, D > Class Template Reference

N-face handle in a complex. More...

#include <n_face.hh>

Inheritance diagram for mln::topo::n_face< N, D >:

Inheritance graph

List of all members.

Public Member Functions

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


Detailed Description

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

N-face handle in a complex.

Contrary to an mln::topo::face, the dimension of an mln::topo::n_face is fixed.


Constructor & Destructor Documentation

template<unsigned N, unsigned D>
mln::topo::n_face< N, D >::n_face (  )  [inline]

Build a non-initialized face handle.

References mln::topo::n_face< N, D >::is_valid().

template<unsigned N, unsigned D>
mln::topo::n_face< N, D >::n_face ( complex< D > &  complex,
unsigned  face_id 
) [inline]

Build a face handle from complex and face_id.


Member Function Documentation

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

Accessors.

Return the complex the face belongs to.

Referenced by mln::topo::operator!=(), and mln::topo::operator==().

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

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

References mln::topo::n_face< N, D >::is_valid().

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::dec_face_id (  )  [inline]

Decrement the id of the face.

template<unsigned N, unsigned D>
unsigned mln::topo::n_face< N, D >::face_id (  )  const [inline]

Return the id of the face.

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

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

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

References mln::topo::n_face< N, D >::is_valid().

Referenced by mln::topo::edge().

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::inc_face_id (  )  [inline]

Increment the id of the face.

template<unsigned N, unsigned D>
void mln::topo::n_face< N, D >::invalidate (  )  [inline]

Invalidate this handle.

References mln::topo::n_face< N, D >::set_face_id().

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

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

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 [inline]

Return the dimension of the face.

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

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  )  [inline]

Set the id of the face.

Referenced by mln::topo::n_face< N, D >::invalidate().


Generated on Tue Jul 14 16:33:15 2009 for Milena (Olena) by  doxygen 1.5.9