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

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

Inheritance diagram for DGtal::concepts::CImplicitFunctionDiff1< T >:
[legend]
Collaboration 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

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

Definition at line 97 of file CImplicitFunctionDiff1.h.

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

Definition at line 98 of file CImplicitFunctionDiff1.h.

Member Function Documentation

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

Definition at line 100 of file CImplicitFunctionDiff1.h.

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

101  {
102  // check const methods.
104  }
template<typename T >
void DGtal::concepts::CImplicitFunctionDiff1< T >::checkConstConstraints ( ) const
inline

Field Documentation

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

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