ROOT::Math::IParametricFunctionMultiDimTempl< T > Class Template Reference

Description

template<class T>
class ROOT::Math::IParametricFunctionMultiDimTempl< T >

IParamFunction interface (abstract class) describing multi-dimensional parameteric functions It is a derived class from ROOT::Math::IBaseFunctionMultiDim and ROOT::Math::IBaseParam

Provides the interface for evaluating a function passing a coordinate vector and a parameter vector.

Definition at line 104 of file IParamFunction.h.

Inheritance diagram for ROOT::Math::IParametricFunctionMultiDimTempl< T >:

Collaboration diagram for ROOT::Math::IParametricFunctionMultiDimTempl< T >:

Public Types
typedef T	BackendType
typedef IBaseFunctionMultiDimTempl< T >	BaseFunc

Public Member Functions
virtual IBaseFunctionMultiDimTempl< T > *	Clone () const =0
virtual unsigned int	NDim () const =0
virtual unsigned int	NPar () const =0
T	operator() (const T *x) const
T	operator() (const T *x, const double *p) const
virtual std::string	ParameterName (unsigned int i) const
virtual const double *	Parameters () const =0
virtual void	SetParameters (const double *p)=0

Private Member Functions
virtual T	DoEval (const T *x) const
virtual T	DoEvalPar (const T *x, const double *p) const =0

Member Typedef Documentation

BackendType

template<class T >

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

inherited

Definition at line 66 of file IFunction.h.

BaseFunc

template<class T >

typedef IBaseFunctionMultiDimTempl<T> ROOT::Math::IParametricFunctionMultiDimTempl< T >::BaseFunc

Definition at line 108 of file IParamFunction.h.

Member Function Documentation

Clone()

template<class T >

virtual IBaseFunctionMultiDimTempl<T>* ROOT::Math::IBaseFunctionMultiDimTempl< T >::Clone ( ) const

pure virtualinherited

Clone a function. Each derived class must implement their version of the Clone method

Implemented in ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::WrappedMemMultiFunction< FuncObj, MemFuncPtr >, ROOT::Math::WrappedMultiFunction< Func >, ROOT::Math::MultiNumGradFunction, ROOT::Math::MinimTransformFunction, ROOT::Math::LSResidualFunc, ROOT::Math::GradFunctor, ROOT::Math::Functor, and ROOT::Fit::FcnAdapter.

Referenced by ROOT::Math::MultiNumGradFunction::Clone().

DoEval()

template<class T >

virtual T ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEval ( const T *  x ) const

inlineprivatevirtual

Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values

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

Reimplemented in ROOT::Math::IParametricGradFunctionMultiDimTempl< T >, and ROOT::Math::WrappedParamFunctionGen< FuncPtr >.

Definition at line 140 of file IParamFunction.h.

         {
            return DoEvalPar(x, Parameters());
         }

References ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEvalPar(), and ROOT::Math::IBaseParam::Parameters().

Referenced by ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator()().

Here is the call graph for this function:

DoEvalPar()

template<class T >

virtual T ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEvalPar ( const T *  x, const double *  p  ) const

privatepure virtual

Implementation of the evaluation function using the x values and the parameters. Must be implemented by derived classes

Implemented in ROOT::Math::IParametricGradFunctionMultiDimTempl< T >, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedParamFunction< FuncPtr >.

Referenced by ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEval(), and ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator()().

NDim()

template<class T >

virtual unsigned int ROOT::Math::IBaseFunctionMultiDimTempl< T >::NDim ( ) const

pure virtualinherited

Retrieve the dimension of the function

Implemented in ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::WrappedMemMultiFunction< FuncObj, MemFuncPtr >, ROOT::Math::WrappedMultiFunction< Func >, ROOT::Math::MultiNumGradFunction, ROOT::Math::MinimTransformFunction, ROOT::Math::LSResidualFunc, ROOT::Math::GradFunctor, ROOT::Math::Functor, and ROOT::Fit::FcnAdapter.

NPar()

virtual unsigned int ROOT::Math::IBaseParam::NPar ( ) const

pure virtualinherited

Return the number of Parameters

Implemented in ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedParamFunction< FuncPtr >.

Referenced by ROOT::Fit::FitConfig::CreateParamsSettings(), ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterGradient(), ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient(), and ROOT::Math::IBaseParam::ParameterName().

operator()() [1/2]

template<class T >

T ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator() ( const T *  x ) const

inline

Definition at line 125 of file IParamFunction.h.

         {
            return DoEval(x);
         }

References ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEval().

Here is the call graph for this function:

operator()() [2/2]

template<class T >

T ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator() ( const T *  x, const double *  p  ) const

inline

Evaluate function at a point x and for given parameters p. This method does not change the internal status of the function (internal parameter values). If for some reason one prefers caching the parameter values, SetParameters(p) and then operator()(x) should be called. Use the pure virtual function DoEvalPar to implement it

Definition at line 120 of file IParamFunction.h.

         {
            return DoEvalPar(x, p);
         }

References ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEvalPar().

Here is the call graph for this function:

ParameterName()

virtual std::string ROOT::Math::IBaseParam::ParameterName ( unsigned int  i ) const

inlinevirtualinherited

Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...")

Definition at line 83 of file IParamFunction.h.

         {
            assert(i < NPar());
            return "Par_" + Util::ToString(i);
         }

References ROOT::Math::IBaseParam::NPar(), and ROOT::Math::Util::ToString().

Referenced by ROOT::Fit::FitConfig::CreateParamsSettings().

Here is the call graph for this function:

Parameters()

virtual const double* ROOT::Math::IBaseParam::Parameters ( ) const

pure virtualinherited

Access the parameter values

Implemented in ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedParamFunction< FuncPtr >.

Referenced by ROOT::Fit::FitConfig::CreateParamsSettings(), ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEval(), ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::DoEval(), ROOT::Math::IParametricFunctionOneDim::DoEval(), ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterDerivative(), ROOT::Math::IParametricGradFunctionOneDim::ParameterDerivative(), ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterGradient(), and ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient().

SetParameters()

virtual void ROOT::Math::IBaseParam::SetParameters ( const double *  p )

pure virtualinherited

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.

Implemented in ROOT::Math::WrappedParamFunctionGen< FuncPtr >, and ROOT::Math::WrappedParamFunction< FuncPtr >.

---

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

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