mln::topo::face< D > Class Template Reference

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

#include <face.hh>

Inheritance diagram for mln::topo::face< D >:

List of all members.

Public Member Functions
	face ()
	Build a non-initialized face handle.
	face (complex< D > &complex, unsigned n, unsigned face_id)
	Build a face handle from complex and face_id.
template<unsigned N>
	face (const n_face< N, D > &f)
	Build a face handle from an mln::topo::n_face.
void	invalidate ()
	Invalidate this handle.
bool	is_valid () const
	Is this handle valid?
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::face< D >

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

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

Definition at line 64 of file face.hh.

---

Constructor & Destructor Documentation

template<unsigned D>

mln::topo::face< D >::face

(

)

[inline]

Build a non-initialized face handle.

Definition at line 178 of file face.hh.

template<unsigned D>

mln::topo::face< D >::face	(	complex< D > &	complex,
		unsigned	n,
		unsigned	face_id
	)			[inline]

Build a face handle from complex and face_id.

Definition at line 187 of file face.hh.

template<unsigned D>

template<unsigned N>

mln::topo::face< D >::face

(

const n_face< N, D > &

f

)

[inline]

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

Definition at line 197 of file face.hh.

---

Member Function Documentation

template<unsigned D>

complex< D > mln::topo::face< D >::cplx

(

)

const [inline]

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 > & mln::topo::face< D >::data

(

)

const [inline]

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

Definition at line 305 of file face.hh.

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

template<unsigned D>

void mln::topo::face< D >::dec_face_id

(

)

[inline]

Decrement the id of the face.

Definition at line 296 of file face.hh.

template<unsigned D>

void mln::topo::face< D >::dec_n

(

)

[inline]

Decrement the dimension of the face.

Definition at line 272 of file face.hh.

template<unsigned D>

unsigned mln::topo::face< D >::face_id

(

)

const [inline]

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 > > mln::topo::face< D >::higher_dim_adj_faces

(

)

const [inline]

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

Definition at line 370 of file face.hh.

template<unsigned D>

void mln::topo::face< D >::inc_face_id

(

)

[inline]

Increment the id of the face.

Definition at line 288 of file face.hh.

template<unsigned D>

void mln::topo::face< D >::inc_n

(

)

[inline]

Increment the dimension of the face.

Definition at line 264 of file face.hh.

template<unsigned D>

void mln::topo::face< D >::invalidate

(

)

[inline]

Invalidate this handle.

Definition at line 215 of file face.hh.

References mln::topo::face< D >::set_face_id(), and mln::topo::face< D >::set_n().

template<unsigned D>

bool mln::topo::face< D >::is_valid

(

)

const [inline]

Is this handle valid?

Definition at line 207 of file face.hh.

Referenced by mln::topo::face< D >::data().

template<unsigned D>

std::vector< algebraic_face< D > > mln::topo::face< D >::lower_dim_adj_faces

(

)

const [inline]

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

Definition at line 357 of file face.hh.

template<unsigned D>

unsigned mln::topo::face< D >::n

(

)

const [inline]

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 mln::topo::face< D >::set_cplx

(

const complex< D > &

cplx

)

[inline]

Set the complex the face belongs to.

Definition at line 248 of file face.hh.

template<unsigned D>

void mln::topo::face< D >::set_face_id

(

unsigned

face_id

)

[inline]

Set the id of the face.

Definition at line 280 of file face.hh.

Referenced by mln::topo::face< D >::invalidate().

template<unsigned D>

void mln::topo::face< D >::set_n

(

unsigned

n

)

[inline]

Set the dimension of the face.

Definition at line 256 of file face.hh.

Referenced by mln::topo::face< D >::invalidate().