DGtal  1.1.0
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CSCellEmbedder< T > Struct Template Reference

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

#include <DGtal/topology/CSCellEmbedder.h>

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

Public Types

typedef T::KSpace KSpace
 
typedef T::SCell SCell
 
typedef T::RealPoint RealPoint
 
typedef T::Argument Argument
 
typedef T::Value Value
 

Public Member Functions

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

Private Attributes

myX
 
SCell myP
 
RealPoint myRP
 
const KSpace myK
 

Detailed Description

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

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

Description of concept 'CSCellEmbedder'

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
Khalimsky space x.space()) const KSpace & return a reference to the the Kalimsky space

Invariants

Models

Notes

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

Definition at line 97 of file CSCellEmbedder.h.

Member Typedef Documentation

◆ Argument

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

Definition at line 104 of file CSCellEmbedder.h.

◆ KSpace

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

Definition at line 101 of file CSCellEmbedder.h.

◆ RealPoint

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

Definition at line 103 of file CSCellEmbedder.h.

◆ SCell

template<typename T >
typedef T::SCell DGtal::concepts::CSCellEmbedder< T >::SCell

Definition at line 102 of file CSCellEmbedder.h.

◆ Value

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

Definition at line 105 of file CSCellEmbedder.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

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

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 111 of file CSCellEmbedder.h.

112  {
114  }

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

◆ BOOST_STATIC_ASSERT() [1/3]

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

◆ BOOST_STATIC_ASSERT() [2/3]

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

◆ BOOST_STATIC_ASSERT() [3/3]

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

◆ checkConstConstraints()

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

Field Documentation

◆ myK

template<typename T >
const KSpace DGtal::concepts::CSCellEmbedder< T >::myK
private

◆ myP

template<typename T >
SCell DGtal::concepts::CSCellEmbedder< T >::myP
private

◆ myRP

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

◆ myX

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CSCellEmbedder::myX
T myX
Definition: CSCellEmbedder.h:123
DGtal::concepts::CSCellEmbedder::myP
SCell myP
Definition: CSCellEmbedder.h:124
DGtal::concepts::CSCellEmbedder::checkConstConstraints
void checkConstConstraints() const
Definition: CSCellEmbedder.h:116
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CSCellEmbedder::myRP
RealPoint myRP
Definition: CSCellEmbedder.h:125
DGtal::concepts::CSCellEmbedder::myK
const KSpace myK
Definition: CSCellEmbedder.h:126