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

Aim: A point embedder is a mapping from digital points to Euclidean points. It adds inner types to functor. More...

#include <DGtal/kernel/CPointEmbedder.h>

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

Public Types

typedef T::Space Space
 
typedef T::Point Point
 
typedef T::RealPoint RealPoint
 
typedef T::Argument Argument
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CSpace< Space >))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Point, typename Space::Point >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Point, Argument >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< RealPoint, typename Space::RealPoint >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< RealPoint, Value >::value))
 
 BOOST_CONCEPT_USAGE (CPointEmbedder)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< T, T::Point, T::RealPoint >
 BOOST_CONCEPT_USAGE (CUnaryFunctor)
 

Private Attributes

myX
 
Point myP
 
RealPoint myRP
 

Detailed Description

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

Aim: A point embedder is a mapping from digital points to Euclidean points. It adds inner types to functor.

Description of concept 'CPointEmbedder'

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 CPointEmbedder.

Definition at line 95 of file CPointEmbedder.h.

Member Typedef Documentation

◆ Argument

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

Definition at line 102 of file CPointEmbedder.h.

◆ Point

template<typename T >
typedef T::Point DGtal::concepts::CPointEmbedder< T >::Point

Definition at line 100 of file CPointEmbedder.h.

◆ RealPoint

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

Definition at line 101 of file CPointEmbedder.h.

◆ Space

template<typename T >
typedef T::Space DGtal::concepts::CPointEmbedder< T >::Space

Definition at line 99 of file CPointEmbedder.h.

◆ Value

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

Definition at line 103 of file CPointEmbedder.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T >
DGtal::concepts::CPointEmbedder< T >::BOOST_CONCEPT_ASSERT ( (CSpace< Space >)  )

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 110 of file CPointEmbedder.h.

111  {
113  }

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

◆ BOOST_STATIC_ASSERT() [1/4]

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

◆ BOOST_STATIC_ASSERT() [2/4]

template<typename T >
DGtal::concepts::CPointEmbedder< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Point, typename Space::Point >::value)  )

◆ BOOST_STATIC_ASSERT() [3/4]

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

◆ BOOST_STATIC_ASSERT() [4/4]

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

◆ checkConstConstraints()

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

Field Documentation

◆ myP

template<typename T >
Point DGtal::concepts::CPointEmbedder< T >::myP
private

◆ myRP

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

◆ myX

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

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