ROOT::Math::IBaseParam Class Reference

Description

Documentation for the abstract class IBaseParam. It defines the interface for dealing with the function parameters This is used only for internal convinience, to avoid redefining the Parameter API for the one and the multi-dim functions. Concrete class should derive from ROOT::Math::IParamFunction and not from this class.

Definition at line 48 of file IParamFunction.h.

Inheritance diagram for ROOT::Math::IBaseParam:

Public Member Functions
virtual	~IBaseParam ()
virtual unsigned int	NPar () const =0
virtual std::string	ParameterName (unsigned int i) const
virtual const double *	Parameters () const =0
virtual void	SetParameters (const double *p)=0

Constructor & Destructor Documentation

~IBaseParam()

virtual ROOT::Math::IBaseParam::~IBaseParam ( )

inlinevirtual

Virtual Destructor (no operations)

Definition at line 56 of file IParamFunction.h.

{}

Member Function Documentation

NPar()

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

pure virtual

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 ParameterName().

ParameterName()

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

inlinevirtual

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 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 virtual

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 virtual

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