MultiDimParamGradFunctionAdapter class to wrap a one-dimensional parametric gradient function in a multi dimensional parameteric gradient function interface This is used typically in fitting where internally the function is stored as multidimension.

To wrap a non-parametric one-dim gradient function in a multi-dim interface one can use simply a a ROOT::Math::GradFunctor

The parameters are not stored in the adapter class and by default the pointer to the 1D function is owned. This means that deleteing the class deletes also the 1D function and copying the class copies also the 1D function This class differs from WrappedParamFunction in the fact that the parameters are not stored in the adapter class and optionally it keeps a cloned and managed copy of the adapter class.

Definition at line 174 of file MultiDimParamFunctionAdapter.h.

Public Types
typedef IParamMultiGradFunction::BaseFunc	BaseFunc

Public Types inherited from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >
using	BaseFunc = typename IParametricFunctionMultiDimTempl< T >::BaseFunc

using	BaseGradFunc = IGradientFunctionMultiDim

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 IBaseFunctionMultiDimTempl< T >	BaseFunc

Public Member Functions
	MultiDimParamGradFunctionAdapter (const IParamGradFunction &f)
	Constructor from a param one dim function interface from a const reference Copy and manage the own function pointer. More...

	MultiDimParamGradFunctionAdapter (IParamGradFunction &f)
	Constructor from a param one dim function interface from a non const reference Do not own the function pointer in this case. More...

	MultiDimParamGradFunctionAdapter (const MultiDimParamGradFunctionAdapter &rhs)
	Copy constructor. More...

virtual	~MultiDimParamGradFunctionAdapter ()
	Destructor (no operations) More...

virtual BaseFunc *	Clone () const
	clone More...

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

unsigned int	NPar () const
	Return the number of Parameters. More...

MultiDimParamGradFunctionAdapter &	operator= (const MultiDimParamGradFunctionAdapter &rhs)
	Assignment operator. More...

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...

const double *	Parameters () const
	Access the parameter values. More...

void	SetParameters (const double *p)
	Set the parameter values. More...

Public Member Functions inherited from ROOT::Math::IParametricGradFunctionMultiDimTempl< T >
virtual	~IParametricGradFunctionMultiDimTempl ()
	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...

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

Public Member Functions inherited from ROOT::Math::IParametricFunctionMultiDimTempl< T >
T	operator() (const T x, const double p) const
	Evaluate function at a point x and for given parameters p. More...

Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
	IBaseFunctionMultiDimTempl ()

virtual	~IBaseFunctionMultiDimTempl ()
	virtual destructor More...

