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

Aim: Such object provides a gradient map that associates to each argument some real vector. More...

#include <DGtal/kernel/CWithGradientMap.h>

Public Types

typedef T::Argument Argument
 
typedef T::RealVector RealVector
 
typedef T::GradientMap GradientMap
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((boost::CopyConstructible< GradientMap >))
 
 BOOST_CONCEPT_ASSERT ((CUnaryFunctor< GradientMap, Argument, RealVector >))
 
 BOOST_CONCEPT_USAGE (CWithGradientMap)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
GradientMap myGMap
 

Detailed Description

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

Aim: Such object provides a gradient map that associates to each argument some real vector.

Description of concept 'CWithGradientMap'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

| Name | Expression | Type requirements | Return type | Precondition | Semantics | Post condition | Complexity | |----—|---------—|----------------—|------------—|-----------—|--------—|-------------—|---------—| | Gets the gradient map |x.gradientMap()| |GradientMap | | returns the gradient functor | | | |

Invariants

Models

ImplicitFunctionDiff1LinearCellEmbedder, DigitalSurfaceEmbedderWithNormalVectorEstimator

Notes

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

Definition at line 91 of file CWithGradientMap.h.

Member Typedef Documentation

◆ Argument

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

Definition at line 95 of file CWithGradientMap.h.

◆ GradientMap

template<typename T >
typedef T::GradientMap DGtal::concepts::CWithGradientMap< T >::GradientMap

Definition at line 97 of file CWithGradientMap.h.

◆ RealVector

template<typename T >
typedef T::RealVector DGtal::concepts::CWithGradientMap< T >::RealVector

Definition at line 96 of file CWithGradientMap.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename T >
DGtal::concepts::CWithGradientMap< T >::BOOST_CONCEPT_ASSERT ( (boost::CopyConstructible< GradientMap >)  )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename T >
DGtal::concepts::CWithGradientMap< T >::BOOST_CONCEPT_ASSERT ( (CUnaryFunctor< GradientMap, Argument, RealVector >)  )

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 100 of file CWithGradientMap.h.

101  {
103  }

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

◆ checkConstConstraints()

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

Field Documentation

◆ myGMap

template<typename T >
GradientMap DGtal::concepts::CWithGradientMap< T >::myGMap
private

◆ myX

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CWithGradientMap::myX
T myX
Definition: CWithGradientMap.h:110
DGtal::concepts::CWithGradientMap::myGMap
GradientMap myGMap
Definition: CWithGradientMap.h:111
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CWithGradientMap::checkConstConstraints
void checkConstConstraints() const
Definition: CWithGradientMap.h:104