ROOT::Math::IParametricGradFunctionOneDim Class Reference

Description

Interface (abstract class) for parametric one-dimensional gradient functions providing in addition to function evaluation with respect the coordinates also the gradient with respect to the parameters, via the method ParameterGradient.

It is a derived class from ROOT::Math::IParametricFunctionOneDim.

The pure private virtual method DoParameterGradient must be implemented by the derived classes in addition to those inherited by the base abstract classes.

Definition at line 308 of file IParamFunction.h.

Inheritance diagram for ROOT::Math::IParametricGradFunctionOneDim:

Collaboration diagram for ROOT::Math::IParametricGradFunctionOneDim:

Public Types
typedef IParametricFunctionOneDim::BaseFunc	BaseFunc
typedef IGradientFunctionOneDim	BaseGradFunc
typedef IParametricFunctionOneDim	BaseParamFunc

Public Member Functions
virtual	~IParametricGradFunctionOneDim ()
virtual IBaseFunctionOneDim *	Clone () const =0
virtual unsigned int	NPar () const =0
double	operator() (const double *x) const
double	operator() (const double *x, const double *p) const
double	operator() (double x) const
double	operator() (double x, const double *p) const
double	ParameterDerivative (const double *x, const double *p, unsigned int ipar=0) const
double	ParameterDerivative (const double *x, unsigned int ipar=0) const
double	ParameterDerivative (double x, const double *p, unsigned int ipar=0) const
double	ParameterDerivative (double x, unsigned int ipar=0) const
void	ParameterGradient (const double *x, const double *p, double *grad) const
void	ParameterGradient (const double *x, double *grad) const
virtual void	ParameterGradient (double x, const double *p, double *grad) const
void	ParameterGradient (double x, double *grad) 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 double	DoEval (double x) const
virtual double	DoEvalPar (double x, const double *p) const =0
virtual double	DoParameterDerivative (double x, const double *p, unsigned int ipar) const =0

Member Typedef Documentation

BaseFunc

typedef IParametricFunctionOneDim::BaseFunc ROOT::Math::IParametricGradFunctionOneDim::BaseFunc

Definition at line 317 of file IParamFunction.h.

BaseGradFunc

typedef IGradientFunctionOneDim ROOT::Math::IParametricGradFunctionOneDim::BaseGradFunc

Definition at line 316 of file IParamFunction.h.

BaseParamFunc

typedef IParametricFunctionOneDim ROOT::Math::IParametricGradFunctionOneDim::BaseParamFunc

Definition at line 315 of file IParamFunction.h.

Constructor & Destructor Documentation

~IParametricGradFunctionOneDim()

virtual ROOT::Math::IParametricGradFunctionOneDim::~IParametricGradFunctionOneDim ( )

inlinevirtual

Virtual Destructor (no operations)

Definition at line 323 of file IParamFunction.h.

{}

Member Function Documentation

Clone()

virtual IBaseFunctionOneDim* ROOT::Math::IBaseFunctionOneDim::Clone ( ) const

pure virtualinherited

Clone a function. Each derived class will implement their version of the provate DoClone method

Implemented in ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >, ROOT::Math::WrappedFunction< Func >, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >, ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >, ROOT::Math::GradFunctor1D, and ROOT::Math::Functor1D.

DoEval()

virtual double ROOT::Math::IParametricFunctionOneDim::DoEval ( double  x ) const

inlineprivatevirtualinherited

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

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 200 of file IParamFunction.h.

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

References ROOT::Math::IParametricFunctionOneDim::DoEvalPar(), and ROOT::Math::IBaseParam::Parameters().

Here is the call graph for this function:

DoEvalPar()

virtual double ROOT::Math::IParametricFunctionOneDim::DoEvalPar ( double  x, const double *  p  ) const

privatepure virtualinherited

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

Referenced by ROOT::Math::IParametricFunctionOneDim::DoEval(), and ROOT::Math::IParametricFunctionOneDim::operator()().

DoParameterDerivative()

virtual double ROOT::Math::IParametricGradFunctionOneDim::DoParameterDerivative ( double  x, const double *  p, unsigned int  ipar  ) const

privatepure virtual

Evaluate the gradient, to be implemented by the derived classes

Referenced by ParameterDerivative(), and ParameterGradient().

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(), ParameterGradient(), and ROOT::Math::IBaseParam::ParameterName().

operator()() [1/4]

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/4]

double ROOT::Math::IParametricFunctionOneDim::operator() ( const double *  x, const double *  p  ) const

