ROOT::Math::IParametricGradFunctionOneDim Class Reference

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

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

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

Public Types
typedef IParametricFunctionOneDim::BaseFunc	BaseFunc
typedef IGradientFunctionOneDim	BaseGradFunc
typedef IParametricFunctionOneDim	BaseParamFunc
Public Types inherited from ROOT::Math::IParametricFunctionOneDim
typedef IBaseFunctionOneDim	BaseFunc
Public Types inherited from ROOT::Math::IBaseFunctionOneDim
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
virtual	~IParametricGradFunctionOneDim ()
	Virtual Destructor (no operations) More...
double	ParameterDerivative (const double *x, const double *p, unsigned int ipar=0) const
	Partial derivative with respect a parameter Compatibility interface with multi-dimensional functions. More...
double	ParameterDerivative (const double *x, unsigned int ipar=0) const
	Evaluate partial derivative using cached parameter values (multi-dim like interface) More...
double	ParameterDerivative (double x, const double *p, unsigned int ipar=0) const
	Partial derivative with respect a parameter. More...
double	ParameterDerivative (double x, unsigned int ipar=0) const
	Evaluate partial derivative using cached parameter values. More...
void	ParameterGradient (const double *x, const double *p, double *grad) const
	Compatibility interface with multi-dimensional functions. More...
void	ParameterGradient (const double *x, double *grad) const
	Evaluate all derivatives using cached parameter values (multi-dim like interface) More...
virtual void	ParameterGradient (double x, const double *p, double *grad) const
	Evaluate the derivatives of the function with respect to the parameters at a point x. More...
void	ParameterGradient (double x, double *grad) const
	Evaluate all derivatives using cached parameter values. More...
Public Member Functions inherited from ROOT::Math::IParametricFunctionOneDim
double	operator() (const double *x, const double *p) const
	multidim-like interface More...
double	operator() (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::IBaseFunctionOneDim
	IBaseFunctionOneDim ()
virtual	~IBaseFunctionOneDim ()
	virtual destructor More...
virtual IBaseFunctionOneDim *	Clone () const =0
	Clone a function. More...
double	operator() (const double *x) const
	Evaluate the function at a point x[]. More...
double	operator() (double x) const
	Evaluate the function at a point x Use the a pure virtual private method DoEval which must be implemented by sub-classes. 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 (double x, const double *p, unsigned int ipar) const =0
	Evaluate the gradient, to be implemented by the derived classes. More...

#include <Math/IParamFunction.h>

Inheritance diagram for ROOT::Math::IParametricGradFunctionOneDim:

Member Typedef Documentation

BaseFunc

typedef IParametricFunctionOneDim::BaseFunc ROOT::Math::IParametricGradFunctionOneDim::BaseFunc

Definition at line 317 of file IParamFunction.h.

BaseGradFunc

typedef IGradientFunctionOneDim ROOT::Math::IParametricGradFunctionOneDim::BaseGradFunc

Definition at line 316 of file IParamFunction.h.

BaseParamFunc

typedef IParametricFunctionOneDim ROOT::Math::IParametricGradFunctionOneDim::BaseParamFunc

Definition at line 315 of file IParamFunction.h.

Constructor & Destructor Documentation

~IParametricGradFunctionOneDim()

virtual ROOT::Math::IParametricGradFunctionOneDim::~IParametricGradFunctionOneDim ( )

inlinevirtual

Virtual Destructor (no operations)

Definition at line 323 of file IParamFunction.h.

Member Function Documentation

DoParameterDerivative()

virtual double ROOT::Math::IParametricGradFunctionOneDim::DoParameterDerivative ( double  x, const double *  p, unsigned int  ipar  ) const

privatepure virtual

Evaluate the gradient, to be implemented by the derived classes.

Implemented in ROOT::Math::WrappedTF1, and ROOT::Math::Polynomial.

ParameterDerivative() [1/4]

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

inline

Partial derivative with respect a parameter Compatibility interface with multi-dimensional functions.

Definition at line 384 of file IParamFunction.h.

ParameterDerivative() [2/4]

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

inline

Evaluate partial derivative using cached parameter values (multi-dim like interface)

Definition at line 393 of file IParamFunction.h.

ParameterDerivative() [3/4]

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

inline

Partial derivative with respect a parameter.

Definition at line 367 of file IParamFunction.h.

ParameterDerivative() [4/4]

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

inline

Evaluate partial derivative using cached parameter values.

Definition at line 375 of file IParamFunction.h.

ParameterGradient() [1/4]

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

inline

Compatibility interface with multi-dimensional functions.

Definition at line 350 of file IParamFunction.h.

ParameterGradient() [2/4]

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

inline

Evaluate all derivatives using cached parameter values (multi-dim like interface)

Definition at line 358 of file IParamFunction.h.

ParameterGradient() [3/4]

virtual void ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient ( double  x, const double *  p, double *  grad  ) const

inlinevirtual

Evaluate the derivatives 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 if needed

Reimplemented in ROOT::Math::WrappedTF1.

Definition at line 332 of file IParamFunction.h.

ParameterGradient() [4/4]

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

inline

Evaluate all derivatives using cached parameter values.

Definition at line 342 of file IParamFunction.h.

Libraries for ROOT::Math::IParametricGradFunctionOneDim:

[legend]