$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::topo::complex< D > Class Template Reference

#include <mln/topo/complex.hh>

Public Member Functions

const void * addr () const
 complex ()
n_face< 0, D > add_face ()
template<unsigned N>
n_face< N+1, D > add_face (const n_faces_set< N, D > &adjacent_faces)
unsigned nfaces () const
template<unsigned N>
unsigned nfaces_of_static_dim () const
unsigned nfaces_of_dim (unsigned n) const
void print (std::ostream &ostr) const
template<unsigned N>
void print_faces (std::ostream &ostr) const

Public Types

typedef face_bkd_iter< D > bkd_citer
typedef face_fwd_iter< D > fwd_citer

Friends

template<unsigned D_>
bool operator== (const complex< D_ > &lhs, const complex< D_ > &rhs)

Detailed Description

template<unsigned D>
class mln::topo::complex< D >

General complex of dimension D.

Definition at line 88 of file complex.hh.

Constructor & Destructor Documentation

template<unsigned D>
mln::topo::complex< D >::complex ( )

Complex construction.

Create a new D-complex.

Member Function Documentation

template<unsigned D>
n_face<0, D> mln::topo::complex< D >::add_face ( )

Add a 0-face to the complex.

template<unsigned D>
template<unsigned N>
n_face<N + 1, D> mln::topo::complex< D >::add_face ( const n_faces_set< N, D > &  adjacent_faces)

Add a (N+1)-face to the complex (with N >= 0).

Parameters
adjacent_facesThe (N-1)-faces adjacent to the new N-face.
template<unsigned D>
const void* mln::topo::complex< D >::addr ( ) const

Get the address of the data of this complex.

This address is a concise and useful information to print and track the actual content of this complex.

template<unsigned D>
unsigned mln::topo::complex< D >::nfaces ( ) const

Static manipulators.

These methods use statically-known input.

Return the total number of faces, whatever their dimension.

template<unsigned D>
unsigned mln::topo::complex< D >::nfaces_of_dim ( unsigned  n) const

Dynamic manipulators.

These methods use input know as run time.

Return the number of n-faces.

Warning, this function has a complexity linear in term of N, since each n_faces_set is checked (the present implementation does not provide a direct access to n_faces_set through a dynamic value of the dimension).

template<unsigned D>
template<unsigned N>
unsigned mln::topo::complex< D >::nfaces_of_static_dim ( ) const

Return the number of N-faces.

template<unsigned D>
void mln::topo::complex< D >::print ( std::ostream &  ostr) const

Pretty-printing.

Print the complex.

template<unsigned D>
template<unsigned N>
void mln::topo::complex< D >::print_faces ( std::ostream &  ostr) const

Print the faces of dimension N.

Friends And Related Function Documentation

template<unsigned D>
template<unsigned D_>
bool operator== ( const complex< D_ > &  lhs,
const complex< D_ > &  rhs 
)
friend

Member Typedef Documentation

template<unsigned D>
typedef face_bkd_iter<D> mln::topo::complex< D >::bkd_citer

Backward mln::Iterator type iterating on all faces.

Definition at line 94 of file complex.hh.

template<unsigned D>
typedef face_fwd_iter<D> mln::topo::complex< D >::fwd_citer

Forward mln::Iterator type iterating on all faces.

Definition at line 92 of file complex.hh.