T	operator() (const T *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 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...

Private Member Functions
double	DoEvalPar (const double x, const double p) const
	functions needed by interface More...

double	DoParameterDerivative (const double x, const double p, unsigned int ipar) const
	Evaluate the partial derivative w.r.t a parameter ipar , to be implemented by the derived classes. More...

Private Attributes
IParamGradFunction *	fFunc

bool	fOwn

#include <Math/MultiDimParamFunctionAdapter.h>

Inheritance diagram for ROOT::Math::MultiDimParamGradFunctionAdapter:

[legend]

Member Typedef Documentation

◆ BaseFunc

typedef IParamMultiGradFunction::BaseFunc ROOT::Math::MultiDimParamGradFunctionAdapter::BaseFunc

Definition at line 178 of file MultiDimParamFunctionAdapter.h.

Constructor & Destructor Documentation

◆ MultiDimParamGradFunctionAdapter() [1/3]

ROOT::Math::MultiDimParamGradFunctionAdapter::MultiDimParamGradFunctionAdapter ( const IParamGradFunction & f )

inline

Constructor from a param one dim function interface from a const reference Copy and manage the own function pointer.

Definition at line 185 of file MultiDimParamFunctionAdapter.h.

◆ MultiDimParamGradFunctionAdapter() [2/3]

ROOT::Math::MultiDimParamGradFunctionAdapter::MultiDimParamGradFunctionAdapter ( IParamGradFunction & f )

inline

Constructor from a param one dim function interface from a non const reference Do not own the function pointer in this case.

Definition at line 195 of file MultiDimParamFunctionAdapter.h.

◆ MultiDimParamGradFunctionAdapter() [3/3]

ROOT::Math::MultiDimParamGradFunctionAdapter::MultiDimParamGradFunctionAdapter ( const MultiDimParamGradFunctionAdapter & rhs )

inline

Copy constructor.

Different behaviour according if function is owned or not

Definition at line 204 of file MultiDimParamFunctionAdapter.h.

◆ ~MultiDimParamGradFunctionAdapter()

virtual ROOT::Math::MultiDimParamGradFunctionAdapter::~MultiDimParamGradFunctionAdapter ( )

inlinevirtual

Destructor (no operations)

Definition at line 217 of file MultiDimParamFunctionAdapter.h.

Member Function Documentation

◆ Clone()

virtual BaseFunc* ROOT::Math::MultiDimParamGradFunctionAdapter::Clone ( ) const

inlinevirtual

clone

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

Definition at line 241 of file MultiDimParamFunctionAdapter.h.

◆ DoEvalPar()

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

inlineprivate

functions needed by interface

Definition at line 283 of file MultiDimParamFunctionAdapter.h.

◆ DoParameterDerivative()

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

inlineprivatevirtual

Evaluate the partial derivative w.r.t a parameter ipar , to be implemented by the derived classes.

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

Definition at line 292 of file MultiDimParamFunctionAdapter.h.

◆ NDim()

unsigned int ROOT::Math::MultiDimParamGradFunctionAdapter::NDim ( ) const

inlinevirtual

Retrieve the dimension of the function.

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

Definition at line 264 of file MultiDimParamFunctionAdapter.h.

◆ NPar()

unsigned int ROOT::Math::MultiDimParamGradFunctionAdapter::NPar ( ) const

inlinevirtual

Return the number of Parameters.

Implements ROOT::Math::IBaseParam.

Definition at line 259 of file MultiDimParamFunctionAdapter.h.

◆ operator=()

MultiDimParamGradFunctionAdapter& ROOT::Math::MultiDimParamGradFunctionAdapter::operator= ( const MultiDimParamGradFunctionAdapter & rhs )

inline

Assignment operator.

Definition at line 226 of file MultiDimParamFunctionAdapter.h.

◆ ParameterGradient()

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

Definition at line 273 of file MultiDimParamFunctionAdapter.h.

◆ Parameters()

const double* ROOT::Math::MultiDimParamGradFunctionAdapter::Parameters ( ) const

inlinevirtual

Access the parameter values.

Implements ROOT::Math::IBaseParam.

Definition at line 249 of file MultiDimParamFunctionAdapter.h.

◆ SetParameters()

void ROOT::Math::MultiDimParamGradFunctionAdapter::SetParameters ( const double * p )

inlinevirtual

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.

Implements ROOT::Math::IBaseParam.

Definition at line 254 of file MultiDimParamFunctionAdapter.h.

Member Data Documentation

◆ fFunc

IParamGradFunction* ROOT::Math::MultiDimParamGradFunctionAdapter::fFunc

private

Definition at line 300 of file MultiDimParamFunctionAdapter.h.

◆ fOwn

bool ROOT::Math::MultiDimParamGradFunctionAdapter::fOwn

private

Definition at line 299 of file MultiDimParamFunctionAdapter.h.

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

math/mathcore/inc/Math/MultiDimParamFunctionAdapter.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ BaseFunc

Constructor & Destructor Documentation

◆ MultiDimParamGradFunctionAdapter() [1/3]

◆ MultiDimParamGradFunctionAdapter() [2/3]

◆ MultiDimParamGradFunctionAdapter() [3/3]

◆ ~MultiDimParamGradFunctionAdapter()

Member Function Documentation

◆ Clone()

◆ DoEvalPar()

◆ DoParameterDerivative()

◆ NDim()

◆ NPar()

◆ operator=()

◆ ParameterGradient()

◆ Parameters()

◆ SetParameters()

Member Data Documentation

◆ fFunc

◆ fOwn