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

Class to Wrap a ROOT Function class (like TF1) in a IParamMultiFunction interface of multi-dimensions to be used in the ROOT::Math numerical algorithm.

This wrapper class does not own the TF1 pointer, so it assumes it exists during the wrapper lifetime. The class copy the TF1 pointer only when it owns it.

The class from ROOT version 6.03 does not contain anymore a copy of the parameters. The parameters are stored in the TF1 class.

Definition at line 48 of file WrappedMultiTF1.h.

Public Types
typedef ROOT::Math::IParametricFunctionMultiDimTempl< T >::BaseFunc	BaseFunc

typedef ROOT::Math::IParametricGradFunctionMultiDimTempl< T >	BaseParamFunc

Public Types inherited from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >
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
	WrappedMultiTF1Templ (const WrappedMultiTF1Templ< T > &rhs)
	Copy constructor.

	WrappedMultiTF1Templ (TF1 &f, unsigned int dim=0)
	constructor from a function pointer to a TF1 If dim = 0 dimension is taken from TF1::GetNdim().

	~WrappedMultiTF1Templ () override
	Destructor (no operations).

WrappedMultiTF1Templ &	operator= (const WrappedMultiTF1Templ< T > &rhs)
	Assignment operator.

Public Member Functions inherited from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >
	~IParametricGradFunctionMultiDimTempl () override
	Virtual Destructor (no operations)

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.

void	ParameterGradient (const T x, T grad) const
	Evaluate all derivatives using cached parameter values.

Public Member Functions inherited from ROOT::Math::IParametricFunctionMultiDimTempl< T >
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.

Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
virtual	~IBaseFunctionMultiDimTempl ()=default

virtual bool	HasGradient () const

T	operator() (const T *x) const
	Evaluate the function at a point x[].

Public Member Functions inherited from ROOT::Math::IBaseParam
virtual	~IBaseParam ()
	Virtual Destructor (no operations)

interface inherited from IParamFunction
bool	fLinear

bool	fPolynomial

bool	fOwnFunc

TF1 *	fFunc

unsigned int	fDim

IMultiGenFunctionTempl< T > *	Clone () const override
	Clone the wrapper but not the original function.

unsigned int	NDim () const override
	Retrieve the dimension of the function.

const double *	Parameters () const override
	get the parameter values (return values from TF1)

void	SetParameters (const double *p) override
	set parameter values (only the cached one in this class,leave unchanges those of TF1)

unsigned int	NPar () const override
	return number of parameters

std::string	ParameterName (unsigned int i) const override
	return parameter name (from TF1)

void	ParameterGradient (const T x, const double par, T *grad) const override
	Evaluate the all the derivatives (gradient vector) of the function with respect to the parameters at a point x.

bool	ParameterHessian (const T x, const double par, T *h) const override
	Evaluate the all the Hessian (second derivatives matrix) of the function with respect to the parameters at a point x.

bool	HasParameterHessian () const override

bool	ParameterG2 (const T , const double , T *) const override
	Evaluate all the second derivatives (diagonal ones) of the function with respect to the parameters at a point x.

const TF1 *	GetFunction () const
	method to retrieve the internal function pointer

void	SetAndCopyFunction (const TF1 *f=nullptr)
	method to set a new function pointer and copy it inside.

static void	SetDerivPrecision (double eps)
	precision value used for calculating the derivative step-size h = eps * \|x\|.

static double	GetDerivPrecision ()
	get precision value used for calculating the derivative step-size

T	DoEvalPar (const T x, const double p) const override
	evaluate function passing coordinates x and vector of parameters

T	DoEvalVec (const T *x) const
	evaluate function using the cached parameter values (of TF1) re-implement for better efficiency

T	DoEval (const T *x) const override
	evaluate function using the cached parameter values (of TF1) re-implement for better efficiency

T	DoParameterDerivative (const T x, const double p, unsigned int ipar) const override
	evaluate the partial derivative with respect to the parameter

#include <Math/WrappedMultiTF1.h>

Inheritance diagram for ROOT::Math::WrappedMultiTF1Templ< T >:

[legend]

Member Typedef Documentation

◆ BaseFunc

template<class T >

typedef ROOT::Math::IParametricFunctionMultiDimTempl<T>::BaseFunc ROOT::Math::WrappedMultiTF1Templ< T >::BaseFunc

Definition at line 53 of file WrappedMultiTF1.h.

◆ BaseParamFunc

