ROOT
6.07/01
Reference Guide
|
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).
Definition at line 61 of file Minuit2Minimizer.h.
Public Member Functions | |
Minuit2Minimizer (ROOT::Minuit2::EMinimizerType type=ROOT::Minuit2::kMigrad) | |
Default constructor. More... | |
Minuit2Minimizer (const char *type) | |
Constructor with a char (used by PM) More... | |
virtual | ~Minuit2Minimizer () |
Destructor (no operations) More... | |
virtual void | Clear () |
reset for consecutive minimizations - implement if needed More... | |
virtual void | SetFunction (const ROOT::Math::IMultiGenFunction &func) |
set the function to minimize More... | |
virtual void | SetFunction (const ROOT::Math::IMultiGradFunction &func) |
set gradient the function to minimize More... | |
virtual bool | SetVariable (unsigned int ivar, const std::string &name, double val, double step) |
set free variable More... | |
virtual bool | SetLowerLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower) |
set lower limit variable (override if minimizer supports them ) More... | |
virtual bool | SetUpperLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double upper) |
set upper limit variable (override if minimizer supports them ) More... | |
virtual bool | SetLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double, double) |
set upper/lower limited variable (override if minimizer supports them ) More... | |
virtual bool | SetFixedVariable (unsigned int, const std::string &, double) |
set fixed variable (override if minimizer supports them ) More... | |
virtual bool | SetVariableValue (unsigned int ivar, double val) |
set variable More... | |
virtual bool | SetVariableValues (const double *val) |
set the values of all existing variables (array must be dimensioned to the size of the existing parameters) More... | |
virtual bool | SetVariableStepSize (unsigned int ivar, double step) |
set the step size of an already existing variable More... | |
virtual bool | SetVariableLowerLimit (unsigned int ivar, double lower) |
set the lower-limit of an already existing variable More... | |
virtual bool | SetVariableUpperLimit (unsigned int ivar, double upper) |
set the upper-limit of an already existing variable More... | |
virtual bool | SetVariableLimits (unsigned int ivar, double lower, double upper) |
set the limits of an already existing variable More... | |
virtual bool | FixVariable (unsigned int ivar) |
fix an existing variable More... | |
virtual bool | ReleaseVariable (unsigned int ivar) |
release an existing variable More... | |
virtual bool | IsFixedVariable (unsigned int ivar) const |
query if an existing variable is fixed (i.e. More... | |
virtual bool | GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &varObj) const |
get variable settings in a variable object (like ROOT::Fit::ParamsSettings) More... | |
virtual std::string | VariableName (unsigned int ivar) const |
get name of variables (override if minimizer support storing of variable names) More... | |
virtual int | VariableIndex (const std::string &name) const |
get index of variable given a variable given a name return -1 if variable is not found More... | |
virtual bool | Minimize () |
method to perform the minimization. More... | |
virtual double | MinValue () const |
return minimum function value More... | |
virtual double | Edm () const |
return expected distance reached from the minimum More... | |
virtual const double * | X () const |
return pointer to X values at the minimum More... | |
virtual const double * | MinGradient () const |
return pointer to gradient values at the minimum More... | |
virtual unsigned int | NCalls () const |
number of function calls to reach the minimum More... | |
virtual unsigned int | NDim () const |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones) More... | |
virtual unsigned int | NFree () const |
number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total More... | |
virtual bool | ProvidesError () const |
minimizer provides error and error matrix More... | |
virtual const double * | Errors () const |
return errors at the minimum More... | |
virtual double | CovMatrix (unsigned int i, unsigned int j) const |
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. More... | |
virtual bool | GetCovMatrix (double *cov) const |
Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero. More... | |
virtual bool | GetHessianMatrix (double *h) const |
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. More... | |
virtual int | CovMatrixStatus () const |
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 More... | |
virtual double | Correlation (unsigned int i, unsigned int j) const |
return correlation coefficient between variable i and j. More... | |
virtual double | GlobalCC (unsigned int i) const |
get global correlation coefficient for the variable i. More... | |
virtual bool | GetMinosError (unsigned int i, double &errLow, double &errUp, int=0) |
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 where the minos status is: status = 1 : maximum number of function calls exceeded when running for lower error status = 2 : maximum number of function calls exceeded when running for upper error status = 3 : new minimum found when running for lower error status = 4 : new minimum found when running for upper error status = 5 : any other failure More... | |
virtual bool | Scan (unsigned int i, unsigned int &nstep, double *x, double *y, double xmin=0, double xmax=0) |
scan a parameter i around the minimum. More... | |
virtual bool | Contour (unsigned int i, unsigned int j, unsigned int &npoints, double *xi, double *xj) |
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(); More... | |
virtual bool | Hesse () |
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 More... | |
virtual void | PrintResults () |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const; More... | |
void | SetTraceObject (MnTraceObject &obj) |
set an object to trace operation for each iteration The object muust implement operator() (unsigned int, MinimumState & state) More... | |
void | SetStorageLevel (int level) |
set storage level = 1 : store all iteration states (default) = 0 : store only first and last state to save memory More... | |
const ROOT::Minuit2::MnUserParameterState & | State () |
return the minimizer state (containing values, step size , etc..) More... | |
Public Member Functions inherited from ROOT::Math::Minimizer | |
Minimizer () | |
Default constructor. More... | |
virtual | ~Minimizer () |
Destructor (no operations) More... | |
template<class VariableIterator > | |
int | SetVariables (const VariableIterator &begin, const VariableIterator &end) |
add variables . Return number of variables successfully added More... | |
virtual bool | SetVariableInitialRange (unsigned int, double, double) |
set the initial range of an existing variable More... | |
virtual unsigned int | NIterations () const |
number of iterations to reach the minimum More... | |
int | PrintLevel () const |
minimizer configuration parameters More... | |
unsigned int | MaxFunctionCalls () const |
max number of function calls More... | |
unsigned int | MaxIterations () const |
max iterations More... | |
double | Tolerance () const |
absolute tolerance More... | |
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) More... | |
int | Strategy () const |
strategy More... | |
int | Status () const |
status code of minimizer More... | |
double | ErrorDef () const |
return the statistical scale used for calculate the error is typically 1 for Chi2 and 0.5 for likelihood minimization More... | |
bool | IsValidError () const |
return true if Minimizer has performed a detailed error validation (e.g. run Hesse for Minuit) More... | |
virtual MinimizerOptions | Options () const |
retrieve the minimizer options (implement derived class if needed) More... | |
void | SetPrintLevel (int level) |
set print level More... | |
void | SetMaxFunctionCalls (unsigned int maxfcn) |
set maximum of function calls More... | |
void | SetMaxIterations (unsigned int maxiter) |
set maximum iterations (one iteration can have many function calls) More... | |
void | SetTolerance (double tol) |
set the tolerance More... | |
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. More... | |
void | SetStrategy (int strategyLevel) |
set the strategy More... | |
void | SetErrorDef (double up) |
set scale for calculating the errors More... | |
void | SetValidError (bool on) |
flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit) More... | |
void | SetOptions (const MinimizerOptions &opt) |
set all options in one go More... | |
void | SetDefaultOptions () |
reset the defaut options (defined in MinimizerOptions) More... | |
Protected Member Functions | |
virtual const ROOT::Minuit2::ModularFunctionMinimizer * | GetMinimizer () const |
virtual void | SetMinimizer (ROOT::Minuit2::ModularFunctionMinimizer *m) |
void | SetMinimizerType (ROOT::Minuit2::EMinimizerType type) |
virtual const ROOT::Minuit2::FCNBase * | GetFCN () const |
bool | ExamineMinimum (const ROOT::Minuit2::FunctionMinimum &min) |
examine the minimum result More... | |
Private Member Functions | |
Minuit2Minimizer (const Minuit2Minimizer &) | |
Copy constructor. More... | |
Minuit2Minimizer & | operator= (const Minuit2Minimizer &rhs) |
Assignment operator. More... | |
Private Attributes | |
unsigned int | fDim |
bool | fUseFumili |
ROOT::Minuit2::MnUserParameterState | fState |
ROOT::Minuit2::ModularFunctionMinimizer * | fMinimizer |
ROOT::Minuit2::FCNBase * | fMinuitFCN |
ROOT::Minuit2::FunctionMinimum * | fMinimum |
std::vector< double > | fValues |
std::vector< double > | fErrors |
Additional Inherited Members | |
Protected Attributes inherited from ROOT::Math::Minimizer | |
bool | fValidError |
MinimizerOptions | fOptions |
int | fStatus |
#include <Minuit2/Minuit2Minimizer.h>
ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer | ( | ROOT::Minuit2::EMinimizerType | type = ROOT::Minuit2::kMigrad | ) |
Default constructor.
Definition at line 82 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.
|
virtual |
Destructor (no operations)
Definition at line 145 of file Minuit2Minimizer.cxx.
|
private |
Copy constructor.
Definition at line 153 of file Minuit2Minimizer.cxx.
|
virtual |
reset for consecutive minimizations - implement if needed
Reimplemented from ROOT::Math::Minimizer.
Definition at line 167 of file Minuit2Minimizer.cxx.
|
virtual |
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 961 of file Minuit2Minimizer.cxx.
|
virtual |
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 728 of file Minuit2Minimizer.cxx.
|
virtual |
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 661 of file Minuit2Minimizer.cxx.
|
virtual |
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 1102 of file Minuit2Minimizer.cxx.
|
inlinevirtual |
return expected distance reached from the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 160 of file Minuit2Minimizer.h.
|
virtual |
return errors at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 641 of file Minuit2Minimizer.cxx.
|
protected |
examine the minimum result
Definition at line 527 of file Minuit2Minimizer.cxx.
Referenced by Minimize().
|
virtual |
fix an existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 304 of file Minuit2Minimizer.cxx.
|
virtual |
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 672 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 306 of file Minuit2Minimizer.h.
Referenced by Minimize().
|
virtual |
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 699 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 300 of file Minuit2Minimizer.h.
Referenced by Minimize().
|
virtual |
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 where the minos status is: status = 1 : maximum number of function calls exceeded when running for lower error status = 2 : maximum number of function calls exceeded when running for upper error status = 3 : new minimum found when running for lower error status = 4 : new minimum found when running for upper error status = 5 : any other failure
Reimplemented from ROOT::Math::Minimizer.
Definition at line 756 of file Minuit2Minimizer.cxx.
|
virtual |
get variable settings in a variable object (like ROOT::Fit::ParamsSettings)
Reimplemented from ROOT::Math::Minimizer.
Definition at line 327 of file Minuit2Minimizer.cxx.
|
virtual |
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 742 of file Minuit2Minimizer.cxx.
|
virtual |
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 1018 of file Minuit2Minimizer.cxx.
|
virtual |
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 318 of file Minuit2Minimizer.cxx.
|
inlinevirtual |
return pointer to gradient values at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 166 of file Minuit2Minimizer.h.
|
virtual |
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 380 of file Minuit2Minimizer.cxx.
|
inlinevirtual |
return minimum function value
Implements ROOT::Math::Minimizer.
Definition at line 157 of file Minuit2Minimizer.h.
|
inlinevirtual |
number of function calls to reach the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 169 of file Minuit2Minimizer.h.
|
inlinevirtual |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones)
Implements ROOT::Math::Minimizer.
Definition at line 173 of file Minuit2Minimizer.h.
|
inlinevirtual |
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 177 of file Minuit2Minimizer.h.
|
private |
Assignment operator.
Definition at line 159 of file Minuit2Minimizer.cxx.
|
virtual |
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 595 of file Minuit2Minimizer.cxx.
Referenced by ExamineMinimum().
|
inlinevirtual |
minimizer provides error and error matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 180 of file Minuit2Minimizer.h.
|
virtual |
release an existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 311 of file Minuit2Minimizer.cxx.
|
virtual |
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 903 of file Minuit2Minimizer.cxx.
|
virtual |
set fixed variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 231 of file Minuit2Minimizer.cxx.
|
virtual |
set the function to minimize
Implements ROOT::Math::Minimizer.
Definition at line 344 of file Minuit2Minimizer.cxx.
|
virtual |
set gradient the function to minimize
Reimplemented from ROOT::Math::Minimizer.
Definition at line 362 of file Minuit2Minimizer.cxx.
|
virtual |
set upper/lower limited variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 224 of file Minuit2Minimizer.cxx.
|
virtual |
set lower limit variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 208 of file Minuit2Minimizer.cxx.
|
inlineprotectedvirtual |
Definition at line 302 of file Minuit2Minimizer.h.
Referenced by SetMinimizerType().
|
protected |
Definition at line 115 of file Minuit2Minimizer.cxx.
Referenced by Minuit2Minimizer().
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 1131 of file Minuit2Minimizer.cxx.
Referenced by Minimize().
void ROOT::Minuit2::Minuit2Minimizer::SetTraceObject | ( | MnTraceObject & | obj | ) |
set an object to trace operation for each iteration The object muust implement operator() (unsigned int, MinimumState & state)
Definition at line 1125 of file Minuit2Minimizer.cxx.
Referenced by Minimize().
|
virtual |
set upper limit variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 215 of file Minuit2Minimizer.cxx.
|
virtual |
set free variable
Implements ROOT::Math::Minimizer.
Definition at line 178 of file Minuit2Minimizer.cxx.
Referenced by SetFixedVariable(), SetLimitedVariable(), SetLowerLimitedVariable(), and SetUpperLimitedVariable().
|
virtual |
set the limits of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 296 of file Minuit2Minimizer.cxx.
|
virtual |
set the lower-limit of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 281 of file Minuit2Minimizer.cxx.
|
virtual |
set the step size of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 273 of file Minuit2Minimizer.cxx.
|
virtual |
set the upper-limit of an already existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 288 of file Minuit2Minimizer.cxx.
|
virtual |
set variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 257 of file Minuit2Minimizer.cxx.
|
virtual |
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 264 of file Minuit2Minimizer.cxx.
|
inline |
return the minimizer state (containing values, step size , etc..)
Definition at line 294 of file Minuit2Minimizer.h.
|
virtual |
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 250 of file Minuit2Minimizer.cxx.
|
virtual |
get name of variables (override if minimizer support storing of variable names)
Reimplemented from ROOT::Math::Minimizer.
Definition at line 243 of file Minuit2Minimizer.cxx.
|
virtual |
return pointer to X values at the minimum
Implements ROOT::Math::Minimizer.
Definition at line 625 of file Minuit2Minimizer.cxx.
|
private |
Definition at line 313 of file Minuit2Minimizer.h.
Referenced by Correlation(), CovMatrix(), Errors(), GetCovMatrix(), GetHessianMatrix(), GlobalCC(), NDim(), SetFunction(), and X().
|
mutableprivate |
Definition at line 322 of file Minuit2Minimizer.h.
Referenced by Errors().
|
private |
Definition at line 318 of file Minuit2Minimizer.h.
Referenced by GetMinimizer(), Minimize(), SetMinimizer(), SetStorageLevel(), SetTraceObject(), and ~Minuit2Minimizer().
|
private |
Definition at line 320 of file Minuit2Minimizer.h.
Referenced by Clear(), Contour(), CovMatrixStatus(), GetMinosError(), Hesse(), Minimize(), PrintResults(), and ~Minuit2Minimizer().
|
private |
Definition at line 319 of file Minuit2Minimizer.h.
Referenced by Contour(), GetFCN(), GetMinosError(), Hesse(), Minimize(), Scan(), SetFunction(), and ~Minuit2Minimizer().
|
private |
Definition at line 316 of file Minuit2Minimizer.h.
Referenced by Clear(), Contour(), Correlation(), CovMatrix(), CovMatrixStatus(), Edm(), Errors(), ExamineMinimum(), FixVariable(), GetCovMatrix(), GetHessianMatrix(), GetMinosError(), GetVariableSettings(), GlobalCC(), Hesse(), IsFixedVariable(), Minimize(), MinValue(), NCalls(), NFree(), PrintResults(), ReleaseVariable(), Scan(), SetFixedVariable(), SetLimitedVariable(), SetLowerLimitedVariable(), SetUpperLimitedVariable(), SetVariable(), SetVariableLimits(), SetVariableLowerLimit(), SetVariableStepSize(), SetVariableUpperLimit(), SetVariableValue(), SetVariableValues(), State(), VariableIndex(), VariableName(), and X().
|
private |
Definition at line 314 of file Minuit2Minimizer.h.
Referenced by SetFunction(), and SetMinimizerType().
|
mutableprivate |
Definition at line 321 of file Minuit2Minimizer.h.
Referenced by X().