class ROOT::Math::BasicFitMethodFunction<ROOT::Math::IGradientFunctionMultiDim>: public ROOT::Math::IGradientFunctionMultiDim


   FitMethodFunction class
   Interface for objective functions (like chi2 and likelihood used in the fit)
   In addition to normal function interface provide interface for calculating each
   data contrinution to the function which is required by some algorithm (like Fumili)

   @ingroup  FitMethodFunc

This class is also known as (typedefs to this class)

ROOT::Math::FitMethodGradFunction, ROOT::Fit::PoissonLikelihoodFCN<ROOT::Math::IGradientFunctionMultiDim>::BaseObjFunction, ROOT::Fit::LogLikelihoodFCN<ROOT::Math::IGradientFunctionMultiDim>::BaseObjFunction, ROOT::Math::BasicFitMethodFunction<ROOT::Math::IMultiGradFunction>, ROOT::Fit::Chi2FCN<ROOT::Math::IGradientFunctionMultiDim>::BaseObjFunction

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

virtual	~BasicFitMethodFunction<ROOT::Math::IGradientFunctionMultiDim>()
virtual ROOT::Math::IBaseFunctionMultiDim*	ROOT::Math::IBaseFunctionMultiDim::Clone() const
virtual double	DataElement(const double* x, unsigned int i, double* g = 0) const
double	ROOT::Math::IGradientMultiDim::Derivative(const double* x, unsigned int icoord = 0) const
virtual void	ROOT::Math::IGradientFunctionMultiDim::FdF(const double* x, double& f, double* df) const
virtual void	ROOT::Math::IGradientFunctionMultiDim::Gradient(const double* x, double* grad) const
virtual unsigned int	NCalls() const
virtual unsigned int	NDim() const
virtual unsigned int	NPoints() const
double	ROOT::Math::IBaseFunctionMultiDim::operator()(const double* x) const
ROOT::Math::BasicFitMethodFunction<ROOT::Math::IGradientFunctionMultiDim>&	operator=(const ROOT::Math::BasicFitMethodFunction<ROOT::Math::IGradientFunctionMultiDim>&)
virtual void	ResetNCalls()
virtual ROOT::Math::BasicFitMethodFunction<ROOT::Math::IGradientFunctionMultiDim>::Type_t	Type() const
virtual void	UpdateNCalls() const

Data Members

public:

enum Type_t {	kUndefined
	kLeastSquare
	kLogLikelihood
};

private:

unsigned int	fNCalls	number of function calls
unsigned int	fNDim	function dimension
unsigned int	fNPoints	size of the data

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

unsigned int NDim() const

      Number of dimension (parameters) . From IGenMultiFunction interface

{ return fNDim; }

double DataElement(const double* x, unsigned int i, double* g = 0) const

      method returning the data i-th contribution to the fit objective function
      For example the residual for the least square functions or the pdf element for the
      likelihood functions.
      Estimating eventually also the gradient of the data element if the passed pointer  is not null

unsigned int NPoints() const

      return the number of data points used in evaluating the function

{ return fNPoints; }

unsigned int NCalls() const

      return the total number of function calls (overrided if needed)

{ return fNCalls; }

void UpdateNCalls() const

      update number of calls

{ fNCalls++; }

void ResetNCalls()

      reset number of function calls

{ fNCalls = 0; }