inlineinherited

multidim-like interface

Definition at line 184 of file IParamFunction.h.

         {
            return DoEvalPar(*x, p);
         }

References ROOT::Math::IParametricFunctionOneDim::DoEvalPar().

Here is the call graph for this function:

operator()() [3/4]

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:

operator()() [4/4]

double ROOT::Math::IParametricFunctionOneDim::operator() ( double  x, const double *  p  ) const

inlineinherited

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 175 of file IParamFunction.h.

         {
            return DoEvalPar(x, p);
         }

References ROOT::Math::IParametricFunctionOneDim::DoEvalPar().

Here is the call graph for this function:

ParameterDerivative() [1/4]

double ROOT::Math::IParametricGradFunctionOneDim::ParameterDerivative ( const double *  x, const double *  p, unsigned int  ipar = 0  ) const

inline

Partial derivative with respect a parameter Compatibility interface with multi-dimensional functions

Definition at line 384 of file IParamFunction.h.

         {
            return DoParameterDerivative(*x, p, ipar);
         }

References DoParameterDerivative().

Here is the call graph for this function:

ParameterDerivative() [2/4]

double ROOT::Math::IParametricGradFunctionOneDim::ParameterDerivative ( const double *  x, unsigned int  ipar = 0  ) const

inline

Evaluate partial derivative using cached parameter values (multi-dim like interface)

Definition at line 393 of file IParamFunction.h.

         {
            return DoParameterDerivative(*x, Parameters() , ipar);
         }

References DoParameterDerivative(), and ROOT::Math::IBaseParam::Parameters().

Here is the call graph for this function:

ParameterDerivative() [3/4]

double ROOT::Math::IParametricGradFunctionOneDim::ParameterDerivative ( double  x, const double *  p, unsigned int  ipar = 0  ) const

inline

Partial derivative with respect a parameter

Definition at line 367 of file IParamFunction.h.

         {
            return DoParameterDerivative(x, p, ipar);
         }

References DoParameterDerivative().

Here is the call graph for this function:

ParameterDerivative() [4/4]

double ROOT::Math::IParametricGradFunctionOneDim::ParameterDerivative ( double  x, unsigned int  ipar = 0  ) const

inline

Evaluate partial derivative using cached parameter values

Definition at line 375 of file IParamFunction.h.

         {
            return DoParameterDerivative(x, Parameters() , ipar);
         }

References DoParameterDerivative(), and ROOT::Math::IBaseParam::Parameters().

Here is the call graph for this function:

ParameterGradient() [1/4]

void ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient ( const double *  x, const double *  p, double *  grad  ) const

inline

Compatibility interface with multi-dimensional functions

Definition at line 350 of file IParamFunction.h.

         {
            ParameterGradient(*x, p, grad);
         }

References ParameterGradient().

Here is the call graph for this function:

ParameterGradient() [2/4]

void ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient ( const double *  x, double *  grad  ) const

inline

Evaluate all derivatives using cached parameter values (multi-dim like interface)

Definition at line 358 of file IParamFunction.h.

         {
            return ParameterGradient(*x, Parameters(), grad);
         }

References ParameterGradient(), and ROOT::Math::IBaseParam::Parameters().

Here is the call graph for this function:

ParameterGradient() [3/4]

virtual void ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient ( double  x, const double *  p, double *  grad  ) const

inlinevirtual

Evaluate the derivatives of the function with respect to the parameters at a point x. It is optional to be implemented by the derived classes for better efficiency if needed

Definition at line 332 of file IParamFunction.h.

         {
            unsigned int npar = NPar();
            for (unsigned int ipar  = 0; ipar < npar; ++ipar)
               grad[ipar] = DoParameterDerivative(x, p, ipar);
         }

References DoParameterDerivative(), and ROOT::Math::IBaseParam::NPar().

Referenced by ParameterGradient().

Here is the call graph for this function:

ParameterGradient() [4/4]

void ROOT::Math::IParametricGradFunctionOneDim::ParameterGradient ( double  x, double *  grad  ) const

inline

Evaluate all derivatives using cached parameter values

Definition at line 342 of file IParamFunction.h.

         {
            return ParameterGradient(x, Parameters(), grad);
         }

References ParameterGradient(), and ROOT::Math::IBaseParam::Parameters().

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(), ParameterDerivative(), ROOT::Math::IParametricGradFunctionMultiDimTempl< T >::ParameterGradient(), and 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