h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

UnaryFunction1D Class Template Reference

#include <Functions1D.h>

Inheritance diagram for UnaryFunction1D:

CurveNatureF1D List of all members.

Detailed Description

template<class T>
class UnaryFunction1D< T >

Base class for Unary Functions (functors) working on Interface1D. A unary function will be used by calling its operator() on an Interface1D.
Attention:
In the scripting language, there exists several prototypes depending on the returned value type. For example, you would inherit from a UnaryFunction1DDouble if you wish to define a function that returns a double. The different existing prototypes are:
  • UnaryFunction1DVoid
  • UnaryFunction1DUnsigned
  • UnaryFunction1DReal
  • UnaryFunction1DFloat
  • UnaryFunction1DDouble
  • UnaryFunction1DVec2f
  • UnaryFunction1DVec3f


Public Types

typedef T ReturnedValueType

Public Member Functions

 UnaryFunction1D ()
 UnaryFunction1D (IntegrationType iType)
virtual ~UnaryFunction1D ()
virtual string getName () const
virtual T operator() (Interface1D &inter)
void setIntegrationType (IntegrationType integration)
IntegrationType getIntegrationType () const

Member Typedef Documentation

typedef T ReturnedValueType

The type of the value returned by the functor.


Constructor & Destructor Documentation

UnaryFunction1D (  )  [inline]

Default constructor

UnaryFunction1D ( IntegrationType  iType  )  [inline]

Builds a UnaryFunction1D from an integration type.

Parameters:
iType In case the result for the Interface1D would be obtained by evaluating a 0D function over the different Interface0D of the Interface1D, iType tells which integration method to use. The default integration method is the MEAN.

virtual ~UnaryFunction1D (  )  [inline, virtual]

destructor.


Member Function Documentation

virtual string getName (  )  const [inline, virtual]

virtual T operator() ( Interface1D inter  )  [inline, virtual]

void setIntegrationType ( IntegrationType  integration  )  [inline]

Sets the integration method

IntegrationType getIntegrationType (  )  const [inline]

Returns the integration method.


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