mln::topo::face< D > Struct Template Reference
Face handle in a complex; the face dimension is dynamic. More...
#include <face.hh>
Public Types | |
| typedef complex< D > | complex_type |
Public Member Functions | |
| template<unsigned N> | |
| face (const n_face< N, D > &f) | |
| Build a face handle from an mln::topo::n_face. | |
| face (complex< D > &complex, unsigned n, unsigned face_id) | |
| Build a face handle from complex and face_id. | |
| face () | |
| Build a non-initialized face handle. | |
| void | invalidate () |
| Invalidate this handle. | |
| bool | is_valid () const |
| Is this handle valid? | |
| complex< D > | cplx () const |
| Accessors. | |
| template<unsigned N> | |
| 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. | |
| void | dec_n () |
| Decrement the dimension of the face. | |
| unsigned | face_id () const |
| Return the id of the face. | |
| std::vector< algebraic_face< 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. | |
| void | inc_n () |
| Increment the dimension of the face. | |
| std::vector< algebraic_face< 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. | |
| void | set_n (unsigned n) |
| Set the dimension of the face. | |
Private Attributes | |
| complex< D > | cplx_ |
| The complex the face belongs to. | |
| unsigned | face_id_ |
| The id of the face. | |
| unsigned | n_ |
| The dimension of the face. | |
Detailed Description
template<unsigned D>
struct 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 63 of file face.hh.
Member Typedef Documentation
| typedef complex<D> mln::topo::face< D >::complex_type |
Constructor & Destructor Documentation
| mln::topo::face< D >::face | ( | ) | [inline] |
| mln::topo::face< D >::face | ( | complex< D > & | complex, | |
| unsigned | n, | |||
| unsigned | face_id | |||
| ) | [inline] |
| mln::topo::face< D >::face | ( | const n_face< N, D > & | f | ) | [inline] |
Member Function Documentation
| complex< D > mln::topo::face< D >::cplx | ( | ) | const [inline] |
Accessors.
Return the complex the face belongs to.
Definition at line 223 of file face.hh.
References mln::topo::face< D >::cplx_.
Referenced by mln::complex_psite< D, G >::complex_psite(), mln::topo::n_face_bkd_iter< D >::invalidate_face_id_(), mln::topo::n_face_fwd_iter< D >::invalidate_face_id_(), mln::topo::static_n_face_fwd_iter< N, D >::next_(), mln::topo::n_face_fwd_iter< D >::next_(), mln::topo::face_bkd_iter< D >::next_(), mln::topo::face_fwd_iter< D >::next_(), mln::topo::operator!=(), mln::topo::operator==(), mln::topo::static_n_face_bkd_iter< N, D >::start(), mln::topo::n_face_bkd_iter< D >::start(), and mln::topo::face_bkd_iter< D >::start().
| face_data< N, D > & mln::topo::face< D >::data | ( | ) | const [inline] |
Return the mln::topo::face_data pointed by this handle.
Definition at line 304 of file face.hh.
References mln::topo::face< D >::cplx_, mln::topo::face< D >::face_id_, mln::topo::face< D >::is_valid(), and mln::topo::face< D >::n_.
| void mln::topo::face< D >::dec_face_id | ( | ) | [inline] |
Decrement the id of the face.
Definition at line 295 of file face.hh.
References mln::topo::face< D >::face_id_.
Referenced by mln::topo::static_n_face_bkd_iter< N, D >::next_(), mln::topo::n_face_bkd_iter< D >::next_(), and mln::topo::face_bkd_iter< D >::next_().
| void mln::topo::face< D >::dec_n | ( | ) | [inline] |
Decrement the dimension of the face.
Definition at line 271 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::face_bkd_iter< D >::next_().
| unsigned mln::topo::face< D >::face_id | ( | ) | const [inline] |
Return the id of the face.
Definition at line 239 of file face.hh.
References mln::topo::face< D >::face_id_.
Referenced by mln::topo::static_n_face_bkd_iter< N, D >::next_(), mln::topo::static_n_face_fwd_iter< N, D >::next_(), mln::topo::n_face_bkd_iter< D >::next_(), mln::topo::n_face_fwd_iter< D >::next_(), mln::topo::face_bkd_iter< D >::next_(), mln::topo::face_fwd_iter< D >::next_(), mln::geom::complex_geometry< D, P >::operator()(), mln::topo::operator==(), and mln::io::neato::save().
| 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 369 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::internal::adj_higher_dim_connected_n_face_iterator< D >::update_adj_faces__().
| void mln::topo::face< D >::inc_face_id | ( | ) | [inline] |
Increment the id of the face.
Definition at line 287 of file face.hh.
References mln::topo::face< D >::face_id_.
Referenced by mln::topo::static_n_face_fwd_iter< N, D >::next_(), mln::topo::n_face_fwd_iter< D >::next_(), and mln::topo::face_fwd_iter< D >::next_().
| void mln::topo::face< D >::inc_n | ( | ) | [inline] |
Increment the dimension of the face.
Definition at line 263 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::face_fwd_iter< D >::next_().
| void mln::topo::face< D >::invalidate | ( | ) | [inline] |
Invalidate this handle.
Definition at line 214 of file face.hh.
References mln::topo::face< D >::set_face_id(), and mln::topo::face< D >::set_n().
Referenced by mln::topo::internal::complex_set_iterator_base< F, E >::invalidate().
| bool mln::topo::face< D >::is_valid | ( | ) | const [inline] |
Is this handle valid?
Definition at line 206 of file face.hh.
References mln::topo::face< D >::cplx_, mln::topo::face< D >::face_id_, and mln::topo::face< D >::n_.
Referenced by mln::topo::face< D >::data(), and mln::topo::internal::complex_set_iterator_base< F, E >::is_valid().
| 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 356 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::internal::adj_lower_dim_connected_n_face_iterator< D >::update_adj_faces__().
| unsigned mln::topo::face< D >::n | ( | ) | const [inline] |
Return the dimension of the face.
Definition at line 231 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::algebraic_face< D >::algebraic_face(), mln::topo::n_face_bkd_iter< D >::n(), mln::topo::n_face_fwd_iter< D >::n(), mln::topo::face_bkd_iter< D >::next_(), mln::topo::face_fwd_iter< D >::next_(), mln::geom::complex_geometry< D, P >::operator()(), mln::topo::internal::higher_dim_adj_faces_if_dim_matches_< 0, D >::operator()(), mln::topo::internal::higher_dim_adj_faces_if_dim_matches_< N, D >::operator()(), mln::topo::internal::lower_dim_adj_faces_if_dim_matches_< 1, D >::operator()(), mln::topo::internal::lower_dim_adj_faces_if_dim_matches_< N, D >::operator()(), mln::topo::operator==(), and mln::topo::internal::adj_m_face_iterator< D >::update_adj_faces__().
| void mln::topo::face< D >::set_cplx | ( | const complex< D > & | cplx | ) | [inline] |
Set the complex the face belongs to.
Definition at line 247 of file face.hh.
References mln::topo::face< D >::cplx_.
Referenced by mln::topo::internal::complex_set_iterator_base< F, E >::complex_set_iterator_base(), and mln::topo::internal::complex_set_iterator_base< F, E >::set_cplx().
| void mln::topo::face< D >::set_face_id | ( | unsigned | face_id | ) | [inline] |
Set the id of the face.
Definition at line 279 of file face.hh.
References mln::topo::face< D >::face_id_.
Referenced by mln::topo::face< D >::invalidate(), mln::topo::n_face_bkd_iter< D >::invalidate_face_id_(), mln::topo::n_face_fwd_iter< D >::invalidate_face_id_(), mln::topo::face_bkd_iter< D >::next_(), mln::topo::face_fwd_iter< D >::next_(), mln::topo::static_n_face_bkd_iter< N, D >::start(), mln::topo::static_n_face_fwd_iter< N, D >::start(), mln::topo::n_face_bkd_iter< D >::start(), mln::topo::n_face_fwd_iter< D >::start(), mln::topo::face_bkd_iter< D >::start(), and mln::topo::face_fwd_iter< D >::start().
| void mln::topo::face< D >::set_n | ( | unsigned | n | ) | [inline] |
Set the dimension of the face.
Definition at line 255 of file face.hh.
References mln::topo::face< D >::n_.
Referenced by mln::topo::face< D >::invalidate(), mln::topo::n_face_bkd_iter< D >::set_n(), mln::topo::n_face_fwd_iter< D >::set_n(), mln::topo::face_bkd_iter< D >::start(), mln::topo::face_fwd_iter< D >::start(), mln::topo::static_n_face_bkd_iter< N, D >::static_n_face_bkd_iter(), and mln::topo::static_n_face_fwd_iter< N, D >::static_n_face_fwd_iter().
Member Data Documentation
complex<D> mln::topo::face< D >::cplx_ [mutable, private] |
The complex the face belongs to.
A const face can be used to modify a complex.
Definition at line 126 of file face.hh.
Referenced by mln::topo::face< D >::cplx(), mln::topo::face< D >::data(), mln::topo::face< D >::is_valid(), and mln::topo::face< D >::set_cplx().
unsigned mln::topo::face< D >::face_id_ [private] |
The id of the face.
Definition at line 132 of file face.hh.
Referenced by mln::topo::face< D >::data(), mln::topo::face< D >::dec_face_id(), mln::topo::face< D >::face_id(), mln::topo::face< D >::inc_face_id(), mln::topo::face< D >::is_valid(), and mln::topo::face< D >::set_face_id().
unsigned mln::topo::face< D >::n_ [private] |
The dimension of the face.
Definition at line 129 of file face.hh.
Referenced by mln::topo::face< D >::data(), mln::topo::face< D >::dec_n(), mln::topo::face< D >::higher_dim_adj_faces(), mln::topo::face< D >::inc_n(), mln::topo::face< D >::is_valid(), mln::topo::face< D >::lower_dim_adj_faces(), mln::topo::face< D >::n(), and mln::topo::face< D >::set_n().
