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 >:

List of all members.

Public Member Functions
void	invalidate ()
	Invalidate this handle.
bool	is_valid () const
	Is this handle valid?
	n_face ()
	Build a non-initialized face handle.
	n_face (complex< D > &complex, unsigned face_id)
	Build a face handle from complex and face_id.
complex< D >	cplx () const
	Accessors.
unsigned	face_id () const
	Return the id of the face.
void	set_cplx (const complex< D > &cplx)
	Set the complex the face belongs to.
unsigned	n () const
	Return 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.
face_data< N, D > &	data () const
	Return the mln::topo::face_data pointed by this handle.
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.
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.

---

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.

Definition at line 61 of file n_face.hh.

---

Constructor & Destructor Documentation

template<unsigned N, unsigned D>

mln::topo::n_face< N, D >::n_face

(

)

[inline]

Build a non-initialized face handle.

Definition at line 159 of file n_face.hh.

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.

Definition at line 169 of file n_face.hh.

---

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.

Definition at line 195 of file n_face.hh.

Referenced by mln::topo::n_faces_set< N, D >::add(), 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.

Definition at line 251 of file n_face.hh.

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.

Definition at line 243 of file n_face.hh.

template<unsigned N, unsigned D>

unsigned mln::topo::n_face< N, D >::face_id

(

)

const [inline]

Return the id of the face.

Definition at line 211 of file n_face.hh.

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.

Definition at line 270 of file n_face.hh.

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.

Definition at line 235 of file n_face.hh.

template<unsigned N, unsigned D>

void mln::topo::n_face< N, D >::invalidate

(

)

[inline]

Invalidate this handle.

Definition at line 187 of file n_face.hh.

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]

Is this handle valid?

Definition at line 179 of file n_face.hh.

Referenced by mln::topo::algebraic_n_face< N, D >::algebraic_n_face(), mln::topo::n_face< N, D >::data(), mln::topo::n_face< N, D >::higher_dim_adj_faces(), mln::topo::n_face< N, D >::lower_dim_adj_faces(), and mln::topo::n_face< N, D >::n_face().

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.

Definition at line 260 of file n_face.hh.

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

template<unsigned N, unsigned D>

unsigned mln::topo::n_face< N, D >::n

(

)

const [inline]

Return the dimension of the face.

Definition at line 203 of file n_face.hh.

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.

Definition at line 219 of file n_face.hh.

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.

Definition at line 227 of file n_face.hh.

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