template<class T >

typedef ROOT::Math::IParametricGradFunctionMultiDimTempl<T> ROOT::Math::WrappedMultiTF1Templ< T >::BaseParamFunc

Definition at line 52 of file WrappedMultiTF1.h.

Constructor & Destructor Documentation

◆ WrappedMultiTF1Templ() [1/2]

template<class T >

ROOT::Math::WrappedMultiTF1Templ< T >::WrappedMultiTF1Templ	(	TF1 &	f,
		unsigned int	dim = `0`
	)

constructor from a function pointer to a TF1 If dim = 0 dimension is taken from TF1::GetNdim().

In case of multi-dimensional function created using directly TF1 object the dimension returned by TF1::GetNdim is always 1. The user must then pass the correct value of dim

Definition at line 227 of file WrappedMultiTF1.h.

◆ ~WrappedMultiTF1Templ()

template<class T >

ROOT::Math::WrappedMultiTF1Templ< T >::~WrappedMultiTF1Templ ( )

inlineoverride

Destructor (no operations).

Function pointer is not owned

Definition at line 66 of file WrappedMultiTF1.h.

◆ WrappedMultiTF1Templ() [2/2]

template<class T >

ROOT::Math::WrappedMultiTF1Templ< T >::WrappedMultiTF1Templ ( const WrappedMultiTF1Templ< T > & rhs )

Copy constructor.

Definition at line 259 of file WrappedMultiTF1.h.

Member Function Documentation

◆ Clone()

template<class T >

IMultiGenFunctionTempl< T > * ROOT::Math::WrappedMultiTF1Templ< T >::Clone ( ) const

inlineoverridevirtual

Clone the wrapper but not the original function.

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

Definition at line 86 of file WrappedMultiTF1.h.

◆ DoEval()

template<class T >

T ROOT::Math::WrappedMultiTF1Templ< T >::DoEval ( const T * x ) const

inlineoverrideprivatevirtual

evaluate function using the cached parameter values (of TF1) re-implement for better efficiency

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

Definition at line 172 of file WrappedMultiTF1.h.

◆ DoEvalPar()

template<class T >

T ROOT::Math::WrappedMultiTF1Templ< T >::DoEvalPar	(	const T *	x,
		const double *	p
	)		const

inlineoverrideprivatevirtual

evaluate function passing coordinates x and vector of parameters

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

Definition at line 158 of file WrappedMultiTF1.h.

◆ DoEvalVec()

template<class T >

T ROOT::Math::WrappedMultiTF1Templ< T >::DoEvalVec ( const T * x ) const

inlineprivate

evaluate function using the cached parameter values (of TF1) re-implement for better efficiency

Definition at line 165 of file WrappedMultiTF1.h.

◆ DoParameterDerivative()

template<class T >

T ROOT::Math::WrappedMultiTF1Templ< T >::DoParameterDerivative	(	const T *	x,
		const double *	p,
		unsigned int	ipar
	)		const

overrideprivatevirtual

evaluate the partial derivative with respect to the parameter

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

Definition at line 363 of file WrappedMultiTF1.h.

◆ GetDerivPrecision()

template<class T >

double ROOT::Math::WrappedMultiTF1Templ< T >::GetDerivPrecision

static

get precision value used for calculating the derivative step-size

Definition at line 393 of file WrappedMultiTF1.h.

◆ GetFunction()

template<class T >

const TF1 * ROOT::Math::WrappedMultiTF1Templ< T >::GetFunction ( ) const

inline

method to retrieve the internal function pointer

Definition at line 147 of file WrappedMultiTF1.h.

◆ HasParameterHessian()

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::HasParameterHessian

overridevirtual

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

Definition at line 357 of file WrappedMultiTF1.h.

◆ NDim()

template<class T >

unsigned int ROOT::Math::WrappedMultiTF1Templ< T >::NDim ( ) const

inlineoverridevirtual

Retrieve the dimension of the function.

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

Definition at line 94 of file WrappedMultiTF1.h.

◆ NPar()

template<class T >

unsigned int ROOT::Math::WrappedMultiTF1Templ< T >::NPar ( ) const

inlineoverridevirtual

return number of parameters

Implements ROOT::Math::IBaseParam.

Definition at line 114 of file WrappedMultiTF1.h.

◆ operator=()

template<class T >

WrappedMultiTF1Templ< T > & ROOT::Math::WrappedMultiTF1Templ< T >::operator= ( const WrappedMultiTF1Templ< T > & rhs )

