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

Public Types
typedef IParametricFunctionOneDim::BaseFunc	BaseFunc
typedef IGradientFunctionOneDim	BaseGradFunc
typedef IParametricFunctionOneDim	BaseParamFunc

Public Member Functions
	~IParametricGradFunctionOneDim () override
	Virtual Destructor (no operations).
virtual IBaseFunctionOneDim *	Clone () const =0
	Clone a function.
double	Derivative (const double *x) const
	Compatibility method with multi-dimensional interface for partial derivative.
double	Derivative (double x) const
	Return the derivative of the function at a point x Use the private method DoDerivative.
void	FdF (const double x, double &f, double df) const
	Compatibility method with multi-dimensional interface for Gradient and function evaluation.
virtual void	FdF (double x, double &f, double &df) const
	Optimized method to evaluate at the same time the function value and derivative at a point x.
void	Gradient (const double x, double g) const
	Compatibility method with multi-dimensional interface for Gradient.
virtual bool	HasGradient () const
virtual unsigned int	NPar () const =0
	Return the number of Parameters.
double	operator() (const double *x) const
	Evaluate the function at a point x[].
double	operator() (const double x, const double p) const
	multidim-like interface
double	operator() (double x) const
	Evaluate the function at a point x.
double	operator() (double x, const double *p) const
	Evaluate function at a point x and for given parameters p.
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.
double	ParameterDerivative (const double *x, unsigned int ipar=0) const
	Evaluate partial derivative using cached parameter values (multi-dim like interface).
double	ParameterDerivative (double x, const double *p, unsigned int ipar=0) const
	Partial derivative with respect a parameter.
double	ParameterDerivative (double x, unsigned int ipar=0) const
	Evaluate partial derivative using cached parameter values.
void	ParameterGradient (const double x, const double p, double *grad) const
	Compatibility interface with multi-dimensional functions.
void	ParameterGradient (const double x, double grad) const
	Evaluate all derivatives using cached parameter values (multi-dim like interface).
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.
void	ParameterGradient (double x, double *grad) const
	Evaluate all derivatives using cached parameter values.
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
double	DoEval (double x) const override
	Implement the ROOT::Math::IBaseFunctionOneDim interface DoEval(x) using the cached parameter values.
virtual double	DoEvalPar (double x, const double *p) const =0
	Implementation of the evaluation function using the x value and the parameters.
virtual double	DoParameterDerivative (double x, const double *p, unsigned int ipar) const =0
	Evaluate the gradient, to be implemented by the derived classes.

#include <Math/IParamFunction.h>

Inheritance diagram for ROOT::Math::IParametricGradFunctionOneDim:

Member Typedef Documentation

◆ BaseFunc

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

Definition at line 336 of file IParamFunction.h.

◆ BaseGradFunc

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

Definition at line 335 of file IParamFunction.h.

◆ BaseParamFunc

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

Definition at line 334 of file IParamFunction.h.

Constructor & Destructor Documentation

◆ ~IParametricGradFunctionOneDim()

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

inlineoverride

Virtual Destructor (no operations).

Definition at line 342 of file IParamFunction.h.

Member Function Documentation

◆ Clone()

virtual IBaseFunctionOneDim * ROOT::Math::IBaseFunctionOneDim::Clone ( ) const

pure virtualinherited

Clone a function.

Each derived class will implement their version of the private DoClone method.

Implemented in RooStats::PosteriorCdfFunction, RooStats::PosteriorFunction, RooStats::PosteriorFunctionFromToyMC, ROOT::Math::CDFWrapper, ROOT::Math::Functor1D, ROOT::Math::GradFunctor1D, ROOT::Math::IntegrandTransform, ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >, ROOT::Math::PDFIntegral, ROOT::Math::Polynomial, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, ROOT::Math::WrappedFunction< Func >, ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >, ROOT::Math::WrappedTF1, and TF1_EvalWrapper.

