DGtal  1.5.beta
DGtal::concepts::CImplicitFunction< T > Struct Template Reference

Aim: Describes any 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/CImplicitFunction.h>

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

Public Types

typedef T::RealPoint RealPoint
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((boost::UnaryFunction< T, Value, RealPoint >))
 

Detailed Description

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

Aim: Describes any 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 'CImplicitFunction'

Associated types

  • RealPoint: the type for the domain
  • Value: the type for the range

Notation

  • X : A type that is a model of CImplicitFunction
  • f : objet of type X
  • a : objet of type RealPoint

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Function call f( a ) Value Evaluates the function f at point a

Invariants

Models

ImplicitBall, ImplicitPolynomial3Shape, ImplicitHyperCube, ImplicitRoundedHyperCube, ImplicitNorm1Ball

Notes

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

Definition at line 89 of file CImplicitFunction.h.

Member Typedef Documentation

◆ RealPoint

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

Definition at line 94 of file CImplicitFunction.h.

◆ Value

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

Definition at line 95 of file CImplicitFunction.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T >
DGtal::concepts::CImplicitFunction< T >::BOOST_CONCEPT_ASSERT ( (boost::UnaryFunction< T, Value, RealPoint >)  )

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