Minuit2Minimizer class implementing the ROOT::Math::Minimizer interface for Minuit2 minimization algorithm.
In ROOT it can be instantiated using the plug-in manager (plug-in "Minuit2") Using a string (used by the plugin manager) or via an enumeration an one can set all the possible minimization algorithms (Migrad, Simplex, Combined, Scan and Fumili).
Refer to the guide for an introduction how Minuit works.
Definition at line 54 of file Minuit2Minimizer.h.
Public Member Functions | |
Minuit2Minimizer (const char *type) | |
Constructor with a char (used by PM) | |
Minuit2Minimizer (ROOT::Minuit2::EMinimizerType type=ROOT::Minuit2::kMigrad) | |
Default constructor. | |
~Minuit2Minimizer () override | |
Destructor (no operations) | |
void | Clear () override |
reset for consecutive minimization - implement if needed | |
bool | Contour (unsigned int i, unsigned int j, unsigned int &npoints, double *xi, double *xj) override |
find the contour points (xi,xj) of the function for parameter i and j around the minimum The contour will be find for value of the function = Min + ErrorUp(); | |
double | Correlation (unsigned int i, unsigned int j) const override |
return correlation coefficient between variable i and j. | |
double | CovMatrix (unsigned int i, unsigned int j) const override |
return covariance matrix elements if the variable is fixed or const the value is zero The ordering of the variables is the same as in errors and parameter value. | |
int | CovMatrixStatus () const override |
return the status of the covariance matrix status = -1 : not available (inversion failed or Hesse failed) status = 0 : available but not positive defined status = 1 : covariance only approximate status = 2 : full matrix but forced pos def status = 3 : full accurate matrix | |
double | Edm () const override |
return expected distance reached from the minimum | |
const double * | Errors () const override |
return errors at the minimum | |
bool | FixVariable (unsigned int ivar) override |
fix an existing variable | |
bool | GetCovMatrix (double *cov) const override |
Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero. | |
bool | GetHessianMatrix (double *h) const override |
Fill the passed array with the Hessian matrix elements The Hessian matrix is the matrix of the second derivatives and is the inverse of the covariance matrix If the variable is fixed or const the values for that variables are zero. | |
bool | GetMinosError (unsigned int i, double &errLow, double &errUp, int=0) override |
get the minos error for parameter i, return false if Minos failed A minimizaiton must be performed befre, return false if no minimization has been done In case of Minos failed the status error is updated as following status += 10 * minosStatus. | |
bool | GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &varObj) const override |
get variable settings in a variable object (like ROOT::Fit::ParamsSettings) | |
double | GlobalCC (unsigned int i) const override |
get global correlation coefficient for the variable i. | |
bool | Hesse () override |
perform a full calculation of the Hessian matrix for error calculation If a valid minimum exists the calculation is done on the minimum point otherwise is performed in the current set values of parameters Status code of minimizer is updated according to the following convention (in case Hesse failed) status += 100*hesseStatus where hesse status is: status = 1 : hesse failed status = 2 : matrix inversion failed status = 3 : matrix is not pos defined | |
bool | IsFixedVariable (unsigned int ivar) const override |
query if an existing variable is fixed (i.e. | |
const double * | MinGradient () const override |
return pointer to gradient values at the minimum | |
bool | Minimize () override |
method to perform the minimization. | |
int | MinosStatus () const override |
MINOS status code of last Minos run status & 1 > 0 : invalid lower error status & 2 > 0 : invalid upper error status & 4 > 0 : invalid because maximum number of function calls exceeded status & 8 > 0 : a new minimum has been found status & 16 > 0 : error is truncated because parameter is at lower/upper limit. | |
double | MinValue () const override |
return minimum function value | |
unsigned int | NCalls () const override |
number of function calls to reach the minimum | |
unsigned int | NDim () const override |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones) | |
unsigned int | NFree () const override |
number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total | |
void | PrintResults () override |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const; | |
bool | ProvidesError () const override |
minimizer provides error and error matrix | |
bool | ReleaseVariable (unsigned int ivar) override |
release an existing variable | |
bool | Scan (unsigned int i, unsigned int &nstep, double *x, double *y, double xmin=0, double xmax=0) override |
scan a parameter i around the minimum. | |
bool | SetFixedVariable (unsigned int, const std::string &, double) override |
set fixed variable (override if minimizer supports them ) | |
void | SetFunction (const ROOT::Math::IMultiGenFunction &func) override |
set the function to minimize | |
void | SetHessianFunction (std::function< bool(std::span< const double >, double *)> hfunc) override |
set the function implementing Hessian computation | |
bool | SetLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double, double) override |
set upper/lower limited variable (override if minimizer supports them ) | |
bool | SetLowerLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower) override |
set lower limit variable (override if minimizer supports them ) | |
void | SetStorageLevel (int level) |
set storage level = 1 : store all iteration states (default) = 0 : store only first and last state to save memory | |
void | SetTraceObject (MnTraceObject &obj) |
set an object to trace operation for each iteration The object must be a (or inherit from) ROOT::Minuit2::MnTraceObject and implement operator() (int, const MinimumState & state) | |
bool | SetUpperLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double upper) override |
set upper limit variable (override if minimizer supports them ) | |
bool | SetVariable (unsigned int ivar, const std::string &name, double val, double step) override |
set free variable | |
bool | SetVariableLimits (unsigned int ivar, double lower, double upper) override |
set the limits of an already existing variable | |
bool | SetVariableLowerLimit (unsigned int ivar, double lower) override |
set the lower-limit of an already existing variable | |
bool | SetVariableStepSize (unsigned int ivar, double step) override |
set the step size of an already existing variable | |
bool | SetVariableUpperLimit (unsigned int ivar, double upper) override |
set the upper-limit of an already existing variable | |
bool | SetVariableValue (unsigned int ivar, double val) override |
set variable | |
bool | SetVariableValues (const double *val) override |
set the values of all existing variables (array must be dimensioned to the size of the existing parameters) | |
const ROOT::Minuit2::MnUserParameterState & | State () |
return the minimizer state (containing values, step size , etc..) | |
int | VariableIndex (const std::string &name) const override |
get index of variable given a variable given a name return -1 if variable is not found | |
std::string | VariableName (unsigned int ivar) const override |
get name of variables (override if minimizer support storing of variable names) | |
const double * | X () const override |
return pointer to X values at the minimum | |
Public Member Functions inherited from ROOT::Math::Minimizer | |
Minimizer () | |
Default constructor. | |
Minimizer (Minimizer &&)=delete | |
Minimizer (Minimizer const &)=delete | |
virtual | ~Minimizer () |
Destructor (no operations). | |
double | ErrorDef () const |
return the statistical scale used for calculate the error is typically 1 for Chi2 and 0.5 for likelihood minimization | |
bool | IsValidError () const |
return true if Minimizer has performed a detailed error validation (e.g. run Hesse for Minuit) | |
unsigned int | MaxFunctionCalls () const |
max number of function calls | |
unsigned int | MaxIterations () const |
max iterations | |
virtual unsigned int | NIterations () const |
number of iterations to reach the minimum | |
Minimizer & | operator= (Minimizer &&)=delete |
Minimizer & | operator= (Minimizer const &)=delete |
virtual MinimizerOptions | Options () const |
retrieve the minimizer options (implement derived class if needed) | |
double | Precision () const |
precision of minimizer in the evaluation of the objective function ( a value <=0 corresponds to the let the minimizer choose its default one) | |
int | PrintLevel () const |
minimizer configuration parameters | |
void | SetDefaultOptions () |
reset the default options (defined in MinimizerOptions) | |
void | SetErrorDef (double up) |
set scale for calculating the errors | |
void | SetExtraOptions (const IOptions &extraOptions) |
set only the extra options | |
void | SetMaxFunctionCalls (unsigned int maxfcn) |
set maximum of function calls | |
void | SetMaxIterations (unsigned int maxiter) |
set maximum iterations (one iteration can have many function calls) | |
void | SetOptions (const MinimizerOptions &opt) |
set all options in one go | |
void | SetPrecision (double prec) |
set in the minimizer the objective function evaluation precision ( a value <=0 means the minimizer will choose its optimal value automatically, i.e. | |
void | SetPrintLevel (int level) |
set print level | |
void | SetStrategy (int strategyLevel) |
set the strategy | |
void | SetTolerance (double tol) |
set the tolerance | |
void | SetValidError (bool on) |
flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit) | |
virtual bool | SetVariableInitialRange (unsigned int, double, double) |
set the initial range of an existing variable | |
template<class VariableIterator > | |
int | SetVariables (const VariableIterator &begin, const VariableIterator &end) |
add variables . Return number of variables successfully added | |
int | Status () const |
status code of minimizer | |
int | Strategy () const |
strategy | |
double | Tolerance () const |
absolute tolerance | |
Protected Member Functions | |
bool | ExamineMinimum (const ROOT::Minuit2::FunctionMinimum &min) |
examine the minimum result | |
virtual const ROOT::Minuit2::FCNBase * | GetFCN () const |
virtual const ROOT::Minuit2::ModularFunctionMinimizer * | GetMinimizer () const |
int | RunMinosError (unsigned int i, double &errLow, double &errUp, int runopt) |
bool | SetCovariance (std::span< const double > cov, unsigned int nrow) override |
set initial covariance matrix | |
virtual bool | SetCovarianceDiag (std::span< const double > d2, unsigned int n) override |
set initial second derivatives | |
virtual void | SetMinimizer (ROOT::Minuit2::ModularFunctionMinimizer *m) |
void | SetMinimizerType (ROOT::Minuit2::EMinimizerType type) |
Private Attributes | |
unsigned int | fDim |
std::vector< double > | fErrors |
ROOT::Minuit2::ModularFunctionMinimizer * | fMinimizer |
ROOT::Minuit2::FunctionMinimum * | fMinimum |
int | fMinosStatus = -1 |
ROOT::Minuit2::FCNBase * | fMinuitFCN |
ROOT::Minuit2::MnUserParameterState | fState |
bool | fUseFumili |
std::vector< double > | fValues |
Additional Inherited Members | |
Protected Attributes inherited from ROOT::Math::Minimizer | |
MinimizerOptions | fOptions |
minimizer options | |
int | fStatus = -1 |
status of minimizer | |
bool | fValidError = false |
flag to control if errors have been validated (Hesse has been run in case of Minuit) | |
#include <Minuit2/Minuit2Minimizer.h>
ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer | ( | ROOT::Minuit2::EMinimizerType | type = ROOT::Minuit2::kMigrad | ) |
Default constructor.
Definition at line 86 of file Minuit2Minimizer.cxx.
ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer | ( | const char * | type | ) |
Constructor with a char (used by PM)
Definition at line 93 of file Minuit2Minimizer.cxx.
|
override |
Destructor (no operations)
Definition at line 145 of file Minuit2Minimizer.cxx.
|
overridevirtual |
reset for consecutive minimization - implement if needed
Reimplemented from ROOT::Math::Minimizer.
Definition at line 156 of file Minuit2Minimizer.cxx.
|
overridevirtual |
find the contour points (xi,xj) of the function for parameter i and j around the minimum The contour will be find for value of the function = Min + ErrorUp();
Reimplemented from ROOT::Math::Minimizer.
Definition at line 1148 of file Minuit2Minimizer.cxx.
|
overridevirtual |
return correlation coefficient between variable i and j.
If the variable is fixed or const the return value is zero
Reimplemented from ROOT::Math::Minimizer.
Definition at line 815 of file Minuit2Minimizer.cxx.
|
overridevirtual |
return covariance matrix elements if the variable is fixed or const the value is zero The ordering of the variables is the same as in errors and parameter value.
This is different from the direct interface of Minuit2 or TMinuit where the values were obtained only to variable parameters
Reimplemented from ROOT::Math::Minimizer.
Definition at line 739 of file Minuit2Minimizer.cxx.
|
overridevirtual |
return the status of the covariance matrix status = -1 : not available (inversion failed or Hesse failed) status = 0 : available but not positive defined status = 1 : covariance only approximate status = 2 : full matrix but forced pos def status = 3 : full accurate matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 1298 of file Minuit2Minimizer.cxx.
|
inlineoverridevirtual |
return expected distance reached from the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 140 of file Minuit2Minimizer.h.
|
overridevirtual |
return errors at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 717 of file Minuit2Minimizer.cxx.
|
protected |
examine the minimum result
Definition at line 594 of file Minuit2Minimizer.cxx.
fix an existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 338 of file Minuit2Minimizer.cxx.
Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero.
The array will be filled as cov[i *ndim + j] The ordering of the variables is the same as in errors and parameter value. This is different from the direct interface of Minuit2 or TMinuit where the values were obtained only to variable parameters
Reimplemented from ROOT::Math::Minimizer.
Definition at line 755 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 287 of file Minuit2Minimizer.h.
Fill the passed array with the Hessian matrix elements The Hessian matrix is the matrix of the second derivatives and is the inverse of the covariance matrix If the variable is fixed or const the values for that variables are zero.
The array will be filled as h[i *ndim + j]
Reimplemented from ROOT::Math::Minimizer.
Definition at line 784 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 281 of file Minuit2Minimizer.h.
|
overridevirtual |
get the minos error for parameter i, return false if Minos failed A minimizaiton must be performed befre, return false if no minimization has been done In case of Minos failed the status error is updated as following status += 10 * minosStatus.
The Minos status of last Minos run can also be retrieved by calling MinosStatus()
Reimplemented from ROOT::Math::Minimizer.
Definition at line 852 of file Minuit2Minimizer.cxx.
|
overridevirtual |
get variable settings in a variable object (like ROOT::Fit::ParamsSettings)
Reimplemented from ROOT::Math::Minimizer.
Definition at line 367 of file Minuit2Minimizer.cxx.
get global correlation coefficient for the variable i.
This is a number between zero and one which gives the correlation between the i-th variable and that linear combination of all other variables which is most strongly correlated with i. If the variable is fixed or const the return value is zero
Reimplemented from ROOT::Math::Minimizer.
Definition at line 835 of file Minuit2Minimizer.cxx.
|
overridevirtual |
perform a full calculation of the Hessian matrix for error calculation If a valid minimum exists the calculation is done on the minimum point otherwise is performed in the current set values of parameters Status code of minimizer is updated according to the following convention (in case Hesse failed) status += 100*hesseStatus where hesse status is: status = 1 : hesse failed status = 2 : matrix inversion failed status = 3 : matrix is not pos defined
Reimplemented from ROOT::Math::Minimizer.
Definition at line 1204 of file Minuit2Minimizer.cxx.
query if an existing variable is fixed (i.e.
considered constant in the minimization) note that by default all variables are not fixed
Reimplemented from ROOT::Math::Minimizer.
Definition at line 356 of file Minuit2Minimizer.cxx.
|
inlineoverridevirtual |
return pointer to gradient values at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 146 of file Minuit2Minimizer.h.
|
overridevirtual |
method to perform the minimization.
Return false in case the minimization did not converge. In this case a status code different than zero is set (retrieved by the derived method Minimizer::Status() )"
status = 1 : Covariance was made pos defined status = 2 : Hesse is invalid status = 3 : Edm is above max status = 4 : Reached call limit status = 5 : Any other failure
Implements ROOT::Math::Minimizer.
Definition at line 465 of file Minuit2Minimizer.cxx.
|
inlineoverridevirtual |
MINOS status code of last Minos run status & 1 > 0
: invalid lower error status & 2 > 0
: invalid upper error status & 4 > 0
: invalid because maximum number of function calls exceeded status & 8 > 0
: a new minimum has been found status & 16 > 0
: error is truncated because parameter is at lower/upper limit.
Reimplemented from ROOT::Math::Minimizer.
Definition at line 234 of file Minuit2Minimizer.h.
|
inlineoverridevirtual |
return minimum function value
Implements ROOT::Math::Minimizer.
Definition at line 137 of file Minuit2Minimizer.h.
|
inlineoverridevirtual |
number of function calls to reach the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 149 of file Minuit2Minimizer.h.
|
inlineoverridevirtual |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones)
Implements ROOT::Math::Minimizer.
Definition at line 153 of file Minuit2Minimizer.h.
|
inlineoverridevirtual |
number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total
Reimplemented from ROOT::Math::Minimizer.
Definition at line 157 of file Minuit2Minimizer.h.
|
overridevirtual |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const;
print result of minimization
Reimplemented from ROOT::Math::Minimizer.
Definition at line 684 of file Minuit2Minimizer.cxx.
|
inlineoverridevirtual |
minimizer provides error and error matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 160 of file Minuit2Minimizer.h.
release an existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 347 of file Minuit2Minimizer.cxx.
|
protected |
Definition at line 923 of file Minuit2Minimizer.cxx.
|
overridevirtual |
scan a parameter i around the minimum.
A minimization must have been done before, return false if it is not the case
Reimplemented from ROOT::Math::Minimizer.
Definition at line 1089 of file Minuit2Minimizer.cxx.
|
overrideprotectedvirtual |
set initial covariance matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 212 of file Minuit2Minimizer.cxx.
|
overrideprotectedvirtual |
set initial second derivatives
Reimplemented from ROOT::Math::Minimizer.
Definition at line 198 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set fixed variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 251 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the function to minimize
Implements ROOT::Math::Minimizer.
Definition at line 391 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the function implementing Hessian computation
Reimplemented from ROOT::Math::Minimizer.
Definition at line 424 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set upper/lower limited variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 241 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set lower limit variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 221 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 283 of file Minuit2Minimizer.h.
|
protected |
Definition at line 116 of file Minuit2Minimizer.cxx.
void ROOT::Minuit2::Minuit2Minimizer::SetStorageLevel | ( | int | level | ) |
set storage level = 1 : store all iteration states (default) = 0 : store only first and last state to save memory
Definition at line 1332 of file Minuit2Minimizer.cxx.
void ROOT::Minuit2::Minuit2Minimizer::SetTraceObject | ( | MnTraceObject & | obj | ) |
set an object to trace operation for each iteration The object must be a (or inherit from) ROOT::Minuit2::MnTraceObject and implement operator() (int, const MinimumState & state)
Definition at line 1325 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set upper limit variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 231 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set free variable
Implements ROOT::Math::Minimizer.
Definition at line 168 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the limits of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 328 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the lower-limit of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 309 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the step size of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 299 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set the upper-limit of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 318 of file Minuit2Minimizer.cxx.
|
overridevirtual |
set variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 279 of file Minuit2Minimizer.cxx.
set the values of all existing variables (array must be dimensioned to the size of the existing parameters)
Reimplemented from ROOT::Math::Minimizer.
Definition at line 288 of file Minuit2Minimizer.cxx.
|
inline |
return the minimizer state (containing values, step size , etc..)
Definition at line 276 of file Minuit2Minimizer.h.
|
overridevirtual |
get index of variable given a variable given a name return -1 if variable is not found
Reimplemented from ROOT::Math::Minimizer.
Definition at line 272 of file Minuit2Minimizer.cxx.
|
overridevirtual |
get name of variables (override if minimizer support storing of variable names)
Reimplemented from ROOT::Math::Minimizer.
Definition at line 264 of file Minuit2Minimizer.cxx.
|
inlineoverridevirtual |
return pointer to X values at the minimum
Implements ROOT::Math::Minimizer.
Definition at line 143 of file Minuit2Minimizer.h.
|
private |
Definition at line 302 of file Minuit2Minimizer.h.
|
mutableprivate |
Definition at line 312 of file Minuit2Minimizer.h.
|
private |
Definition at line 308 of file Minuit2Minimizer.h.
|
private |
Definition at line 310 of file Minuit2Minimizer.h.
|
private |
Definition at line 304 of file Minuit2Minimizer.h.
|
private |
Definition at line 309 of file Minuit2Minimizer.h.
|
private |
Definition at line 306 of file Minuit2Minimizer.h.
|
private |
Definition at line 303 of file Minuit2Minimizer.h.
|
mutableprivate |
Definition at line 311 of file Minuit2Minimizer.h.