BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
ROOT::Math::IBaseFunctionMultiDimTempl< T > Class Template Referenceabstract

Description

template<class T>
class ROOT::Math::IBaseFunctionMultiDimTempl< T >

Documentation for the abstract class IBaseFunctionMultiDim. Interface (abstract class) for generic functions objects of multi-dimension Provides a method to evaluate the function given a vector of coordinate values, by implementing operator() (const double *). In addition it defines the interface for copying functions via the pure virtual method Clone() and the interface for getting the function dimension via the NDim() method. Derived classes must implement the pure private virtual method DoEval(const double *) for the function evaluation in addition to NDim() and Clone().

Definition at line 62 of file IFunction.h.

Inheritance diagram for ROOT::Math::IBaseFunctionMultiDimTempl< T >:
[legend]

Public Types

typedef T BackendType
 
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 

Public Member Functions

 IBaseFunctionMultiDimTempl ()
 
virtual ~IBaseFunctionMultiDimTempl ()
 
virtual IBaseFunctionMultiDimTempl< T > * Clone () const =0
 
virtual unsigned int NDim () const =0
 
operator() (const T *x) const
 

Private Member Functions

virtual T DoEval (const T *x) const =0
 

Member Typedef Documentation

◆ BackendType

template<class T >
typedef T ROOT::Math::IBaseFunctionMultiDimTempl< T >::BackendType

Definition at line 66 of file IFunction.h.

◆ BaseFunc

Definition at line 67 of file IFunction.h.

Constructor & Destructor Documentation

◆ IBaseFunctionMultiDimTempl()

Definition at line 70 of file IFunction.h.

70 {}

◆ ~IBaseFunctionMultiDimTempl()

template<class T >
virtual ROOT::Math::IBaseFunctionMultiDimTempl< T >::~IBaseFunctionMultiDimTempl ( )
inlinevirtual

virtual destructor

Definition at line 75 of file IFunction.h.

75 {}

Member Function Documentation

◆ Clone()

◆ DoEval()

template<class T >
virtual T ROOT::Math::IBaseFunctionMultiDimTempl< T >::DoEval ( const T *  x) const
privatepure virtual

Implementation of the evaluation function. Must be implemented by derived classes

Implemented in ROOT::Math::IParametricGradFunctionMultiDimTempl< T >, and ROOT::Math::IParametricFunctionMultiDimTempl< T >.

Referenced by ROOT::Math::IBaseFunctionMultiDimTempl< T >::operator()().

◆ NDim()

◆ operator()()

template<class T >
T ROOT::Math::IBaseFunctionMultiDimTempl< T >::operator() ( const T *  x) const
inline

Evaluate the function at a point x[]. Use the pure virtual private method DoEval which must be implemented by the sub-classes

Definition at line 92 of file IFunction.h.

93  {
94  return DoEval(x);
95  }
virtual T DoEval(const T *x) const =0

References ROOT::Math::IBaseFunctionMultiDimTempl< T >::DoEval().

Referenced by ROOT::Math::IGradientFunctionMultiDimTempl< T >::FdF().

Here is the call graph for this function:

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