template<typename FuncPtr = FreeParamMultiFunctionPtr>
class ROOT::Math::WrappedParamFunction< FuncPtr >

WrappedParamFunction class to wrap any multi-dimensional function pbject implementing the operator()(const double * x, const double * p) in an interface-like IParamFunction with a vector storing and caching internally the parameter values.

Definition at line 41 of file WrappedParamFunction.h.

Public Member Functions
	WrappedParamFunction (FuncPtr func, unsigned int dim=1, unsigned int npar=0, double *par=0)
	Constructor a wrapped function from a pointer to a callable object, the function dimension and number of parameters which are set to zero by default. More...

template<class Iterator >
	WrappedParamFunction (FuncPtr func, unsigned int dim, Iterator begin, Iterator end)
	Constructor a wrapped function from a non-const pointer to a callable object, the function dimension and number of parameters which are set to zero by default This constructor is needed in the case FuncPtr is a std::unique_ptr which has a copy ctor taking non const objects. More...

IMultiGenFunction *	Clone () const
	Constructor a wrapped function from a non - const pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters. More...

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

unsigned int	NPar () const
	Return the number of Parameters. 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::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
	evaluate the function given values and parameters (requested interface) More...

Private Attributes
unsigned int	fDim

FuncPtr	fFunc

std::vector< double >	fParams

Additional Inherited Members
Public Types inherited from ROOT::Math::IParametricFunctionMultiDimTempl< T >
typedef IBaseFunctionMultiDimTempl< T >	BaseFunc

Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
typedef IBaseFunctionMultiDimTempl< T >	BaseFunc

#include <Math/WrappedParamFunction.h>

Inheritance diagram for ROOT::Math::WrappedParamFunction< FuncPtr >:

[legend]

Constructor & Destructor Documentation

◆ WrappedParamFunction() [1/2]

template<typename FuncPtr = FreeParamMultiFunctionPtr>

ROOT::Math::WrappedParamFunction< FuncPtr >::WrappedParamFunction	(	FuncPtr	func,
		unsigned int	dim = `1`,
		unsigned int	npar = `0`,
		double *	par = `0`
	)

inline

Constructor a wrapped function from a pointer to a callable object, the function dimension and number of parameters which are set to zero by default.

Definition at line 49 of file WrappedParamFunction.h.

◆ WrappedParamFunction() [2/2]

template<typename FuncPtr = FreeParamMultiFunctionPtr>

template<class Iterator >

ROOT::Math::WrappedParamFunction< FuncPtr >::WrappedParamFunction	(	FuncPtr	func,
		unsigned int	dim,
		Iterator	begin,
		Iterator	end
	)

inline

Constructor a wrapped function from a non-const pointer to a callable object, the function dimension and number of parameters which are set to zero by default This constructor is needed in the case FuncPtr is a std::unique_ptr which has a copy ctor taking non const objects.

Constructor a wrapped function from a pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters

Definition at line 75 of file WrappedParamFunction.h.

Member Function Documentation

◆ Clone()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

IMultiGenFunction* ROOT::Math::WrappedParamFunction< FuncPtr >::Clone ( ) const

inlinevirtual

Constructor a wrapped function from a non - const pointer to a callable object, the function dimension and an iterator specifying begin and end of parameters.

This constructor is needed in the case FuncPtr is a std::unique_ptr which has a copy ctor taking non const objectsclone the function

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

Definition at line 93 of file WrappedParamFunction.h.

◆ DoEvalPar()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

double ROOT::Math::WrappedParamFunction< FuncPtr >::DoEvalPar	(	const double *	x,
		const double *	p
	)		const

inlineprivate

evaluate the function given values and parameters (requested interface)

Definition at line 113 of file WrappedParamFunction.h.

◆ NDim()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

unsigned int ROOT::Math::WrappedParamFunction< FuncPtr >::NDim ( ) const

inlinevirtual

Retrieve the dimension of the function.

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

Definition at line 107 of file WrappedParamFunction.h.

◆ NPar()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

unsigned int ROOT::Math::WrappedParamFunction< FuncPtr >::NPar ( ) const

inlinevirtual

Return the number of Parameters.

Implements ROOT::Math::IBaseParam.

Definition at line 105 of file WrappedParamFunction.h.

◆ Parameters()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

const double* ROOT::Math::WrappedParamFunction< FuncPtr >::Parameters ( ) const

inlinevirtual

Access the parameter values.

Implements ROOT::Math::IBaseParam.

Definition at line 97 of file WrappedParamFunction.h.

◆ SetParameters()

template<typename FuncPtr = FreeParamMultiFunctionPtr>

void ROOT::Math::WrappedParamFunction< FuncPtr >::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 101 of file WrappedParamFunction.h.

Member Data Documentation

◆ fDim

template<typename FuncPtr = FreeParamMultiFunctionPtr>

unsigned int ROOT::Math::WrappedParamFunction< FuncPtr >::fDim

private

Definition at line 119 of file WrappedParamFunction.h.

◆ fFunc

template<typename FuncPtr = FreeParamMultiFunctionPtr>

FuncPtr ROOT::Math::WrappedParamFunction< FuncPtr >::fFunc

private

Definition at line 118 of file WrappedParamFunction.h.

◆ fParams

template<typename FuncPtr = FreeParamMultiFunctionPtr>

std::vector<double> ROOT::Math::WrappedParamFunction< FuncPtr >::fParams

private

Definition at line 120 of file WrappedParamFunction.h.

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

math/mathcore/inc/Math/WrappedParamFunction.h

template<typename FuncPtr = FreeParamMultiFunctionPtr> class ROOT::Math::WrappedParamFunction< FuncPtr >

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ WrappedParamFunction() [1/2]

◆ WrappedParamFunction() [2/2]

Member Function Documentation

◆ Clone()

◆ DoEvalPar()

◆ NDim()

◆ NPar()

◆ Parameters()

◆ SetParameters()

Member Data Documentation

◆ fDim

◆ fFunc

◆ fParams

template<typename FuncPtr = FreeParamMultiFunctionPtr>
class ROOT::Math::WrappedParamFunction< FuncPtr >