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

Aim: Describes a 1-differentiable function of the form f(x), where x is some real point in the given space, and f(x) is some value. More...

#include <DGtal/shapes/implicit/CImplicitFunctionDiff1.h>

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

Public Types

typedef T::RealPoint RealPoint
 
typedef T::RealVector RealVector
 
- Public Types inherited from DGtal::concepts::CImplicitFunction< T >
typedef T::RealPoint RealPoint
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CImplicitFunctionDiff1)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CImplicitFunction< T >
 BOOST_CONCEPT_ASSERT ((boost::UnaryFunction< T, Value, RealPoint >))
 

Private Attributes

myX
 
RealPoint myA
 
RealVector myB
 

Detailed Description

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

Aim: Describes a 1-differentiable function of the form f(x), where x is some real point in the given space, and f(x) is some value.

Description of concept 'CImplicitFunctionDiff1'

Refinement of CImplicitFunction

Associated types

Notation

Definitions

Valid expressions and

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
gradient operator gradient( a ) RealVector Evaluates the gradient of the function f at point a

Invariants

Models

ImplicitPolynomial3Shape

Notes

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

Definition at line 92 of file CImplicitFunctionDiff1.h.

Member Typedef Documentation

◆ RealPoint

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

Definition at line 97 of file CImplicitFunctionDiff1.h.

◆ RealVector

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

Definition at line 98 of file CImplicitFunctionDiff1.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 100 of file CImplicitFunctionDiff1.h.

101  {
102  // check const methods.
104  }

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

◆ checkConstConstraints()

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

Definition at line 105 of file CImplicitFunctionDiff1.h.

106  {
107  // const method dummyConst should take parameter myA of type A and return
108  // something of type B
109  ConceptUtils::sameType( myB, myX.gradient( myA ) );
110  }

References DGtal::concepts::CImplicitFunctionDiff1< T >::myA, DGtal::concepts::CImplicitFunctionDiff1< T >::myB, DGtal::concepts::CImplicitFunctionDiff1< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Referenced by DGtal::concepts::CImplicitFunctionDiff1< T >::BOOST_CONCEPT_USAGE().

Field Documentation

◆ myA

template<typename T >
RealPoint DGtal::concepts::CImplicitFunctionDiff1< T >::myA
private

◆ myB

template<typename T >
RealVector DGtal::concepts::CImplicitFunctionDiff1< T >::myB
private

◆ myX

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CImplicitFunctionDiff1::myX
T myX
Definition: CImplicitFunctionDiff1.h:113
DGtal::concepts::CImplicitFunctionDiff1::myB
RealVector myB
Definition: CImplicitFunctionDiff1.h:115
DGtal::concepts::CImplicitFunctionDiff1::checkConstConstraints
void checkConstConstraints() const
Definition: CImplicitFunctionDiff1.h:105
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CImplicitFunctionDiff1::myA
RealPoint myA
Definition: CImplicitFunctionDiff1.h:114