template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>
class ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >

OneDimMultiFunctionAdapter class to wrap a multidimensional function in one dimensional one.

Given a f(x1,x2,x3,....xn) transforms in a f( x_i) given the coordinate intex i and the vector x[] of the coordinates. It provides the possibility to copy and own the data array of the coordinates or to maintain internally a pointer to an external array for being more efficient. In this last case the user must guarantee the life of the given passed pointer

Definition at line 56 of file OneDimFunctionAdapter.h.

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
	OneDimMultiFunctionAdapter (const OneDimMultiFunctionAdapter &rhs)
	OneDimMultiFunctionAdapter (MultiFuncType f, const double x, unsigned int icoord=0, const double p=nullptr)
	Constructor from the function object , pointer to an external array of x values and coordinate we want to adapt.
	OneDimMultiFunctionAdapter (MultiFuncType f, unsigned int dim=1, unsigned int icoord=0, const double *p=nullptr)
	Constructor from the function object , dimension of the function and and coordinate we want to adapt.
	~OneDimMultiFunctionAdapter () override
	Destructor (no operations).
OneDimMultiFunctionAdapter *	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.
void	SetCoord (int icoord)
void	SetX (const double *x)
	set values
void	SetX (double *x)
	set pointer without copying the values
template<class Iterator>
void	SetX (Iterator begin, Iterator end)
	Set X values in case vector is own, iterator size must match previous set dimension.

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.
OneDimMultiFunctionAdapter &	operator= (const OneDimMultiFunctionAdapter &rhs)

Private Attributes
unsigned int	fCoord
unsigned int	fDim
MultiFuncType	fFunc
bool	fOwn
const double *	fParams
double *	fX

#include <Math/OneDimFunctionAdapter.h>

Inheritance diagram for ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >:

Member Typedef Documentation

◆ BaseFunc

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

inherited

Definition at line 161 of file IFunction.h.

Constructor & Destructor Documentation

◆ OneDimMultiFunctionAdapter() [1/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::OneDimMultiFunctionAdapter	(	MultiFuncType	f,
		const double *	x,
		unsigned int	icoord = 0,
		const double *	p = nullptr )

inline

Constructor from the function object , pointer to an external array of x values and coordinate we want to adapt.

Definition at line 65 of file OneDimFunctionAdapter.h.

◆ OneDimMultiFunctionAdapter() [2/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::OneDimMultiFunctionAdapter	(	MultiFuncType	f,
		unsigned int	dim = 1,
		unsigned int	icoord = 0,
		const double *	p = nullptr )

inline

Constructor from the function object , dimension of the function and and coordinate we want to adapt.

The coordinate cached vector is created inside and eventually the values must be passed later with the SetX which will copy them

Definition at line 81 of file OneDimFunctionAdapter.h.

◆ ~OneDimMultiFunctionAdapter()

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::~OneDimMultiFunctionAdapter ( )

inlineoverride

Destructor (no operations).

Definition at line 95 of file OneDimFunctionAdapter.h.

◆ OneDimMultiFunctionAdapter() [3/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::OneDimMultiFunctionAdapter ( const OneDimMultiFunctionAdapter< MultiFuncType > & rhs )

inline

Definition at line 142 of file OneDimFunctionAdapter.h.

Member Function Documentation

◆ Clone()

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

OneDimMultiFunctionAdapter * ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::Clone ( ) const

inlineoverridevirtual

clone

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 100 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 MultiFuncType = const ROOT::Math::IMultiGenFunction &>

double ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::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 169 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.

◆ operator=()

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

OneDimMultiFunctionAdapter & ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::operator= ( const OneDimMultiFunctionAdapter< MultiFuncType > & rhs )

inlineprivate

Definition at line 160 of file OneDimFunctionAdapter.h.

◆ SetCoord()

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

void ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::SetCoord ( int icoord )

inline

Definition at line 139 of file OneDimFunctionAdapter.h.

◆ SetX() [1/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

void ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::SetX ( const double * x )

inline

set values

Definition at line 132 of file OneDimFunctionAdapter.h.

◆ SetX() [2/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

void ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::SetX ( double * x )

inline

set pointer without copying the values

Definition at line 125 of file OneDimFunctionAdapter.h.

◆ SetX() [3/3]

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

template<class Iterator>

void ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::SetX	(	Iterator	begin,
		Iterator	end )

inline

Set X values in case vector is own, iterator size must match previous set dimension.

Definition at line 117 of file OneDimFunctionAdapter.h.

Member Data Documentation

◆ fCoord

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

unsigned int ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fCoord

private

Definition at line 193 of file OneDimFunctionAdapter.h.

◆ fDim

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

unsigned int ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fDim

private

Definition at line 194 of file OneDimFunctionAdapter.h.

◆ fFunc

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

MultiFuncType ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fFunc

private

Definition at line 190 of file OneDimFunctionAdapter.h.

◆ fOwn

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

bool ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fOwn

private

Definition at line 195 of file OneDimFunctionAdapter.h.

◆ fParams

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

const double* ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fParams

private

Definition at line 192 of file OneDimFunctionAdapter.h.

◆ fX

template<class MultiFuncType = const ROOT::Math::IMultiGenFunction &>

double* ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >::fX

mutableprivate

Definition at line 191 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

◆ OneDimMultiFunctionAdapter() [1/3]

◆ OneDimMultiFunctionAdapter() [2/3]

◆ ~OneDimMultiFunctionAdapter()

◆ OneDimMultiFunctionAdapter() [3/3]

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]

◆ operator=()

◆ SetCoord()

◆ SetX() [1/3]

◆ SetX() [2/3]

◆ SetX() [3/3]

Member Data Documentation

◆ fCoord

◆ fDim

◆ fFunc

◆ fOwn

◆ fParams

◆ fX