TLinearMinimizer class: minimizer implementation based on TMinuit.
Definition at line 31 of file TLinearMinimizer.h.
Public Member Functions | |
TLinearMinimizer (const char *type) | |
Constructor from a char * (used by PM) | |
TLinearMinimizer (int type=0) | |
Default constructor. | |
virtual | ~TLinearMinimizer () |
Destructor (no operations) | |
virtual double | CovMatrix (unsigned int i, unsigned int j) const |
return covariance matrices elements if the variable is fixed the matrix is zero The ordering of the variables is the same as in errors | |
virtual int | CovMatrixStatus () const |
return covariance matrix status | |
virtual double | Edm () const |
return expected distance reached from the minimum | |
virtual const double * | Errors () const |
return errors at the minimum | |
virtual const double * | MinGradient () const |
return pointer to gradient values at the minimum | |
virtual bool | Minimize () |
method to perform the minimization | |
virtual double | MinValue () const |
return minimum function value | |
virtual unsigned int | NCalls () const |
number of function calls to reach the minimum | |
virtual unsigned int | NDim () const |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones) | |
virtual unsigned int | NFree () const |
number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total | |
virtual bool | ProvidesError () const |
minimizer provides error and error matrix | |
virtual bool | SetFixedVariable (unsigned int, const std::string &, double) |
set fixed variable (override if minimizer supports them ) | |
virtual void | SetFunction (const ROOT::Math::IMultiGenFunction &func) |
set the fit model function | |
virtual void | SetFunction (const ROOT::Math::IMultiGradFunction &func) |
set the function to minimize | |
virtual bool | SetVariable (unsigned int, const std::string &, double, double) |
set free variable (dummy impl. ) | |
virtual const double * | X () const |
return pointer to X values at the minimum | |
![]() | |
Minimizer () | |
Default constructor. | |
virtual | ~Minimizer () |
Destructor (no operations) | |
virtual void | Clear () |
reset for consecutive minimizations - 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 The contour will be find for value of the function = Min + ErrorUp(); | |
virtual double | Correlation (unsigned int i, unsigned int j) const |
return correlation coefficient between variable i and j. | |
double | ErrorDef () const |
return the statistical scale used for calculate the error is typically 1 for Chi2 and 0.5 for likelihood minimization | |
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 double | GlobalCC (unsigned int ivar) const |
return global correlation coefficient for variable i This is a number between zero and one which gives the correlation between the i-th parameter and that linear combination of all other parameters which is most strongly correlated with i. | |
virtual bool | Hesse () |
perform a full calculation of the Hessian matrix for error calculation | |
virtual bool | IsFixedVariable (unsigned int ivar) const |
query if an existing variable is fixed (i.e. | |
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 int | MinosStatus () const |
status code of Minos (to be re-implemented by the minimizers supporting Minos) | |
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 ( a value <=0 corresponds to the let the minimizer choose its default one) | |
int | PrintLevel () const |
minimizer configuration parameters | |
virtual void | PrintResults () |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const = 0; | |
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. | |
void | SetDefaultOptions () |
reset the defaut options (defined in MinimizerOptions) | |
void | SetErrorDef (double up) |
set scale for calculating the errors | |
void | SetExtraOptions (const IOptions &extraOptions) |
set only the extra options | |
virtual bool | SetLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower, double upper) |
set a new upper/lower limited variable (override if minimizer supports them ) otherwise as default set an unlimited variable | |
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 ) | |
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 | |
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 ) | |
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 | |
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 . Return number of variables successfully added | |
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 | |
virtual bool | SetVariableValue (unsigned int ivar, double value) |
set the value of an already 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 | |
double | Tolerance () const |
absolute tolerance | |
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 | |
virtual std::string | VariableName (unsigned int ivar) const |
get name of variables (override if minimizer support storing of variable names) return an empty string if variable is not found | |
Private Member Functions | |
TLinearMinimizer (const TLinearMinimizer &) | |
Copy constructor. | |
TLinearMinimizer & | operator= (const TLinearMinimizer &rhs) |
Assignment operator. | |
Private Attributes | |
std::vector< double > | fCovar |
unsigned int | fDim |
std::vector< double > | fErrors |
TLinearFitter * | fFitter |
double | fMinVal |
unsigned int | fNFree |
const ROOT::Math::IMultiGradFunction * | fObjFunc |
std::vector< double > | fParams |
bool | fRobust |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const; | |
Additional Inherited Members | |
![]() | |
MinimizerOptions | fOptions |
int | fStatus |
bool | fValidError |
#include <TLinearMinimizer.h>
TLinearMinimizer::TLinearMinimizer | ( | int | type = 0 | ) |
Default constructor.
Definition at line 71 of file TLinearMinimizer.cxx.
TLinearMinimizer::TLinearMinimizer | ( | const char * | type | ) |
Constructor from a char * (used by PM)
Definition at line 83 of file TLinearMinimizer.cxx.
|
virtual |
Destructor (no operations)
Definition at line 101 of file TLinearMinimizer.cxx.
|
private |
Copy constructor.
Definition at line 107 of file TLinearMinimizer.cxx.
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 113 of file TLinearMinimizer.h.
|
inlinevirtual |
return covariance matrix status
Reimplemented from ROOT::Math::Minimizer.
Definition at line 118 of file TLinearMinimizer.h.
|
inlinevirtual |
return expected distance reached from the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 84 of file TLinearMinimizer.h.
|
inlinevirtual |
return errors at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 107 of file TLinearMinimizer.h.
|
inlinevirtual |
return pointer to gradient values at the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 90 of file TLinearMinimizer.h.
|
virtual |
method to perform the minimization
Implements ROOT::Math::Minimizer.
Definition at line 194 of file TLinearMinimizer.cxx.
|
inlinevirtual |
return minimum function value
Implements ROOT::Math::Minimizer.
Definition at line 81 of file TLinearMinimizer.h.
|
inlinevirtual |
number of function calls to reach the minimum
Reimplemented from ROOT::Math::Minimizer.
Definition at line 93 of file TLinearMinimizer.h.
|
inlinevirtual |
this is <= Function().NDim() which is the total number of variables (free+ constrained ones)
Implements ROOT::Math::Minimizer.
Definition at line 97 of file TLinearMinimizer.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 101 of file TLinearMinimizer.h.
|
private |
Assignment operator.
Definition at line 113 of file TLinearMinimizer.cxx.
|
inlinevirtual |
minimizer provides error and error matrix
Reimplemented from ROOT::Math::Minimizer.
Definition at line 104 of file TLinearMinimizer.h.
|
virtual |
set fixed variable (override if minimizer supports them )
Reimplemented from ROOT::Math::Minimizer.
Definition at line 187 of file TLinearMinimizer.cxx.
|
virtual |
set the fit model function
Implements ROOT::Math::Minimizer.
Definition at line 121 of file TLinearMinimizer.cxx.
|
virtual |
set the function to minimize
Reimplemented from ROOT::Math::Minimizer.
Definition at line 128 of file TLinearMinimizer.cxx.
|
inlinevirtual |
set free variable (dummy impl. )
Implements ROOT::Math::Minimizer.
Definition at line 72 of file TLinearMinimizer.h.
|
inlinevirtual |
return pointer to X values at the minimum
Implements ROOT::Math::Minimizer.
Definition at line 87 of file TLinearMinimizer.h.
|
private |
Definition at line 139 of file TLinearMinimizer.h.
|
private |
Definition at line 134 of file TLinearMinimizer.h.
|
private |
Definition at line 138 of file TLinearMinimizer.h.
|
private |
Definition at line 142 of file TLinearMinimizer.h.
|
private |
Definition at line 136 of file TLinearMinimizer.h.
|
private |
Definition at line 135 of file TLinearMinimizer.h.
|
private |
Definition at line 141 of file TLinearMinimizer.h.
|
private |
Definition at line 137 of file TLinearMinimizer.h.
|
private |
return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const;
Definition at line 133 of file TLinearMinimizer.h.