mln::topo::n_face< N, D > Class Template Reference
N-face handle in a complex.
More...
#include <n_face.hh>
Public Types | |
| typedef complex< D > | complex_type |
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. | |
Private Attributes | |
| complex< D > | cplx_ |
| The complex the face belongs to. | |
| unsigned | face_id_ |
| 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.
Definition at line 61 of file n_face.hh.
Member Typedef Documentation
| typedef complex<D> mln::topo::n_face< N, D >::complex_type |
Constructor & Destructor Documentation
| 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().
| mln::topo::n_face< N, D >::n_face | ( | complex< D > & | complex, | |
| unsigned | face_id | |||
| ) | [inline] |
Member Function Documentation
| 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.
References mln::topo::n_face< N, D >::cplx_.
Referenced by mln::topo::n_faces_set< N, D >::add(), mln::topo::operator!=(), and mln::topo::operator==().
| 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 >::cplx_, mln::topo::n_face< N, D >::face_id_, and mln::topo::n_face< N, D >::is_valid().
Referenced by mln::topo::complex< D >::connect_().
| 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.
References mln::topo::n_face< N, D >::face_id_.
| 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.
References mln::topo::n_face< N, D >::face_id_.
Referenced by mln::topo::operator==().
| 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 >::cplx_, mln::topo::n_face< N, D >::face_id_, and mln::topo::n_face< N, D >::is_valid().
Referenced by mln::topo::edge().
| 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.
References mln::topo::n_face< N, D >::face_id_.
| 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().
| bool mln::topo::n_face< N, D >::is_valid | ( | ) | const [inline] |
Is this handle valid?
Definition at line 179 of file n_face.hh.
References mln::topo::n_face< N, D >::cplx_, and mln::topo::n_face< N, D >::face_id_.
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(), mln::topo::n_face< N, D >::n_face(), and mln::io::off::internal::off_loader< I, E >::operator()().
| 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 >::cplx_, mln::topo::n_face< N, D >::face_id_, and mln::topo::n_face< N, D >::is_valid().
| unsigned mln::topo::n_face< N, D >::n | ( | ) | const [inline] |
| 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.
References mln::topo::n_face< N, D >::cplx_.
| 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.
References mln::topo::n_face< N, D >::face_id_.
Referenced by mln::topo::n_face< N, D >::invalidate().
Member Data Documentation
complex<D> mln::topo::n_face< N, D >::cplx_ [mutable, private] |
The complex the face belongs to.
A const mln::topo::n_face can be used to modify a complex.
Definition at line 112 of file n_face.hh.
Referenced by mln::topo::n_face< N, D >::cplx(), mln::topo::n_face< N, D >::data(), mln::topo::n_face< N, D >::higher_dim_adj_faces(), mln::topo::n_face< N, D >::is_valid(), mln::topo::n_face< N, D >::lower_dim_adj_faces(), and mln::topo::n_face< N, D >::set_cplx().
unsigned mln::topo::n_face< N, D >::face_id_ [private] |
The id of the face.
Definition at line 115 of file n_face.hh.
Referenced by mln::topo::n_face< N, D >::data(), mln::topo::n_face< N, D >::dec_face_id(), mln::topo::n_face< N, D >::face_id(), mln::topo::n_face< N, D >::higher_dim_adj_faces(), mln::topo::n_face< N, D >::inc_face_id(), mln::topo::n_face< N, D >::is_valid(), mln::topo::n_face< N, D >::lower_dim_adj_faces(), and mln::topo::n_face< N, D >::set_face_id().