◆ Derivative() [1/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( const double * x ) const

inlineinherited

Compatibility method with multi-dimensional interface for partial derivative.

Definition at line 186 of file IFunction.h.

◆ Derivative() [2/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( double x ) const

inlineinherited

Return the derivative of the function at a point x Use the private method DoDerivative.

Definition at line 183 of file IFunction.h.

◆ DoEval()

double ROOT::Math::IParametricFunctionOneDim::DoEval ( double x ) const

inlineoverrideprivatevirtualinherited

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

Implements ROOT::Math::IBaseFunctionOneDim.

Reimplemented in ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, and ROOT::Math::WrappedTF1.

Definition at line 203 of file IParamFunction.h.

◆ DoEvalPar()

virtual double ROOT::Math::IParametricFunctionOneDim::DoEvalPar	(	double	x,
		const double *	p ) const

privatepure virtualinherited

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

Must be implemented by derived classes

Implemented in ROOT::Math::Polynomial, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, and ROOT::Math::WrappedTF1.

◆ 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::Polynomial, and ROOT::Math::WrappedTF1.

◆ FdF() [1/2]

void ROOT::Math::IBaseFunctionOneDim::FdF	(	const double *	x,
		double &	f,
		double *	df ) const

inlineinherited

Compatibility method with multi-dimensional interface for Gradient and function evaluation.

Definition at line 202 of file IFunction.h.

◆ FdF() [2/2]

virtual void ROOT::Math::IBaseFunctionOneDim::FdF	(	double	x,
		double &	f,
		double &	df ) const

inlinevirtualinherited

Optimized method to evaluate at the same time the function value and derivative at a point x.

Often both value and derivatives are needed and it is often more efficient to compute them at the same time. Derived class should implement this method if performances play an important role and if it is faster to evaluate value and derivative at the same time.

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

Definition at line 195 of file IFunction.h.

◆ Gradient()

void ROOT::Math::IBaseFunctionOneDim::Gradient	(	const double *	x,
		double *	g ) const

inlineinherited

Compatibility method with multi-dimensional interface for Gradient.

Definition at line 189 of file IFunction.h.

◆ HasGradient()

virtual bool ROOT::Math::IBaseFunctionOneDim::HasGradient ( ) const

inlinevirtualinherited

Reimplemented in ROOT::Math::IGradientFunctionOneDim.

Definition at line 179 of file IFunction.h.

◆ NPar()

virtual unsigned int ROOT::Math::IBaseParam::NPar ( ) const

pure virtualinherited

Return the number of Parameters.

Implemented in ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::MultiDimParamGradFunctionAdapter, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, ROOT::Math::WrappedMultiTF1Templ< T >, ROOT::Math::WrappedMultiTF1Templ< double >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedTF1.

◆ operator()() [1/4]

double ROOT::Math::IBaseFunctionOneDim::operator() ( const double * x ) const

inline

Evaluate the function at a point x[].

Compatible method with multi-dimensional functions.

Definition at line 169 of file IFunction.h.

◆ operator()() [2/4]

double ROOT::Math::IParametricFunctionOneDim::operator()	(	const double *	x,
		const double *	p ) const

inline

multidim-like interface

Definition at line 187 of file IParamFunction.h.

◆ operator()() [3/4]

double ROOT::Math::IBaseFunctionOneDim::operator() ( double x ) const

inline

Evaluate the function at a point x.

Use the a pure virtual private method DoEval which must be implemented by sub-classes.

Definition at line 169 of file IFunction.h.

◆ operator()() [4/4]

double ROOT::Math::IParametricFunctionOneDim::operator()	(	double	x,
		const double *	p ) const

inline

Evaluate function at a point x and for given parameters p.

This method does not change the internal status of the function (internal parameter values). If for some reason one prefers caching the parameter values, SetParameters(p) and then operator()(x) should be called. Use the pure virtual function DoEvalPar to implement it

Definition at line 178 of file IParamFunction.h.

◆ 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 403 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 412 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 386 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 394 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 369 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 377 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 351 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 361 of file IParamFunction.h.

◆ ParameterName()

virtual std::string ROOT::Math::IBaseParam::ParameterName ( unsigned int i ) const

inlinevirtualinherited

Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...").

Reimplemented in ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, ROOT::Math::WrappedMultiTF1Templ< T >, ROOT::Math::WrappedMultiTF1Templ< double >, and ROOT::Math::WrappedTF1.

Definition at line 86 of file IParamFunction.h.

◆ Parameters()

virtual const double * ROOT::Math::IBaseParam::Parameters ( ) const

pure virtualinherited

Access the parameter values.

Implemented in ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::MultiDimParamGradFunctionAdapter, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, ROOT::Math::WrappedMultiTF1Templ< T >, ROOT::Math::WrappedMultiTF1Templ< double >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedTF1.

◆ SetParameters()

virtual void ROOT::Math::IBaseParam::SetParameters ( const double * p )

pure virtualinherited

Set the parameter values.

Parameters

p	vector of doubles containing the parameter values.

to be defined: can user change number of params ? At the moment no.

Implemented in ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::MultiDimParamGradFunctionAdapter, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, ROOT::Math::WrappedMultiTF1Templ< T >, ROOT::Math::WrappedMultiTF1Templ< double >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedTF1.

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

math/mathcore/inc/Math/IParamFunction.h

Public Types

Public Member Functions

Private Member Functions

Member Typedef Documentation

◆ BaseFunc

◆ BaseGradFunc

◆ BaseParamFunc

Constructor & Destructor Documentation

◆ ~IParametricGradFunctionOneDim()

Member Function Documentation

◆ Clone()

◆ Derivative() [1/2]

◆ Derivative() [2/2]

◆ DoEval()

◆ DoEvalPar()

◆ DoParameterDerivative()

◆ FdF() [1/2]

◆ FdF() [2/2]

◆ Gradient()

◆ HasGradient()

◆ NPar()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ ParameterDerivative() [1/4]

◆ ParameterDerivative() [2/4]

◆ ParameterDerivative() [3/4]

◆ ParameterDerivative() [4/4]

◆ ParameterGradient() [1/4]

◆ ParameterGradient() [2/4]

◆ ParameterGradient() [3/4]

◆ ParameterGradient() [4/4]

◆ ParameterName()

◆ Parameters()

◆ SetParameters()