ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr > Class Template Reference

template<typename FuncObj, typename MemFuncPtr>
class ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >

Template class to wrap any member function of a class taking a double and returning a double in a 1D function interface For example, if you have a class like: struct X { double Eval(double x); }; you can wrapped in the following way: WrappedMemFunction<X, double ( X::* ) (double) > f;.

Definition at line 95 of file WrappedFunction.h.

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
	WrappedMemFunction (FuncObj &obj, MemFuncPtr memFn)
	construct from the pointer to the object and the member function
WrappedMemFunction *	Clone () const override
	clone (required by the interface)
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
	implementation of the evaluation function. Must be implemented by derived classes

Private Attributes
MemFuncPtr	fMemFunc
FuncObj *	fObj

#include <Math/WrappedFunction.h>

Inheritance diagram for ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >:

Member Typedef Documentation

BaseFunc

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

inherited

Definition at line 161 of file IFunction.h.

Constructor & Destructor Documentation

WrappedMemFunction()

template<typename FuncObj, typename MemFuncPtr>

ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >::WrappedMemFunction ( FuncObj & obj, MemFuncPtr memFn )

inline

construct from the pointer to the object and the member function

Definition at line 103 of file WrappedFunction.h.

Member Function Documentation

Clone()

template<typename FuncObj, typename MemFuncPtr>

WrappedMemFunction * ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >::Clone ( ) const

inlineoverridevirtual

clone (required by the interface)

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 111 of file WrappedFunction.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<typename FuncObj, typename MemFuncPtr>

double ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >::DoEval ( double x ) const

inlineoverrideprivatevirtual

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

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 118 of file WrappedFunction.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

fMemFunc

template<typename FuncObj, typename MemFuncPtr>

MemFuncPtr ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >::fMemFunc

private

Definition at line 124 of file WrappedFunction.h.

fObj

template<typename FuncObj, typename MemFuncPtr>

FuncObj* ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >::fObj

private

Definition at line 123 of file WrappedFunction.h.

---

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

• math/mathcore/inc/Math/WrappedFunction.h