ROOT::Math::IBaseParam Class Reference

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.

Public Member Functions
virtual	~IBaseParam ()
	Virtual Destructor (no operations) More...
virtual unsigned int	NPar () const =0
	Return the number of Parameters. More...
virtual std::string	ParameterName (unsigned int i) const
	Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...") More...
virtual const double *	Parameters () const =0
	Access the parameter values. More...
virtual void	SetParameters (const double *p)=0
	Set the parameter values. More...

#include <Math/IParamFunction.h>

Inheritance diagram for ROOT::Math::IBaseParam:

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::MultiDimParamGradFunctionAdapter, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, and ROOT::Math::VavilovAccurateQuantile.

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, ...")

Reimplemented in ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, and ROOT::Math::VavilovAccurateQuantile.

Definition at line 83 of file IParamFunction.h.

Parameters()

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

pure virtual

Access the parameter values.

Implemented in ROOT::Math::MultiDimParamGradFunctionAdapter, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccurateQuantile, and ROOT::Math::VavilovAccuratePdf.

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::MultiDimParamGradFunctionAdapter, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::MultiDimParamFunctionAdapter, ROOT::Math::ParamFunction< IParamGradFunction >, ROOT::Math::WrappedParamFunction< FuncPtr >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, and ROOT::Math::VavilovAccurateQuantile.

---

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

• math/mathcore/inc/Math/IParamFunction.h