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

#include <DGtal/kernel/CWithGradientMap.h>

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

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

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

Definition at line 95 of file CWithGradientMap.h.

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

Definition at line 97 of file CWithGradientMap.h.

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

Definition at line 96 of file CWithGradientMap.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CWithGradientMap< T >::BOOST_CONCEPT_ASSERT ( (boost::CopyConstructible< GradientMap >)  )
template<typename T >
DGtal::concepts::CWithGradientMap< T >::BOOST_CONCEPT_ASSERT ( (CUnaryFunctor< GradientMap, Argument, RealVector >)  )
template<typename T >
DGtal::concepts::CWithGradientMap< T >::BOOST_CONCEPT_USAGE ( CWithGradientMap< T >  )
inline
template<typename T >
void DGtal::concepts::CWithGradientMap< T >::checkConstConstraints ( ) const
inline

Field Documentation

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

The documentation for this struct was generated from the following file: