ROOT::Math::WrappedFunction< Func > Class Template Reference

Description

template<typename Func = FreeFunctionPtr>
class ROOT::Math::WrappedFunction< Func >

Template class to wrap any C++ callable object which takes one argument i.e. implementing operator() (double x) in a One-dimensional function interface. It provides a ROOT::Math::IGenFunction-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 56 of file WrappedFunction.h.

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

Collaboration diagram for ROOT::Math::WrappedFunction< Func >:

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
	WrappedFunction (Func f)
WrappedFunction *	Clone () const
	clone (required by the interface) More...
double	operator() (const double *x) const
double	operator() (double x) const

Private Member Functions
virtual double	DoEval (double x) const
	implementation of the evaluation function. Must be implemented by derived classes More...

Private Attributes
Func	fFunc

Member Typedef Documentation

BaseFunc

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

inherited

Definition at line 139 of file IFunction.h.

Constructor & Destructor Documentation

WrappedFunction()

template<typename Func = FreeFunctionPtr>

ROOT::Math::WrappedFunction< Func >::WrappedFunction ( Func  f )

inline

construct from the pointer to the object and the member function

Definition at line 64 of file WrappedFunction.h.

                             :
      fFunc( f )
   { /* no op */ }

Referenced by ROOT::Math::WrappedFunction< Func >::Clone().

Member Function Documentation

Clone()

template<typename Func = FreeFunctionPtr>

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

inlinevirtual

clone (required by the interface)

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 71 of file WrappedFunction.h.

                                   {
      return new WrappedFunction(fFunc);
   }

References ROOT::Math::WrappedFunction< Func >::WrappedFunction(), and ROOT::Math::WrappedFunction< Func >::fFunc.

Here is the call graph for this function:

DoEval()

template<typename Func = FreeFunctionPtr>

virtual double ROOT::Math::WrappedFunction< Func >::DoEval ( double  x ) const

inlineprivatevirtual

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

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 79 of file WrappedFunction.h.

                                          {
      return fFunc( x );
   }

References ROOT::Math::WrappedFunction< Func >::fFunc.

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

         {
            return DoEval(*x);
         }

References ROOT::Math::IBaseFunctionOneDim::DoEval().

Here is the call graph for this function:

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

         {
            return DoEval(x);
         }

References ROOT::Math::IBaseFunctionOneDim::DoEval().

Referenced by ROOT::Math::IGradientFunctionOneDim::FdF().

Here is the call graph for this function:

Member Data Documentation

fFunc

template<typename Func = FreeFunctionPtr>

Func ROOT::Math::WrappedFunction< Func >::fFunc

private

Definition at line 84 of file WrappedFunction.h.

Referenced by ROOT::Math::WrappedFunction< Func >::Clone(), and ROOT::Math::WrappedFunction< Func >::DoEval().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/mathcore/Math/WrappedFunction.h