Logo ROOT   6.19/01
Reference Guide
ROOT::Math::IParametricGradFunctionMultiDimTempl< T > Class Template Referenceabstract

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

Interface (abstract class) for parametric gradient multi-dimensional functions providing in addition to function evaluation with respect to the coordinates also the gradient with respect to the parameters, via the method ParameterGradient.

It is a derived class from ROOT::Math::IParametricFunctionMultiDim.

The pure private virtual method DoParameterGradient must be implemented by the derived classes in addition to those inherited by the base abstract classes.

Definition at line 224 of file IParamFunction.h.

Public Types

using BaseFunc = typename IParametricFunctionMultiDimTempl< T >::BaseFunc
 
using BaseGradFunc = IGradientFunctionMultiDimTempl< T >
 
using BaseParamFunc = IParametricFunctionMultiDimTempl< T >
 
- Public Types inherited from ROOT::Math::IParametricFunctionMultiDimTempl< T >
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 
- Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
typedef T BackendType
 
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 

Public Member Functions

virtual ~IParametricGradFunctionMultiDimTempl ()
 Virtual Destructor (no operations) More...
 
operator() (const T *x, const double *p) const
 
operator() (const T *x) const
 
ParameterDerivative (const T *x, const double *p, unsigned int ipar=0) const
 Evaluate the partial derivative w.r.t a parameter ipar from values and parameters. More...
 
ParameterDerivative (const T *x, unsigned int ipar=0) const
 Evaluate partial derivative using cached parameter values. More...
 
virtual void ParameterGradient (const T *x, const double *p, T *grad) const
 Evaluate the all the derivatives (gradient vector) of the function with respect to the parameters at a point x. More...
 
void ParameterGradient (const T *x, T *grad) const
 Evaluate all derivatives using cached parameter values. More...
 
- Public Member Functions inherited from ROOT::Math::IParametricFunctionMultiDimTempl< T >
operator() (const T *x, const double *p) const
 
Evaluate function at a point x and for given parameters p. More...
 
operator() (const T *x) const
 
- Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
 IBaseFunctionMultiDimTempl ()
 
virtual ~IBaseFunctionMultiDimTempl ()
 virtual destructor More...
 
virtual IBaseFunctionMultiDimTempl< T > * Clone () const =0
 Clone a function. More...
 
virtual unsigned int NDim () const =0
 Retrieve the dimension of the function. More...
 
operator() (const T *x) const
 Evaluate the function at a point x[]. More...
 
- Public Member Functions inherited from ROOT::Math::IBaseParam
virtual ~IBaseParam ()
 Virtual Destructor (no operations) More...
 
virtual unsigned int NPar () const =0
 Return the number of Parameters. More...
 
virtual std::string ParameterName (unsigned int i) const
 Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...") More...
 
virtual const double * Parameters () const =0
 Access the parameter values. More...
 
virtual void SetParameters (const double *p)=0
 Set the parameter values. More...
 

Private Member Functions

virtual T DoEval (const T *x) const
 Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values. More...
 
virtual T DoEvalPar (const T *x, const double *p) const =0
 Implementation of the evaluation function using the x values and the parameters. More...
 
virtual T DoParameterDerivative (const T *x, const double *p, unsigned int ipar) const =0
 Evaluate the partial derivative w.r.t a parameter ipar , to be implemented by the derived classes. More...
 

#include <Math/IParamFunction.h>

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

Member Typedef Documentation

◆ BaseFunc

Definition at line 229 of file IParamFunction.h.

◆ BaseGradFunc

◆ BaseParamFunc

Constructor & Destructor Documentation

◆ ~IParametricGradFunctionMultiDimTempl()

Virtual Destructor (no operations)

Definition at line 235 of file IParamFunction.h.

Member Function Documentation

◆ DoEval()

template<class T>
virtual T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::DoEval ( const T *  x) const
inlineprivatevirtual

Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values.

Reimplemented from ROOT::Math::IParametricFunctionMultiDimTempl< T >.

Reimplemented in ROOT::Math::WrappedMultiTF1Templ< T >.

Definition at line 288 of file IParamFunction.h.

◆ DoEvalPar()

template<class T>
virtual T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::DoEvalPar ( const T *  x,
const double *  p 
) const
privatepure virtual

Implementation of the evaluation function using the x values and the parameters.

Must be implemented by derived classes

Implements ROOT::Math::IParametricFunctionMultiDimTempl< T >.

Implemented in ROOT::Math::WrappedMultiTF1Templ< T >.

◆ DoParameterDerivative()

template<class T>
virtual T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::DoParameterDerivative ( const T *  x,
const double *  p,
unsigned int  ipar 
) const
privatepure virtual

Evaluate the partial derivative w.r.t a parameter ipar , to be implemented by the derived classes.

Implemented in ROOT::Math::WrappedMultiTF1Templ< T >.

◆ operator()() [1/2]

template<class T>
T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::operator() ( const T *  x,
const double *  p 
) const
inline

Definition at line 240 of file IParamFunction.h.

◆ operator()() [2/2]

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

Definition at line 245 of file IParamFunction.h.

◆ ParameterDerivative() [1/2]

template<class T>
T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterDerivative ( const T *  x,
const double *  p,
unsigned int  ipar = 0 
) const
inline

Evaluate the partial derivative w.r.t a parameter ipar from values and parameters.

Definition at line 264 of file IParamFunction.h.

◆ ParameterDerivative() [2/2]

template<class T>
T ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterDerivative ( const T *  x,
unsigned int  ipar = 0 
) const
inline

Evaluate partial derivative using cached parameter values.

Definition at line 276 of file IParamFunction.h.

◆ ParameterGradient() [1/2]

template<class T>
virtual void ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterGradient ( const T *  x,
const double *  p,
T *  grad 
) const
inlinevirtual

Evaluate the all the derivatives (gradient vector) of the function with respect to the parameters at a point x.

It is optional to be implemented by the derived classes for better efficiency

Reimplemented in ROOT::Math::WrappedMultiTF1Templ< T >.

Definition at line 254 of file IParamFunction.h.

◆ ParameterGradient() [2/2]

template<class T>
void ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterGradient ( const T *  x,
T *  grad 
) const
inline

Evaluate all derivatives using cached parameter values.

Definition at line 272 of file IParamFunction.h.


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