template<typename Func = FreeMultiFunctionPtr>
class ROOT::Math::WrappedMultiFunction< Func >

Template class to wrap any C++ callable object implementing operator() (const double * x) in a multi-dimensional function interface.

It provides a ROOT::Math::IGenMultiFunction-like signature

Note: If you want to wrap just the reference (to avoid copying) you need to use Func& or const Func & as template parameter. The former should be used when the operator() is not a const method of Func

Definition at line 143 of file WrappedFunction.h.

Public Types
typedef double	BackendType
typedef IBaseFunctionMultiDimTempl< double >	BaseFunc

Public Member Functions
	WrappedMultiFunction (Func f, unsigned int dim=1)
	construct from the pointer to the object and the member function
WrappedMultiFunction *	Clone () const override
	clone (required by the interface)
double	Derivative (const double x, unsigned int icoord, double previous_grad, double previous_g2, double previous_gstep) const
	In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload.
double	Derivative (const double *x, unsigned int icoord=0) const
	Return the partial derivative with respect to the passed coordinate.
virtual void	FdF (const double x, double &f, double df) const
	Optimized method to evaluate at the same time the function value and derivative at a point x.
virtual void	Gradient (const double x, double grad) const
	Evaluate all the vector of function derivatives (gradient) at a point x.
virtual bool	HasGradient () const
unsigned int	NDim () const override
	Retrieve the dimension of the function.
double	operator() (const double *x) const
	Evaluate the function at a point x[].

Private Member Functions
virtual double	DoDerivative (const double *, unsigned int) const
	Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.
virtual double	DoDerivativeWithPrevResult (const double x, unsigned int icoord, double , double , double ) const
	In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload.
double	DoEval (const double *x) const override
	Implementation of the evaluation function. Must be implemented by derived classes.

Private Attributes
unsigned int	fDim
Func	fFunc

#include <Math/WrappedFunction.h>

Inheritance diagram for ROOT::Math::WrappedMultiFunction< Func >:

Member Typedef Documentation

◆ BackendType

typedef double ROOT::Math::IBaseFunctionMultiDimTempl< double >::BackendType

inherited

Definition at line 67 of file IFunction.h.

◆ BaseFunc

typedef IBaseFunctionMultiDimTempl<double> ROOT::Math::IBaseFunctionMultiDimTempl< double >::BaseFunc

inherited

Definition at line 68 of file IFunction.h.

Constructor & Destructor Documentation

◆ WrappedMultiFunction()

template<typename Func = FreeMultiFunctionPtr>

ROOT::Math::WrappedMultiFunction< Func >::WrappedMultiFunction	(	Func	f,
		unsigned int	dim = 1 )

inline

construct from the pointer to the object and the member function

Definition at line 151 of file WrappedFunction.h.

Member Function Documentation

◆ Clone()

template<typename Func = FreeMultiFunctionPtr>

WrappedMultiFunction * ROOT::Math::WrappedMultiFunction< Func >::Clone ( ) const

inlineoverridevirtual

clone (required by the interface)

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

Definition at line 159 of file WrappedFunction.h.

◆ Derivative() [1/2]

double ROOT::Math::IBaseFunctionMultiDimTempl< double >::Derivative	(	const double *	x,
		unsigned int	icoord,
		double *	previous_grad,
		double *	previous_g2,
		double *	previous_gstep ) const

inlineinherited

In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload.

The previous_* arrays can also be used to return second derivative and step size so that these can be passed forward again as well at the call site, if necessary.

Definition at line 120 of file IFunction.h.

◆ Derivative() [2/2]

double ROOT::Math::IBaseFunctionMultiDimTempl< double >::Derivative	(	const double *	x,
		unsigned int	icoord = 0 ) const

inlineinherited

Return the partial derivative with respect to the passed coordinate.

Definition at line 115 of file IFunction.h.

◆ DoDerivative()

virtual double ROOT::Math::IBaseFunctionMultiDimTempl< double >::DoDerivative	(	const double *	,
		unsigned int	) const

inlineprivatevirtualinherited

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

Reimplemented in ROOT::Math::GradFunctor, ROOT::Math::LSResidualFunc< Func >, ROOT::Math::MinimTransformFunction, and ROOT::Math::MultiNumGradFunction.

Definition at line 131 of file IFunction.h.

◆ DoDerivativeWithPrevResult()

virtual double ROOT::Math::IBaseFunctionMultiDimTempl< double >::DoDerivativeWithPrevResult	(	const double *	x,
		unsigned int	icoord,
		double *	,
		double *	,
		double *	) const

inlineprivatevirtualinherited

In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload.

The previous_* arrays can also be used to return second derivative and step size so that these can be passed forward again as well at the call site, if necessary.

Definition at line 136 of file IFunction.h.

◆ DoEval()

template<typename Func = FreeMultiFunctionPtr>

double ROOT::Math::WrappedMultiFunction< Func >::DoEval ( const double * x ) const

inlineoverrideprivatevirtual

Implementation of the evaluation function. Must be implemented by derived classes.

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

Definition at line 169 of file WrappedFunction.h.

◆ FdF()

virtual void ROOT::Math::IBaseFunctionMultiDimTempl< double >::FdF	(	const 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::LSResidualFunc< Func >.

Definition at line 108 of file IFunction.h.

◆ Gradient()

virtual void ROOT::Math::IBaseFunctionMultiDimTempl< double >::Gradient	(	const double *	x,
		double *	grad ) const

inlinevirtualinherited

Evaluate all the vector of function derivatives (gradient) at a point x.

Derived classes must re-implement it if more efficient than evaluating one at a time

Reimplemented in ROOT::Math::GradFunctor, and ROOT::Math::LSResidualFunc< Func >.

Definition at line 96 of file IFunction.h.

◆ HasGradient()

virtual bool ROOT::Math::IBaseFunctionMultiDimTempl< double >::HasGradient ( ) const

inlinevirtualinherited

Reimplemented in ROOT::Math::IGradientFunctionMultiDimTempl< double >.

Definition at line 92 of file IFunction.h.

◆ NDim()

template<typename Func = FreeMultiFunctionPtr>

unsigned int ROOT::Math::WrappedMultiFunction< Func >::NDim ( ) const

inlineoverridevirtual

Retrieve the dimension of the function.

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

Definition at line 163 of file WrappedFunction.h.

◆ operator()()

double ROOT::Math::IBaseFunctionMultiDimTempl< double >::operator() ( const double * x ) const

inlineinherited

Evaluate the function at a point x[].

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

Definition at line 81 of file IFunction.h.

Member Data Documentation

◆ fDim

template<typename Func = FreeMultiFunctionPtr>

unsigned int ROOT::Math::WrappedMultiFunction< Func >::fDim

private

Definition at line 175 of file WrappedFunction.h.

◆ fFunc

template<typename Func = FreeMultiFunctionPtr>

Func ROOT::Math::WrappedMultiFunction< Func >::fFunc

private

Definition at line 174 of file WrappedFunction.h.

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

math/mathcore/inc/Math/WrappedFunction.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ BackendType

◆ BaseFunc

Constructor & Destructor Documentation

◆ WrappedMultiFunction()

Member Function Documentation

◆ Clone()

◆ Derivative() [1/2]

◆ Derivative() [2/2]

◆ DoDerivative()

◆ DoDerivativeWithPrevResult()

◆ DoEval()

◆ FdF()

◆ Gradient()

◆ HasGradient()

◆ NDim()

◆ operator()()

Member Data Documentation

◆ fDim

◆ fFunc