ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType > Class Template Reference

Description

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>
class ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >

OneDimParamFunctionAdapter class to wrap a multi-dim parameteric function in one dimensional one. Given a f(x[],p1,...pn) transforms in a f( p_i) given the param index i and the vectors x[] and p[] of the coordinates and parameters It has to be used carefully, since for efficiency reason it does not copy the parameter object but re-uses the given pointer for the p[] vector. The ParamFuncType reference by default is not const because the operator()(x,p) is not a const method

Definition at line 213 of file OneDimFunctionAdapter.h.

Inheritance diagram for ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >:

Collaboration diagram for ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >:

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
	OneDimParamFunctionAdapter (ParamFuncType f, const double *x, const double *p, unsigned int ipar=0)
	~OneDimParamFunctionAdapter ()
virtual OneDimParamFunctionAdapter *	Clone () const
double	operator() (const double *x) const
double	operator() (double x) const

Private Member Functions
double	DoEval (double x) const

Private Attributes
ParamFuncType	fFunc
unsigned int	fIpar
const double *	fParams
const double *	fX

Member Typedef Documentation

BaseFunc

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

inherited

Definition at line 139 of file IFunction.h.

Constructor & Destructor Documentation

OneDimParamFunctionAdapter()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::OneDimParamFunctionAdapter ( ParamFuncType  f, const double *  x, const double *  p, unsigned int  ipar = 0  )

inline

Constructor from the function object , x value and coordinate we want to adapt

Definition at line 221 of file OneDimFunctionAdapter.h.

                                                                                                           :
      fFunc(f),
      fX(x ),
      fParams(p),
      fIpar(ipar)
   {
      assert(fX != 0);
      assert(fParams != 0);
   }

References ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fParams, and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fX.

Referenced by ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone().

~OneDimParamFunctionAdapter()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::~OneDimParamFunctionAdapter ( )

inline

Destructor (no operations)

Definition at line 234 of file OneDimFunctionAdapter.h.

{}

Member Function Documentation

Clone()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

virtual OneDimParamFunctionAdapter* ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone ( ) const

inlinevirtual

clone

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 239 of file OneDimFunctionAdapter.h.

                                                       {
      return new OneDimParamFunctionAdapter(fFunc, fX, fParams, fIpar);
   }

References ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::OneDimParamFunctionAdapter(), ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fFunc, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fIpar, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fParams, and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fX.

Here is the call graph for this function:

DoEval()

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

double ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval ( double  x ) const

inlineprivatevirtual

evaluate function at the values x[] given in the constructor and as function of the coordinate fCoord.

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 251 of file OneDimFunctionAdapter.h.

                                 {
      // HACK: use const_cast to modify the function values x[] and restore afterwards the original ones
      double * p = const_cast<double *>(fParams);
      double pprev = fParams[fIpar]; // keep original value to restore in fX
      p[fIpar] = x;
      double y =  fFunc( fX, p );
      p[fIpar] = pprev;
      return y;
   }

References ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fFunc, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fIpar, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fParams, and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fX.

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<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

ParamFuncType ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fFunc

private

Definition at line 264 of file OneDimFunctionAdapter.h.

Referenced by ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone(), and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval().

fIpar

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

unsigned int ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fIpar

private

Definition at line 267 of file OneDimFunctionAdapter.h.

Referenced by ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone(), and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval().

fParams

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

const double* ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fParams

private

Definition at line 266 of file OneDimFunctionAdapter.h.

Referenced by ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::OneDimParamFunctionAdapter(), ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone(), and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval().

fX

template<class ParamFuncType = ROOT::Math::IParamMultiFunction &>

const double* ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::fX

private

Definition at line 265 of file OneDimFunctionAdapter.h.

Referenced by ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::OneDimParamFunctionAdapter(), ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::Clone(), and ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >::DoEval().

---

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

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