Logo ROOT  
Reference Guide
ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN Class Reference

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. More...
 
 FumiliStandardMaximumLikelihoodFCN (const ParametricFunction &modelFCN, const std::vector< std::vector< double > > &pos)
 Constructor which initializes the measurement points for the multi dimensional model function. More...
 
 ~FumiliStandardMaximumLikelihoodFCN () override
 
std::vector< doubleElements (const std::vector< double > &par) const override
 Evaluates the model function for the different measurement points and the Parameter values supplied. More...
 
void EvaluateAll (const std::vector< double > &par) override
 Evaluate function Value, Gradient and Hessian using Fumili approximation, for values of parameters p The resul is cached inside and is return from the FumiliFCNBase::Value , FumiliFCNBase::Gradient and FumiliFCNBase::Hessian methods. More...
 
const std::vector< double > & GetMeasurement (int Index) const override
 Accessor to the position of the measurement (x coordinate). More...
 
int GetNumberOfMeasurements () const override
 Accessor to the number of measurements used for calculating the maximum likelihood. More...
 
- Public Member Functions inherited from ROOT::Minuit2::FumiliMaximumLikelihoodFCN
 FumiliMaximumLikelihoodFCN ()
 
 ~FumiliMaximumLikelihoodFCN () override
 
virtual std::vector< doubleElements (const std::vector< double > &par) const =0
 Evaluates the model function for the different measurement points and the Parameter values supplied, calculates a figure-of-merit for each measurement and returns a vector containing the result of this evaluation. More...
 
virtual const std::vector< double > & GetMeasurement (int Index) const =0
 Accessor to the parameters of a given measurement. More...
 
virtual int GetNumberOfMeasurements () const =0
 Accessor to the number of measurements used for calculating the present figure of merit. More...
 
const ParametricFunctionModelFunction () const
 Returns the model function used for the data. More...
 
double operator() (const std::vector< double > &par) const override
 Calculates the function for the maximum likelihood method. More...
 
void SetModelFunction (const ParametricFunction &modelFCN)
 Sets the model function for the data (for example gaussian+linear for a peak) More...
 
double Up () const override
 !!!!!!!!!!!! to be commented More...
 
- Public Member Functions inherited from ROOT::Minuit2::FumiliFCNBase
 FumiliFCNBase ()
 Default Constructor. More...
 
 FumiliFCNBase (unsigned int npar)
 Constructor which initializes the class with the function provided by the user for modeling the data. More...
 
 ~FumiliFCNBase () override
 
virtual unsigned int Dimension ()
 return number of function variable (parameters) , i.e. More...
 
virtual void EvaluateAll (const std::vector< double > &par)=0
 Evaluate function Value, Gradient and Hessian using Fumili approximation, for values of parameters p The resul is cached inside and is return from the FumiliFCNBase::Value , FumiliFCNBase::Gradient and FumiliFCNBase::Hessian methods. More...
 
virtual const std::vector< double > & Gradient () const
 Return cached Value of function Gradient estimated previously using the FumiliFCNBase::EvaluateAll method. More...
 
virtual double Hessian (unsigned int row, unsigned int col) const
 Return Value of the i-th j-th element of the Hessian matrix estimated previously using the FumiliFCNBase::EvaluateAll method. More...
 
virtual double Value () const
 Return cached Value of objective function estimated previously using the FumiliFCNBase::EvaluateAll method. More...
 
- Public Member Functions inherited from ROOT::Minuit2::FCNBase
 ~FCNBase () override
 
virtual double ErrorDef () const
 Error definition of the function. More...
 
double operator() (const std::vector< double > &v) const override=0
 The meaning of the vector of parameters is of course defined by the user, who uses the values of those parameters to calculate their function Value. More...
 
virtual void SetErrorDef (double)
 add interface to set dynamically a new error definition Re-implement this function if needed. More...
 
virtual double Up () const =0
 Error definition of the function. More...
 
- Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual ~GenericFunction ()
 
virtual double operator() (const std::vector< double > &x) const =0
 Evaluates the function using the vector containing the input values. More...
 

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 More...
 
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
modelFCNthe model function used for describing the data.
posvector 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
modelFCNthe model function used for describing the data.
posvector 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
parvector 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 resul is cached inside and is return from the FumiliFCNBase::Value , FumiliFCNBase::Gradient and FumiliFCNBase::Hessian methods.

Parameters
parvector of parameters

Implements ROOT::Minuit2::FumiliFCNBase.

Definition at line 57 of file FumiliStandardMaximumLikelihoodFCN.cxx.

◆ GetMeasurement()

const std::vector< double > & ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::GetMeasurement ( int  Index) const
overridevirtual

Accessor to the position of the measurement (x coordinate).

Parameters
IndexIndex of the measuerement the position of which to return.
Returns
the position of the measurement.

Implements ROOT::Minuit2::FumiliMaximumLikelihoodFCN.

Definition at line 45 of file FumiliStandardMaximumLikelihoodFCN.cxx.

◆ GetNumberOfMeasurements()

int ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::GetNumberOfMeasurements ( ) const
overridevirtual

Accessor to the number of measurements used for calculating the maximum likelihood.

Returns
the number of measurements.

Implements ROOT::Minuit2::FumiliMaximumLikelihoodFCN.

Definition at line 51 of file FumiliStandardMaximumLikelihoodFCN.cxx.

Member Data Documentation

◆ fPositions

std::vector<std::vector<double> > ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN::fPositions
private

Definition at line 129 of file FumiliStandardMaximumLikelihoodFCN.h.

Libraries for ROOT::Minuit2::FumiliStandardMaximumLikelihoodFCN:
[legend]

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