ROOT::Math::IParametricGradFunctionMultiDim Class Reference

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 223 of file IParamFunction.h.

Public Types
typedef IParametricFunctionMultiDim::BaseFunc	BaseFunc
typedef IGradientFunctionMultiDim	BaseGradFunc
typedef IParametricFunctionMultiDim	BaseParamFunc
Public Types inherited from ROOT::Math::IParametricFunctionMultiDim
typedef IBaseFunctionMultiDim	BaseFunc
Public Types inherited from ROOT::Math::IBaseFunctionMultiDim
typedef IBaseFunctionMultiDim	BaseFunc

Public Member Functions
virtual	~IParametricGradFunctionMultiDim ()
	Virtual Destructor (no operations) More...
double	ParameterDerivative (const double *x, const double *p, unsigned int ipar=0) const
	Evaluate the partial derivative w.r.t a parameter ipar from values and parameters. More...
double	ParameterDerivative (const double *x, unsigned int ipar=0) const
	Evaluate partial derivative using cached parameter values. More...
virtual void	ParameterGradient (const double *x, const double *p, double *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 double *x, double *grad) const
	Evaluate all derivatives using cached parameter values. More...
Public Member Functions inherited from ROOT::Math::IParametricFunctionMultiDim
double	operator() (const double *x, const double *p) const
	Evaluate function at a point x and for given parameters p. More...
Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDim
	IBaseFunctionMultiDim ()
virtual	~IBaseFunctionMultiDim ()
	virtual destructor More...
virtual IBaseFunctionMultiDim *	Clone () const =0
	Clone a function. More...
virtual unsigned int	NDim () const =0
	Retrieve the dimension of the function. More...
double	operator() (const double *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 double	DoParameterDerivative (const double *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::IParametricGradFunctionMultiDim:

Member Typedef Documentation

BaseFunc

typedef IParametricFunctionMultiDim::BaseFunc ROOT::Math::IParametricGradFunctionMultiDim::BaseFunc

Definition at line 232 of file IParamFunction.h.

BaseGradFunc

typedef IGradientFunctionMultiDim ROOT::Math::IParametricGradFunctionMultiDim::BaseGradFunc

Definition at line 231 of file IParamFunction.h.

BaseParamFunc

typedef IParametricFunctionMultiDim ROOT::Math::IParametricGradFunctionMultiDim::BaseParamFunc

Definition at line 230 of file IParamFunction.h.

Constructor & Destructor Documentation

~IParametricGradFunctionMultiDim()

virtual ROOT::Math::IParametricGradFunctionMultiDim::~IParametricGradFunctionMultiDim ( )

inlinevirtual

Virtual Destructor (no operations)

Definition at line 238 of file IParamFunction.h.

Member Function Documentation

DoParameterDerivative()

virtual double ROOT::Math::IParametricGradFunctionMultiDim::DoParameterDerivative ( const double *  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::MultiDimParamGradFunctionAdapter, ROOT::Math::WrappedMultiTF1, and GaussFunction.

ParameterDerivative() [1/2]

double ROOT::Math::IParametricGradFunctionMultiDim::ParameterDerivative ( const double *  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 257 of file IParamFunction.h.

ParameterDerivative() [2/2]

double ROOT::Math::IParametricGradFunctionMultiDim::ParameterDerivative ( const double *  x, unsigned int  ipar = 0  ) const

inline

Evaluate partial derivative using cached parameter values.

Definition at line 270 of file IParamFunction.h.

ParameterGradient() [1/2]

virtual void ROOT::Math::IParametricGradFunctionMultiDim::ParameterGradient ( const double *  x, const double *  p, double *  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::MultiDimParamGradFunctionAdapter, ROOT::Math::WrappedMultiTF1, and GaussFunction.

Definition at line 248 of file IParamFunction.h.

ParameterGradient() [2/2]

void ROOT::Math::IParametricGradFunctionMultiDim::ParameterGradient ( const double *  x, double *  grad  ) const

inline

Evaluate all derivatives using cached parameter values.

Definition at line 264 of file IParamFunction.h.

---

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

• math/mathcore/inc/Math/IParamFunction.h