Class implementing the Elements member function for the standard maximum likelihood method.

Author: Andras Zsenei and Lorenzo Moneta, Creation date: 4 Sep 2004

See also: FumiliMaximumLikelihoodFCN

Definition at line 34 of file FumiliStandardMaximumLikelihoodFCN.h.

Public Member Functions
	FumiliStandardMaximumLikelihoodFCN (const ParametricFunction &modelFCN, const std::vector< double > &pos)
	Constructor which initializes the measurement points for the one dimensional model function.

	FumiliStandardMaximumLikelihoodFCN (const ParametricFunction &modelFCN, const std::vector< std::vector< double > > &pos)
	Constructor which initializes the measurement points for the multi dimensional model function.

	~FumiliStandardMaximumLikelihoodFCN () override

std::vector< double >	Elements (const std::vector< double > &par) const override
	Evaluates the model function for the different measurement points and the Parameter values supplied.

void	EvaluateAll (const std::vector< double > &par) override
	Evaluate function Value, Gradient and Hessian using Fumili approximation, for values of parameters p The result is cached inside and is return from the FumiliFCNBase::Value , FumiliFCNBase::Gradient and FumiliFCNBase::Hessian methods.

const std::vector< double > &	GetMeasurement (int Index) const override
	Accessor to the position of the measurement (x coordinate).

int	GetNumberOfMeasurements () const override
	Accessor to the number of measurements used for calculating the maximum likelihood.

Public Member Functions inherited from ROOT::Minuit2::FumiliMaximumLikelihoodFCN
	FumiliMaximumLikelihoodFCN ()

	~FumiliMaximumLikelihoodFCN () override

const ParametricFunction *	ModelFunction () const
	Returns the model function used for the data.

double	operator() (const std::vector< double > &par) const override
	Calculates the function for the maximum likelihood method.

void	SetModelFunction (const ParametricFunction &modelFCN)
	Sets the model function for the data (for example gaussian+linear for a peak)

double	Up () const override
	!!!!!!!!!!!! to be commented

Public Member Functions inherited from ROOT::Minuit2::FumiliFCNBase
	FumiliFCNBase ()
	Default Constructor.

	FumiliFCNBase (unsigned int npar)
	Constructor which initializes the class with the function provided by the user for modeling the data.

	~FumiliFCNBase () override

virtual unsigned int	Dimension ()
	return number of function variable (parameters) , i.e.

virtual const std::vector< double > &	Gradient () const
	Return cached Value of function Gradient estimated previously using the FumiliFCNBase::EvaluateAll method.

std::vector< double >	Gradient (const std::vector< double > &) const override

std::vector< double >	Hessian (const std::vector< double > &) const override
	Return Value of the i-th j-th element of the Hessian matrix estimated previously using the FumiliFCNBase::EvaluateAll method.

virtual double	Hessian (unsigned int row, unsigned int col) const

virtual double	Value () const
	Return cached Value of objective function estimated previously using the FumiliFCNBase::EvaluateAll method.

Public Member Functions inherited from ROOT::Minuit2::FCNGradientBase
	~FCNGradientBase () override

virtual bool	CheckGradient () const

virtual std::vector< double >	G2 (const std::vector< double > &) const
	return second derivatives (diagonal of the Hessian matrix)

virtual std::vector< double >	GradientWithPrevResult (const std::vector< double > &parameters, double , double , double *) const

virtual GradientParameterSpace	gradParameterSpace () const

virtual bool	HasG2 () const

virtual bool	HasHessian () const

Public Member Functions inherited from ROOT::Minuit2::FCNBase
	~FCNBase () override

virtual double	ErrorDef () const
	Error definition of the function.

virtual void	SetErrorDef (double)
	add interface to set dynamically a new error definition Re-implement this function if needed.

Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual	~GenericFunction ()

Private Attributes
std::vector< std::vector< double > >	fPositions

Additional Inherited Members
Protected Member Functions inherited from ROOT::Minuit2::FumiliFCNBase
std::vector< double > &	Gradient ()

std::vector< double > &	Hessian ()

virtual void	InitAndReset (unsigned int npar)
	initialize and reset values of gradien and Hessian

void	SetFCNValue (double value)

#include <Minuit2/FumiliStandardMaximumLikelihoodFCN.h>

Inheritance diagram for ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN:

[legend]

Constructor & Destructor Documentation

◆ FumiliStandardMaximumLikelihoodFCN() [1/2]

ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::FumiliStandardMaximumLikelihoodFCN	(	const ParametricFunction &	modelFCN,
		const std::vector< double > &	pos
	)

inline

Constructor which initializes the measurement points for the one dimensional model function.

Parameters

modelFCN	the model function used for describing the data.
pos	vector containing the x values corresponding to the measurements

Definition at line 48 of file FumiliStandardMaximumLikelihoodFCN.h.

◆ FumiliStandardMaximumLikelihoodFCN() [2/2]

ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::FumiliStandardMaximumLikelihoodFCN	(	const ParametricFunction &	modelFCN,
		const std::vector< std::vector< double > > &	pos
	)

inline

Constructor which initializes the measurement points for the multi dimensional model function.

Parameters

modelFCN	the model function used for describing the data.
pos	vector containing the x values corresponding to the measurements

Definition at line 71 of file FumiliStandardMaximumLikelihoodFCN.h.

◆ ~FumiliStandardMaximumLikelihoodFCN()

ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::~FumiliStandardMaximumLikelihoodFCN ( )

inlineoverride

Definition at line 77 of file FumiliStandardMaximumLikelihoodFCN.h.

Member Function Documentation

◆ Elements()

std::vector< double > ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::Elements ( const std::vector< double > & par ) const

overridevirtual

Evaluates the model function for the different measurement points and the Parameter values supplied.

Parameters

par	vector of Parameter values to feed to the model function.

Returns: A vector containing the model function evaluated for each measurement point.

Implements ROOT::Minuit2::FumiliMaximumLikelihoodFCN.

Definition at line 20 of file FumiliStandardMaximumLikelihoodFCN.cxx.

◆ EvaluateAll()

void ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::EvaluateAll ( const std::vector< double > & par )

overridevirtual

Evaluate function Value, Gradient and Hessian using Fumili approximation, for values of parameters p The result is cached inside and is return from the FumiliFCNBase::Value , FumiliFCNBase::Gradient and FumiliFCNBase::Hessian methods.

Parameters