TFumiliMinimizer class: minimizer implementation based on TFumili.
Definition at line 43 of file TFumiliMinimizer.h.
Public Member Functions | |
| TFumiliMinimizer (int dummy=0) | |
| Default constructor (an argument is needed by plug-in manager). | |
| ~TFumiliMinimizer () override | |
| Destructor (no operations). | |
| virtual void | Clear () |
| Reset for consecutive minimization - implement if needed. | |
| virtual bool | Contour (unsigned int ivar, unsigned int jvar, unsigned int &npoints, double *xi, double *xj) |
| Find the contour points (xi, xj) of the function for parameter ivar and jvar around the minimum. | |
| virtual double | Correlation (unsigned int i, unsigned int j) const |
| double | CovMatrix (unsigned int i, unsigned int j) const override |
| return covariance matrices elements if the variable is fixed the matrix is zero The ordering of the variables is the same as in errors | |
| int | CovMatrixStatus () const override |
| double | Edm () const override |
| return expected distance reached from the minimum | |
| double | ErrorDef () const |
| const double * | Errors () const override |
| return errors at the minimum | |
| virtual bool | FixVariable (unsigned int ivar) |
| Fix an existing variable. | |
| virtual bool | GetCovMatrix (double *covMat) const |
| Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero. | |
| virtual bool | GetHessianMatrix (double *hMat) 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. | |
| virtual bool | GetMinosError (unsigned int ivar, double &errLow, double &errUp, int option=0) |
| Minos error for variable i, return false if Minos failed or not supported and the lower and upper errors are returned in errLow and errUp An extra flag specifies if only the lower (option=-1) or the upper (option=+1) error calculation is run. | |
| virtual bool | GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &pars) const |
| Get variable settings in a variable object (like ROOT::Fit::ParamsSettings). | |
| virtual std::vector< double > | GlobalCC () const |
| virtual bool | Hesse () |
| Perform a full calculation of the Hessian matrix for error calculation. | |
| virtual TClass * | IsA () const |
| virtual bool | IsFixedVariable (unsigned int ivar) const |
| Query if an existing variable is fixed (i.e. | |
| bool | IsValidError () const |
| unsigned int | MaxFunctionCalls () const |
| Max number of function calls. | |
| unsigned int | MaxIterations () const |
| Max iterations. | |
| const double * | MinGradient () const override |
| return pointer to gradient values at the minimum | |
| bool | Minimize () override |
| method to perform the minimization | |
| virtual int | MinosStatus () const |
| Status code of Minos (to be re-implemented by the minimizers supporting Minos). | |
| 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 | |
| virtual unsigned int | NIterations () const |
| Number of iterations to reach the minimum. | |
| 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. | |
| int | PrintLevel () const |
| Set print level. | |
| virtual void | PrintResults () |
| Print the result according to set level (implemented for TMinuit for maintaining Minuit-style printing). | |
| bool | ProvidesError () const override |
| minimizer provides error and error matrix | |
| virtual bool | ReleaseVariable (unsigned int ivar) |
| Release an existing variable. | |
| virtual bool | Scan (unsigned int ivar, unsigned int &nstep, double *x, double *y, double xmin=0, double xmax=0) |
| Scan function minimum for variable i. | |
| virtual bool | SetCovariance (std::span< const double > cov, unsigned int nrow) |
| Set initial covariance matrix. | |
| virtual bool | SetCovarianceDiag (std::span< const double > d2, unsigned int n) |
| Set initial second derivatives. | |
| 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. | |
| 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 | |
| virtual void | SetHessianFunction (std::function< bool(std::span< const double >, double *)>) |
| Set the function implementing Hessian computation (re-implemented by Minimizer using it). | |
| 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 ) | |
| virtual bool | SetLowerLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower) |
| Set a new lower limit variable (override if minimizer supports them), leave upper bound unlimited. | |
| 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. | |
| void | SetPrintLevel (int level) |
| Set print level. | |
| void | SetStrategy (int strategyLevel) |
| Set the strategy. | |
| void | SetTolerance (double tol) |
| Set the tolerance. | |
| virtual bool | SetUpperLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double upper) |
| Set a new upper limit variable (override if minimizer supports them), leave lower bound unlimited. | |
| void | SetValidError (bool on) |
| Flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit). | |
| bool | SetVariable (unsigned int ivar, const std::string &name, double val, double step) override |
| set free variable | |
| virtual bool | SetVariableInitialRange (unsigned int, double, double) |
| Set the initial range of an existing variable. | |
| virtual bool | SetVariableLimits (unsigned int ivar, double lower, double upper) |
| Set the limits of an already existing variable. | |
| virtual bool | SetVariableLowerLimit (unsigned int ivar, double lower) |
| Set the lower-limit of an already existing variable. | |
| template<class VariableIterator> | |
| int | SetVariables (const VariableIterator &begin, const VariableIterator &end) |
| Add variables. | |
| virtual bool | SetVariableStepSize (unsigned int ivar, double value) |
| Set the step size of an already existing variable. | |
| virtual bool | SetVariableUpperLimit (unsigned int ivar, double upper) |
| Set the upper-limit of an already existing variable. | |
| bool | SetVariableValue (unsigned int ivar, double val) override |
| set the value of an existing variable | |
| virtual bool | SetVariableValues (const double *x) |
| Set the values of all existing variables (array must be dimensioned to the size of the existing parameters). | |
| int | Status () const |
| Status code of minimizer. | |
| int | Strategy () const |
| Strategy. | |
| virtual void | Streamer (TBuffer &) |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| double | Tolerance () const |
| Absolute tolerance. | |
| virtual int | VariableIndex (const std::string &name) const |
| Get index of variable given a variable given a name. | |
| virtual std::string | VariableName (unsigned int ivar) const |
| 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 | |
Static Public Member Functions | |
| static TClass * | Class () |
| static const char * | Class_Name () |
| static constexpr Version_t | Class_Version () |
| static const char * | DeclFileName () |
Static Protected Member Functions | |
| static double | EvaluateFCN (const double *x, double *g) |
| implementation of FCN for Fumili when user provided gradient is used | |
| static void | Fcn (int &, double *, double &f, double *, int) |
| implementation of FCN for Fumili | |
Protected Attributes | |
| 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) | |
Private Attributes | |
| std::vector< double > | fCovar |
| unsigned int | fDim |
| double | fEdm |
| std::vector< double > | fErrors |
| TFumili * | fFumili |
| double | fMinVal |
| unsigned int | fNFree |
| std::vector< double > | fParams |
Static Private Attributes | |
| static TFumili * | fgFumili = nullptr |
| static ROOT::Math::FitMethodFunction * | fgFunc = nullptr |
| static ROOT::Math::FitMethodGradFunction * | fgGradFunc = nullptr |
#include <TFumiliMinimizer.h>
| TFumiliMinimizer::TFumiliMinimizer | ( | int | dummy = 0 | ) |
Default constructor (an argument is needed by plug-in manager).
Definition at line 136 of file TFumiliMinimizer.cxx.
|
override |
Destructor (no operations).
Definition at line 159 of file TFumiliMinimizer.cxx.
|
static |
|
static |
|
inlinestaticconstexpr |
Definition at line 162 of file TFumiliMinimizer.h.
|
inlinevirtualinherited |
Reset for consecutive minimization - implement if needed.
Reimplemented in ROOT::Math::GeneticMinimizer, and ROOT::Minuit2::Minuit2Minimizer.
Definition at line 141 of file Minimizer.h.
|
virtualinherited |
Find the contour points (xi, xj) of the function for parameter ivar and jvar around the minimum.
The contour will be find for value of the function = Min + ErrorUp();
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 219 of file Minimizer.cxx.
|
inlinevirtualinherited |
Reimplemented in ROOT::Minuit2::Minuit2Minimizer.
Definition at line 281 of file Minimizer.h.
return covariance matrices elements if the variable is fixed the matrix is zero The ordering of the variables is the same as in errors
Reimplemented from ROOT::Math::Minimizer.
Definition at line 116 of file TFumiliMinimizer.h.
|
inlineoverridevirtual |
Reimplemented from ROOT::Math::Minimizer.
Definition at line 123 of file TFumiliMinimizer.h.
|
inlinestatic |
Definition at line 162 of file TFumiliMinimizer.h.
|
inlineoverridevirtual |
return expected distance reached from the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 87 of file TFumiliMinimizer.h.
|
inlineinherited |
Definition at line 334 of file Minimizer.h.
|
inlineoverridevirtual |
return errors at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 110 of file TFumiliMinimizer.h.
implementation of FCN for Fumili when user provided gradient is used
static function implementing the evaluation of the FCN (it uses static instance fgFumili)
Definition at line 239 of file TFumiliMinimizer.cxx.
implementation of FCN for Fumili
Definition at line 220 of file TFumiliMinimizer.cxx.
Fix an existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 95 of file Minimizer.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 in ROOT::Math::RMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 144 of file Minimizer.cxx.
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 in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 157 of file Minimizer.cxx.
|
virtualinherited |
Minos error for variable i, return false if Minos failed or not supported and the lower and upper errors are returned in errLow and errUp An extra flag specifies if only the lower (option=-1) or the upper (option=+1) error calculation is run.
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 180 of file Minimizer.cxx.
|
virtualinherited |
Get variable settings in a variable object (like ROOT::Fit::ParamsSettings).
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 117 of file Minimizer.cxx.
|
virtualinherited |
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 170 of file Minimizer.cxx.
|
virtualinherited |
Perform a full calculation of the Hessian matrix for error calculation.
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 193 of file Minimizer.cxx.
|
inlinevirtual |
Definition at line 162 of file TFumiliMinimizer.h.
Query if an existing variable is fixed (i.e.
considered constant in the minimization).
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 110 of file Minimizer.cxx.
|
inlineinherited |
Definition at line 337 of file Minimizer.h.
|
inlineinherited |
Max number of function calls.
Definition at line 311 of file Minimizer.h.
|
inlineinherited |
Max iterations.
Definition at line 314 of file Minimizer.h.
|
inlineoverridevirtual |
return pointer to gradient values at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 93 of file TFumiliMinimizer.h.
|
overridevirtual |
method to perform the minimization
Implements ROOT::Math::Minimizer.
Definition at line 509 of file TFumiliMinimizer.cxx.
|
inlinevirtualinherited |
Status code of Minos (to be re-implemented by the minimizers supporting Minos).
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 330 of file Minimizer.h.
|
inlineoverridevirtual |
return minimum function value
Implements ROOT::Math::Minimizer.
Definition at line 84 of file TFumiliMinimizer.h.
|
inlineoverridevirtual |
number of function calls to reach the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 96 of file TFumiliMinimizer.h.
|
inlineoverridevirtual |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones)
Implements ROOT::Math::Minimizer.
Definition at line 100 of file TFumiliMinimizer.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 104 of file TFumiliMinimizer.h.
|
inlinevirtualinherited |
Number of iterations to reach the minimum.
Definition at line 248 of file Minimizer.h.
|
inlinevirtualinherited |
Retrieve the minimizer options (implement derived class if needed).
Reimplemented in ROOT::Math::GeneticMinimizer.
Definition at line 340 of file Minimizer.h.
|
inlineinherited |
Precision of minimizer in the evaluation of the objective function.
(a value <=0 corresponds to the let the minimizer choose its default one)
Definition at line 321 of file Minimizer.h.
|
inlineinherited |
Set print level.
Definition at line 308 of file Minimizer.h.
|
inlinevirtualinherited |
Print the result according to set level (implemented for TMinuit for maintaining Minuit-style printing).
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 299 of file Minimizer.h.
|
inlineoverridevirtual |
minimizer provides error and error matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 107 of file TFumiliMinimizer.h.
Release an existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 102 of file Minimizer.cxx.
|
virtualinherited |
Scan function minimum for variable i.
Variable and function must be set before using Scan.
Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 203 of file Minimizer.cxx.
|
virtualinherited |
Set initial covariance matrix.
Set initial values for covariance/error matrix.
The covariance matrix must be provided in compressed form (row-major ordered upper traingular part)
Reimplemented in ROOT::Minuit2::Minuit2Minimizer.
Definition at line 26 of file Minimizer.cxx.
|
virtualinherited |
Set initial second derivatives.
set initial second derivatives
Reimplemented in ROOT::Minuit2::Minuit2Minimizer.
Definition at line 15 of file Minimizer.cxx.
|
inlineinherited |
Reset the default options (defined in MinimizerOptions).
Definition at line 378 of file Minimizer.h.
|
inlineinherited |
Set scale for calculating the errors.
Definition at line 364 of file Minimizer.h.
|
inlineinherited |
Set only the extra options.
Definition at line 375 of file Minimizer.h.
|
overridevirtual |
set fixed variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 461 of file TFumiliMinimizer.cxx.
|
overridevirtual |
set the function to minimize
Implements ROOT::Math::Minimizer.
Definition at line 167 of file TFumiliMinimizer.cxx.
|
inlinevirtualinherited |
Set the function implementing Hessian computation (re-implemented by Minimizer using it).
Reimplemented in ROOT::Minuit2::Minuit2Minimizer.
Definition at line 147 of file Minimizer.h.
|
overridevirtual |
set upper/lower limited variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 434 of file TFumiliMinimizer.cxx.
|
inlinevirtualinherited |
Set a new lower limit variable (override if minimizer supports them), leave upper bound unlimited.
| ivar | the index of this variable in the array |
| name | the variable name |
| val | the value |
| step | the step size |
| lower | the lower bound |
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 186 of file Minimizer.h.
|
inlineinherited |
Set maximum of function calls.
Definition at line 348 of file Minimizer.h.
|
inlineinherited |
Set maximum iterations (one iteration can have many function calls).
Definition at line 351 of file Minimizer.h.
|
inlineinherited |
Set all options in one go.
Definition at line 370 of file Minimizer.h.
|
inlineinherited |
Set in the minimizer the objective function evaluation precision.
(a value <=0 means the minimizer will choose its optimal value automatically, i.e. default case)
Definition at line 358 of file Minimizer.h.
|
inlineinherited |
Set print level.
Definition at line 345 of file Minimizer.h.
|
inlineinherited |
Set the strategy.
Definition at line 361 of file Minimizer.h.
|
inlineinherited |
Set the tolerance.
Definition at line 354 of file Minimizer.h.
|
inlinevirtualinherited |
Set a new upper limit variable (override if minimizer supports them), leave lower bound unlimited.
| ivar | the index of this variable in the array |
| name | the variable name |
| val | the value |
| step | the step size |
| upper | the upper bound |
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 196 of file Minimizer.h.
|
inlineinherited |
Flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit).
Definition at line 367 of file Minimizer.h.
|
overridevirtual |
set free variable
Implements ROOT::Math::Minimizer.
Definition at line 416 of file TFumiliMinimizer.cxx.
|
inlinevirtualinherited |
Set the initial range of an existing variable.
Definition at line 225 of file Minimizer.h.
|
inlinevirtualinherited |
Set the limits of an already existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 216 of file Minimizer.h.
|
virtualinherited |
Set the lower-limit of an already existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 78 of file Minimizer.cxx.
|
inlineinherited |
Add variables.
Definition at line 151 of file Minimizer.h.
|
virtualinherited |
Set the step size of an already existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 70 of file Minimizer.cxx.
|
virtualinherited |
Set the upper-limit of an already existing variable.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 86 of file Minimizer.cxx.
set the value of an existing variable
Reimplemented from ROOT::Math::Minimizer.
Definition at line 483 of file TFumiliMinimizer.cxx.
Set the values of all existing variables (array must be dimensioned to the size of the existing parameters).
Reimplemented in ROOT::Math::BasicMinimizer, and ROOT::Minuit2::Minuit2Minimizer.
Definition at line 204 of file Minimizer.h.
|
inlineinherited |
Status code of minimizer.
Definition at line 327 of file Minimizer.h.
|
inlineinherited |
Strategy.
Definition at line 324 of file Minimizer.h.
|
virtual |
|
inline |
Definition at line 162 of file TFumiliMinimizer.h.
|
inlineinherited |
Absolute tolerance.
Definition at line 317 of file Minimizer.h.
|
virtualinherited |
Get index of variable given a variable given a name.
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 240 of file Minimizer.cxx.
|
virtualinherited |
Get name of variables (override if minimizer support storing of variable names).
Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.
Definition at line 232 of file Minimizer.cxx.
|
inlineoverridevirtual |
return pointer to X values at the minimum
Implements ROOT::Math::Minimizer.
Definition at line 90 of file TFumiliMinimizer.h.
|
private |
Definition at line 151 of file TFumiliMinimizer.h.
|
private |
Definition at line 145 of file TFumiliMinimizer.h.
|
private |
Definition at line 148 of file TFumiliMinimizer.h.
|
private |
Definition at line 150 of file TFumiliMinimizer.h.
|
private |
Definition at line 153 of file TFumiliMinimizer.h.
|
staticprivate |
Definition at line 160 of file TFumiliMinimizer.h.
|
staticprivate |
Definition at line 157 of file TFumiliMinimizer.h.
|
staticprivate |
Definition at line 158 of file TFumiliMinimizer.h.
|
private |
Definition at line 147 of file TFumiliMinimizer.h.
|
private |
Definition at line 146 of file TFumiliMinimizer.h.
|
protectedinherited |
minimizer options
Definition at line 387 of file Minimizer.h.
|
private |
Definition at line 149 of file TFumiliMinimizer.h.
|
protectedinherited |
status of minimizer
Definition at line 388 of file Minimizer.h.
|
protectedinherited |
flag to control if errors have been validated (Hesse has been run in case of Minuit)
Definition at line 386 of file Minimizer.h.