Assignment operator.

Definition at line 273 of file WrappedMultiTF1.h.

◆ ParameterG2()

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::ParameterG2	(	const T *	,
		const double *	,
		T *
	)		const

inlineoverridevirtual

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 from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >.

Definition at line 135 of file WrappedMultiTF1.h.

◆ ParameterGradient()

template<class T >

void ROOT::Math::WrappedMultiTF1Templ< T >::ParameterGradient	(	const T *	x,
		const double *	p,
		T *	grad
	)		const

overridevirtual

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 from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >.

Definition at line 286 of file WrappedMultiTF1.h.

◆ ParameterHessian()

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::ParameterHessian	(	const T *	,
		const double *	,
		T *
	)		const

overridevirtual

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 from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >.

Definition at line 347 of file WrappedMultiTF1.h.

◆ ParameterName()

template<class T >

std::string ROOT::Math::WrappedMultiTF1Templ< T >::ParameterName ( unsigned int i ) const

inlineoverridevirtual

return parameter name (from TF1)

Reimplemented from ROOT::Math::IBaseParam.

Definition at line 121 of file WrappedMultiTF1.h.

◆ Parameters()

template<class T >

const double * ROOT::Math::WrappedMultiTF1Templ< T >::Parameters ( ) const

inlineoverridevirtual

get the parameter values (return values from TF1)

Implements ROOT::Math::IBaseParam.

Definition at line 100 of file WrappedMultiTF1.h.

◆ SetAndCopyFunction()

template<class T >

void ROOT::Math::WrappedMultiTF1Templ< T >::SetAndCopyFunction ( const TF1 * f = nullptr )

method to set a new function pointer and copy it inside.

By calling this method the class manages now the passed TF1 pointer

Definition at line 399 of file WrappedMultiTF1.h.

◆ SetDerivPrecision()

template<class T >

void ROOT::Math::WrappedMultiTF1Templ< T >::SetDerivPrecision ( double eps )

static

precision value used for calculating the derivative step-size h = eps * |x|.

The default is 0.001, give a smaller in case function changes rapidly

Definition at line 387 of file WrappedMultiTF1.h.

◆ SetParameters()

template<class T >

void ROOT::Math::WrappedMultiTF1Templ< T >::SetParameters ( const double * p )

inlineoverridevirtual

set parameter values (only the cached one in this class,leave unchanges those of TF1)

Implements ROOT::Math::IBaseParam.

Definition at line 107 of file WrappedMultiTF1.h.

Member Data Documentation

◆ fDim

template<class T >

unsigned int ROOT::Math::WrappedMultiTF1Templ< T >::fDim

private

Definition at line 188 of file WrappedMultiTF1.h.

◆ fFunc

template<class T >

TF1* ROOT::Math::WrappedMultiTF1Templ< T >::fFunc

private

Definition at line 187 of file WrappedMultiTF1.h.

◆ fLinear

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::fLinear

private

Definition at line 184 of file WrappedMultiTF1.h.

◆ fOwnFunc

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::fOwnFunc

private

Definition at line 186 of file WrappedMultiTF1.h.

◆ fPolynomial

template<class T >

bool ROOT::Math::WrappedMultiTF1Templ< T >::fPolynomial

private

Definition at line 185 of file WrappedMultiTF1.h.

hist/hist/inc/Math/WrappedMultiTF1.h

Public Types

Public Member Functions

interface inherited from IParamFunction

Member Typedef Documentation

◆ BaseFunc

◆ BaseParamFunc

Constructor & Destructor Documentation

◆ WrappedMultiTF1Templ() [1/2]

◆ ~WrappedMultiTF1Templ()

◆ WrappedMultiTF1Templ() [2/2]

Member Function Documentation

◆ Clone()

◆ DoEval()

◆ DoEvalPar()

◆ DoEvalVec()

◆ DoParameterDerivative()

◆ GetDerivPrecision()

◆ GetFunction()

◆ HasParameterHessian()

◆ NDim()

◆ NPar()

◆ operator=()

◆ ParameterG2()

◆ ParameterGradient()

◆ ParameterHessian()

◆ ParameterName()

◆ Parameters()

◆ SetAndCopyFunction()

◆ SetDerivPrecision()

◆ SetParameters()

Member Data Documentation

◆ fDim

◆ fFunc

◆ fLinear

◆ fOwnFunc

◆ fPolynomial