template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>
class ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >

OneDimParamFunctionAdapter class to wrap a multi-dim parametric function in one dimensional one.

Given a f(x[],p1,...pn) transforms in a f( p_i) given the param index i and the vectors x[] and p[] of the coordinates and parameters It has to be used carefully, since for efficiency reason it does not copy the parameter object but re-uses the given pointer for the p[] vector. The ParamFuncType reference by default is not const because the operator()(x,p) is not a const method

Definition at line 213 of file OneDimFunctionAdapter.h.

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
	OneDimParamFunctionAdapter (ParamFuncType f, const double x, const double p, unsigned int ipar=0)
	Constructor from the function object , x value and coordinate we want to adapt.
	~OneDimParamFunctionAdapter () override
	Destructor (no operations).
OneDimParamFunctionAdapter *	Clone () const override
	clone
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
double	operator() (const double *x) const
	Evaluate the function at a point x[].
double	operator() (double x) const
	Evaluate the function at a point x.

Private Member Functions
virtual double	DoDerivative (double) const
	Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.
double	DoEval (double x) const override
	evaluate function at the values x[] given in the constructor and as function of the coordinate fCoord.

Private Attributes
ParamFuncType	fFunc
unsigned int	fIpar
const double *	fParams
const double *	fX

#include <Math/OneDimFunctionAdapter.h>

Inheritance diagram for ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >:

Member Typedef Documentation

◆ BaseFunc

typedef IBaseFunctionOneDim ROOT::Math::IBaseFunctionOneDim::BaseFunc

inherited

Definition at line 161 of file IFunction.h.

Constructor & Destructor Documentation

◆ OneDimParamFunctionAdapter()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::OneDimParamFunctionAdapter	(	ParamFuncType	f,
		const double *	x,
		const double *	p,
		unsigned int	ipar = 0 )

inline

Constructor from the function object , x value and coordinate we want to adapt.

Definition at line 221 of file OneDimFunctionAdapter.h.

◆ ~OneDimParamFunctionAdapter()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::~OneDimParamFunctionAdapter ( )

inlineoverride

Destructor (no operations).

Definition at line 234 of file OneDimFunctionAdapter.h.

Member Function Documentation

◆ Clone()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

OneDimParamFunctionAdapter * ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone ( ) const

inlineoverridevirtual

clone

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 239 of file OneDimFunctionAdapter.h.

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

◆ DoDerivative()

virtual double ROOT::Math::IBaseFunctionOneDim::DoDerivative ( double ) const

inlineprivatevirtualinherited

Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.

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

Definition at line 210 of file IFunction.h.

◆ DoEval()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

double ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval ( double x ) const

inlineoverrideprivatevirtual

evaluate function at the values x[] given in the constructor and as function of the coordinate fCoord.

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 251 of file OneDimFunctionAdapter.h.

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

◆ operator()() [1/2]

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

inlineinherited

Evaluate the function at a point x[].

Compatible method with multi-dimensional functions.

Definition at line 175 of file IFunction.h.

◆ operator()() [2/2]

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

inlineinherited

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 171 of file IFunction.h.

Member Data Documentation

◆ fFunc

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ParamFuncType ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fFunc

private

Definition at line 264 of file OneDimFunctionAdapter.h.

◆ fIpar

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

unsigned int ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fIpar

private

Definition at line 267 of file OneDimFunctionAdapter.h.

◆ fParams

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

const double* ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fParams

private

Definition at line 266 of file OneDimFunctionAdapter.h.

◆ fX

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

const double* ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fX

private

Definition at line 265 of file OneDimFunctionAdapter.h.

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

math/mathcore/inc/Math/OneDimFunctionAdapter.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ BaseFunc

Constructor & Destructor Documentation

◆ OneDimParamFunctionAdapter()

◆ ~OneDimParamFunctionAdapter()

Member Function Documentation

◆ Clone()

◆ Derivative() [1/2]

◆ Derivative() [2/2]

◆ DoDerivative()

◆ DoEval()

◆ FdF() [1/2]

◆ FdF() [2/2]

◆ Gradient()

◆ HasGradient()

◆ operator()() [1/2]

◆ operator()() [2/2]

Member Data Documentation

◆ fFunc

◆ fIpar

◆ fParams

◆ fX