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 227 of file IParamFunction.h.
Public Types | |
using | BaseFunc = typename IParametricFunctionMultiDimTempl< T >::BaseFunc |
using | BaseGradFunc = IGradientFunctionMultiDimTempl< T > |
using | BaseParamFunc = IParametricFunctionMultiDimTempl< T > |
![]() | |
typedef IBaseFunctionMultiDimTempl< T > | BaseFunc |
![]() | |
typedef T | BackendType |
typedef IBaseFunctionMultiDimTempl< T > | BaseFunc |
Public Member Functions | |
~IParametricGradFunctionMultiDimTempl () override | |
Virtual Destructor (no operations) | |
virtual bool | HasParameterHessian () const |
T | operator() (const T *x) const |
T | operator() (const T *x, const double *p) const |
T | 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. | |
T | ParameterDerivative (const T *x, unsigned int ipar=0) const |
Evaluate partial derivative using cached parameter values. | |
virtual bool | ParameterG2 (const T *, const double *, T *) const |
Evaluate all the second derivatives (diagonal ones) of the function with respect to the parameters at a point x. | |
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. | |
void | ParameterGradient (const T *x, T *grad) const |
Evaluate all derivatives using cached parameter values. | |
virtual bool | ParameterHessian (const T *, const double *, T *) const |
Evaluate the all the Hessian (second derivatives matrix) of the function with respect to the parameters at a point x. | |
![]() | |
T | operator() (const T *x) const |
T | operator() (const T *x, const double *p) const |
Evaluate function at a point x and for given parameters p. | |
![]() | |
virtual | ~IBaseFunctionMultiDimTempl ()=default |
virtual IBaseFunctionMultiDimTempl< T > * | Clone () const =0 |
Clone a function. | |
virtual bool | HasGradient () const |
virtual unsigned int | NDim () const =0 |
Retrieve the dimension of the function. | |
T | operator() (const T *x) const |
Evaluate the function at a point x[]. | |
![]() | |
virtual | ~IBaseParam () |
Virtual Destructor (no operations) | |
virtual unsigned int | NPar () const =0 |
Return the number of Parameters. | |
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, ...") | |
virtual const double * | Parameters () const =0 |
Access the parameter values. | |
virtual void | SetParameters (const double *p)=0 |
Set the parameter values. | |
Private Member Functions | |
T | DoEval (const T *x) const override |
Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values. | |
T | DoEvalPar (const T *x, const double *p) const override=0 |
Implementation of the evaluation function using the x values and the parameters. | |
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. | |
#include <Math/IParamFunction.h>
using ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::BaseFunc = typename IParametricFunctionMultiDimTempl<T>::BaseFunc |
Definition at line 232 of file IParamFunction.h.
using ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::BaseGradFunc = IGradientFunctionMultiDimTempl<T> |
Definition at line 231 of file IParamFunction.h.
using ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::BaseParamFunc = IParametricFunctionMultiDimTempl<T> |
Definition at line 230 of file IParamFunction.h.
|
inlineoverride |
Virtual Destructor (no operations)
Definition at line 238 of file IParamFunction.h.
|
inlineoverrideprivatevirtual |
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 307 of file IParamFunction.h.
|
overrideprivatepure 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 >.
|
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 >.
|
inlinevirtual |
Reimplemented in ROOT::Math::WrappedMultiTF1Templ< T >.
Definition at line 265 of file IParamFunction.h.
|
inline |
Definition at line 248 of file IParamFunction.h.
|
inline |
Definition at line 243 of file IParamFunction.h.
|
inline |
Evaluate the partial derivative w.r.t a parameter ipar from values and parameters.
Definition at line 283 of file IParamFunction.h.
|
inline |
Evaluate partial derivative using cached parameter values.
Definition at line 295 of file IParamFunction.h.
|
inlinevirtual |
Evaluate all the second derivatives (diagonal ones) of the function with respect to the parameters at a point x.
g2 is a vector of dimension npar
Reimplemented in ROOT::Math::WrappedMultiTF1Templ< T >.
Definition at line 278 of file IParamFunction.h.
|
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 257 of file IParamFunction.h.
|
inline |
Evaluate all derivatives using cached parameter values.
Definition at line 291 of file IParamFunction.h.
|
inlinevirtual |
Evaluate the all the Hessian (second derivatives matrix) of the function with respect to the parameters at a point x.
It is optional to be implemented by the derived classes if needed. If it is not implemented return a false. h must be dimensioned as a n x (n+1)/2 matrix (since it is a symmetric matrix)
Reimplemented in ROOT::Math::WrappedMultiTF1Templ< T >.
Definition at line 272 of file IParamFunction.h.