DGtal  1.3.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CCellEmbedder< T > Struct Template Reference

Aim: A cell embedder is a mapping from unsigned cells to Euclidean points. It adds inner types to functor. More...

#include <DGtal/topology/CCellEmbedder.h>

Inheritance diagram for DGtal::concepts::CCellEmbedder< T >:
[legend]

Public Types

typedef T::KSpace KSpace
 
typedef T::Cell Cell
 
typedef T::RealPoint RealPoint
 
typedef T::Argument Argument
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CCellularGridSpaceND< KSpace >))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Cell, typename KSpace::Cell >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Cell, Argument >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< RealPoint, Value >::value))
 
 BOOST_CONCEPT_USAGE (CCellEmbedder)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< T, T::Cell, T::RealPoint >
 BOOST_CONCEPT_USAGE (CUnaryFunctor)
 

Private Attributes

myX
 
Cell myP
 
RealPoint myRP
 

Detailed Description

template<typename T>
struct DGtal::concepts::CCellEmbedder< T >

Aim: A cell embedder is a mapping from unsigned cells to Euclidean points. It adds inner types to functor.

Description of concept 'CCellEmbedder'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Apply function x(p) Value return the value of the function x on argument p

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CCellEmbedder.

Definition at line 96 of file CCellEmbedder.h.

Member Typedef Documentation

◆ Argument

template<typename T >
typedef T::Argument DGtal::concepts::CCellEmbedder< T >::Argument

Definition at line 103 of file CCellEmbedder.h.

◆ Cell

template<typename T >
typedef T::Cell DGtal::concepts::CCellEmbedder< T >::Cell

Definition at line 101 of file CCellEmbedder.h.

◆ KSpace

template<typename T >
typedef T::KSpace DGtal::concepts::CCellEmbedder< T >::KSpace

Definition at line 100 of file CCellEmbedder.h.

◆ RealPoint

template<typename T >
typedef T::RealPoint DGtal::concepts::CCellEmbedder< T >::RealPoint

Definition at line 102 of file CCellEmbedder.h.

◆ Value

template<typename T >
typedef T::Value DGtal::concepts::CCellEmbedder< T >::Value

Definition at line 104 of file CCellEmbedder.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T >
DGtal::concepts::CCellEmbedder< T >::BOOST_CONCEPT_ASSERT ( (CCellularGridSpaceND< KSpace >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CCellEmbedder< T >::BOOST_CONCEPT_USAGE ( CCellEmbedder< T >  )
inline

Definition at line 110 of file CCellEmbedder.h.

111  {
113  }

References DGtal::concepts::CCellEmbedder< T >::checkConstConstraints().

◆ BOOST_STATIC_ASSERT() [1/3]

template<typename T >
DGtal::concepts::CCellEmbedder< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Cell, Argument >::value)  )

◆ BOOST_STATIC_ASSERT() [2/3]

template<typename T >
DGtal::concepts::CCellEmbedder< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Cell, typename KSpace::Cell >::value)  )

◆ BOOST_STATIC_ASSERT() [3/3]

template<typename T >
DGtal::concepts::CCellEmbedder< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< RealPoint, Value >::value)  )

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CCellEmbedder< T >::checkConstConstraints ( ) const
inline

Field Documentation

◆ myP

template<typename T >
Cell DGtal::concepts::CCellEmbedder< T >::myP
private

◆ myRP

template<typename T >
RealPoint DGtal::concepts::CCellEmbedder< T >::myRP
private

◆ myX

template<typename T >
T DGtal::concepts::CCellEmbedder< T >::myX
private

The documentation for this struct was generated from the following file:
DGtal::concepts::CCellEmbedder::checkConstConstraints
void checkConstConstraints() const
Definition: CCellEmbedder.h:115
DGtal::concepts::CCellEmbedder::myP
Cell myP
Definition: CCellEmbedder.h:122
DGtal::concepts::CCellEmbedder::myRP
RealPoint myRP
Definition: CCellEmbedder.h:123
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CCellEmbedder::myX
T myX
Definition: CCellEmbedder.h:121