Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::complex_image< D, G, V > Class Template Reference

Image based on a complex. More...

#include <complex_image.hh>

Inherits mln::internal::image_primary< V, p_complex< D, G >, complex_image< D, G, V > >.

Public Types

typedef G geom
 The geometry type of the complex.
 
typedef V & lvalue
 Return type of read-write access.
 
typedef const V & rvalue
 Return type of read-only access.
 
typedef complex_image< D,
tag::psite_< G >, tag::value_
< V > > 
skeleton
 Skeleton.
 
typedef V value
 Value associated type.
 

Public Member Functions

rvalue operator() (const complex_psite< D, G > &p) const
 Read-only access of face value at point site p.
 
lvalue operator() (const complex_psite< D, G > &p)
 Read-write access of face value at point site p.
 
 complex_image ()
 Constructors.
 
const p_complex< D, G > & domain () const
 Accessors.
 
const metal::vec< D+1,
std::vector< mlc_unbool(V) > > & 
values () const
 Return the array of values associated to the faces.
 

Static Public Attributes

static const unsigned dim = D
 The dimension of the complex.
 

Detailed Description

template<unsigned D, typename G, typename V>
class mln::complex_image< D, G, V >

Image based on a complex.

Values attached to each face of the complex.

Template Parameters
DThe dimension of the complex.
GThe geometry type of the complex.
VThe value type of the image.

Definition at line 164 of file mln/core/image/complex_image.hh.

Member Typedef Documentation

template<unsigned D, typename G, typename V>
typedef G mln::complex_image< D, G, V >::geom

The geometry type of the complex.

Definition at line 172 of file mln/core/image/complex_image.hh.

template<unsigned D, typename G, typename V>
typedef V& mln::complex_image< D, G, V >::lvalue

Return type of read-write access.

Definition at line 177 of file mln/core/image/complex_image.hh.

template<unsigned D, typename G, typename V>
typedef const V& mln::complex_image< D, G, V >::rvalue

Return type of read-only access.

Definition at line 180 of file mln/core/image/complex_image.hh.

template<unsigned D, typename G, typename V>
typedef complex_image< D, tag::psite_<G>, tag::value_<V> > mln::complex_image< D, G, V >::skeleton

Skeleton.

Definition at line 183 of file mln/core/image/complex_image.hh.

template<unsigned D, typename G, typename V>
typedef V mln::complex_image< D, G, V >::value

Value associated type.

Definition at line 174 of file mln/core/image/complex_image.hh.

Constructor & Destructor Documentation

template<unsigned D, typename G , typename V >
complex_image< D, G, V >::complex_image ( )
inline

Constructors.

Definition at line 276 of file mln/core/image/complex_image.hh.

Member Function Documentation

template<unsigned D, typename G , typename V >
const p_complex< D, G > & complex_image< D, G, V >::domain ( ) const
inline

Accessors.

Return the domain of psites od the image.

Definition at line 343 of file mln/core/image/complex_image.hh.

template<unsigned D, typename G, typename V >
complex_image< D, G, V >::rvalue complex_image< D, G, V >::operator() ( const complex_psite< D, G > &  p) const
inline

Read-only access of face value at point site p.

Definition at line 317 of file mln/core/image/complex_image.hh.

References mln::complex_psite< D, G >::face_id(), and mln::complex_psite< D, G >::n().

template<unsigned D, typename G, typename V >
complex_image< D, G, V >::lvalue complex_image< D, G, V >::operator() ( const complex_psite< D, G > &  p)
inline

Read-write access of face value at point site p.

Definition at line 326 of file mln/core/image/complex_image.hh.

References mln::complex_psite< D, G >::face_id(), and mln::complex_psite< D, G >::n().

template<unsigned D, typename G , typename V >
const metal::vec< D+1, std::vector< mlc_unbool(V) > > & complex_image< D, G, V >::values ( ) const
inline

Return the array of values associated to the faces.

Definition at line 335 of file mln/core/image/complex_image.hh.

Member Data Documentation

template<unsigned D, typename G, typename V>
const unsigned mln::complex_image< D, G, V >::dim = D
static

The dimension of the complex.

Definition at line 170 of file mln/core/image/complex_image.hh.