A++ » INCLUDE » TMinuitMinimizer

class TMinuitMinimizer: public ROOT::Math::Minimizer

Function Members (Methods)

public:
virtual~TMinuitMinimizer()
static TClass*Class()
virtual voidROOT::Math::Minimizer::Clear()
virtual boolContour(unsigned int i, unsigned int j, unsigned int& npoints, double* xi, double* xj)
virtual doubleROOT::Math::Minimizer::Correlation(unsigned int i, unsigned int j) const
virtual doubleCovMatrix(unsigned int i, unsigned int j) const
virtual intCovMatrixStatus() const
virtual doubleEdm() const
doubleROOT::Math::Minimizer::ErrorDef() const
virtual const double*Errors() const
virtual boolFixVariable(unsigned int)
virtual boolGetCovMatrix(double* cov) const
virtual boolGetHessianMatrix(double* h) const
virtual boolGetMinosError(unsigned int i, double& errLow, double& errUp, int = 0)
virtual boolGetVariableSettings(unsigned int, ROOT::Fit::ParameterSettings&) const
virtual doubleGlobalCC(unsigned int) const
virtual boolHesse()
virtual TClass*IsA() const
virtual boolIsFixedVariable(unsigned int) const
boolROOT::Math::Minimizer::IsValidError() const
unsigned intROOT::Math::Minimizer::MaxFunctionCalls() const
unsigned intROOT::Math::Minimizer::MaxIterations() const
virtual const double*MinGradient() const
virtual boolMinimize()
ROOT::Math::MinimizerROOT::Math::Minimizer::Minimizer()
virtual doubleMinValue() const
virtual unsigned intNCalls() const
virtual unsigned intNDim() const
virtual unsigned intNFree() const
virtual unsigned intROOT::Math::Minimizer::NIterations() const
virtual ROOT::Math::MinimizerOptionsROOT::Math::Minimizer::Options() const
doubleROOT::Math::Minimizer::Precision() const
intROOT::Math::Minimizer::PrintLevel() const
virtual voidPrintResults()
virtual boolProvidesError() const
virtual boolReleaseVariable(unsigned int)
virtual boolScan(unsigned int i, unsigned int& nstep, double* x, double* y, double xmin = 0, double xmax = 0)
voidROOT::Math::Minimizer::SetDefaultOptions()
voidROOT::Math::Minimizer::SetErrorDef(double up)
virtual boolSetFixedVariable(unsigned int, const string&, double)
virtual voidSetFunction(const ROOT::Math::IMultiGenFunction& func)
virtual voidSetFunction(const ROOT::Math::IMultiGradFunction& func)
virtual boolSetLimitedVariable(unsigned int ivar, const string& name, double val, double step, double, double)
virtual boolSetLowerLimitedVariable(unsigned int ivar, const string& name, double val, double step, double lower)
voidROOT::Math::Minimizer::SetMaxFunctionCalls(unsigned int maxfcn)
voidROOT::Math::Minimizer::SetMaxIterations(unsigned int maxiter)
voidROOT::Math::Minimizer::SetOptions(const ROOT::Math::MinimizerOptions& opt)
voidROOT::Math::Minimizer::SetPrecision(double prec)
voidROOT::Math::Minimizer::SetPrintLevel(int level)
voidROOT::Math::Minimizer::SetStrategy(int strategyLevel)
voidROOT::Math::Minimizer::SetTolerance(double tol)
virtual boolSetUpperLimitedVariable(unsigned int ivar, const string& name, double val, double step, double upper)
voidROOT::Math::Minimizer::SetValidError(bool on)
virtual boolSetVariable(unsigned int ivar, const string& name, double val, double step)
virtual boolROOT::Math::Minimizer::SetVariableInitialRange(unsigned int, double, double)
virtual boolSetVariableLimits(unsigned int ivar, double lower, double upper)
virtual boolSetVariableLowerLimit(unsigned int, double)
virtual boolSetVariableStepSize(unsigned int, double)
virtual boolSetVariableUpperLimit(unsigned int, double)
virtual boolSetVariableValue(unsigned int, double)
virtual boolROOT::Math::Minimizer::SetVariableValues(const double* x)
virtual voidShowMembers(TMemberInspector& insp) const
intROOT::Math::Minimizer::Status() const
intROOT::Math::Minimizer::Strategy() const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
voidSuppressMinuitWarnings(bool nowarn = true)
TMinuitMinimizer(ROOT::Minuit::EMinimizerType type = ROOT::Minuit::kMigrad, unsigned int ndim = 0)
TMinuitMinimizer(const char* type, unsigned int ndim = 0)
doubleROOT::Math::Minimizer::Tolerance() const
static boolUseStaticMinuit(bool on = true)
virtual intVariableIndex(const string& name) const
virtual stringVariableName(unsigned int ivar) const
virtual const double*X() const
protected:
boolCheckMinuitInstance() const
boolCheckVarIndex(unsigned int ivar) const
voidDoClear()
voidDoReleaseFixParameter(int ivar)
static voidFcn(int&, double*, double& f, double*, int)
static voidFcnGrad(int&, double* g, double& f, double*, int)
voidInitTMinuit(int ndim)
voidRetrieveErrorMatrix()
voidRetrieveParams()

Data Members

protected:
ROOT::Math::MinimizerOptionsROOT::Math::Minimizer::fOptionsminimizer options
intROOT::Math::Minimizer::fStatusstatus of minimizer
boolROOT::Math::Minimizer::fValidErrorflag to control if errors have been validated (Hesse has been run in case of Minuit)
private:
vector<double>fCovarvector storing the covariance matrix
unsigned intfDim
vector<double>fErrorsvector of output errors
boolfMinosRun
TMinuit*fMinuit
vector<double>fParamsvector of output values
ROOT::Minuit::EMinimizerTypefType
boolfUsed
static TMinuit*fgMinuit
static boolfgUseStaticMinuitflag to control if using global TMInuit instance (gMinuit)
static boolfgUsedflag to control if static instance has done minimization

Class Charts

Inheritance Chart:
ROOT::Math::Minimizer
TMinuitMinimizer

Function documentation

TMinuitMinimizer(ROOT::Minuit::EMinimizerType type = ROOT::Minuit::kMigrad, unsigned int ndim = 0)
      Default constructor

TMinuitMinimizer(const char* type, unsigned int ndim = 0)
      Constructor from a char * (used by PM)

~TMinuitMinimizer()
      Destructor (no operations)

TMinuitMinimizer(const TMinuitMinimizer& )
 usually copying is non trivial, so we make this unaccessible

      Copy constructor

void SetFunction(const ROOT::Math::IMultiGenFunction& func)
 set the function to minimize
void SetFunction(const ROOT::Math::IMultiGradFunction& func)
 set the function to minimize
bool SetVariable(unsigned int ivar, const string& name, double val, double step)
 set free variable
bool SetLimitedVariable(unsigned int ivar, const string& name, double val, double step, double , double )
 set upper/lower limited variable (override if minimizer supports them )
bool SetLowerLimitedVariable(unsigned int ivar, const string& name, double val, double step, double lower)
 set lower limit variable  (override if minimizer supports them )
bool SetUpperLimitedVariable(unsigned int ivar, const string& name, double val, double step, double upper)
 set upper limit variable (override if minimizer supports them )
bool SetFixedVariable(unsigned int , const string& , double )
 set fixed variable (override if minimizer supports them )
bool SetVariableValue(unsigned int , double )
 set the value of an existing variable
bool SetVariableStepSize(unsigned int , double )
 set the step size of an existing variable
bool SetVariableLowerLimit(unsigned int , double )
 set the lower-limit of an existing variable
bool SetVariableUpperLimit(unsigned int , double )
 set the upper-limit of an existing variable
bool SetVariableLimits(unsigned int ivar, double lower, double upper)
 set the limits of an existing variable
bool FixVariable(unsigned int )
 fix an existing variable
bool ReleaseVariable(unsigned int )
 release an existing variable
bool IsFixedVariable(unsigned int ) const
 query if an existing variable is fixed (i.e. considered constant in the minimization)
 note that by default all variables are not fixed
bool GetVariableSettings(unsigned int , ROOT::Fit::ParameterSettings& ) const
 get variable settings in a variable object (like ROOT::Fit::ParamsSettings)
bool Minimize()
 method to perform the minimization
double MinValue() const
 return minimum function value
double Edm() const
 return expected distance reached from the minimum
const double * X() const
 return  pointer to X values at the minimum
{ return &fParams.front(); }
const double * MinGradient() const
 return pointer to gradient values at the minimum
{ return 0; }
unsigned int NCalls() const
 number of function calls to reach the minimum
unsigned int NDim() const
 this is <= Function().NDim() which is the total
 number of variables (free+ constrained ones)
{ return fDim; }
unsigned int NFree() const
 number of free variables (real dimension of the problem)
 this is <= Function().NDim() which is the total
bool ProvidesError() const
 minimizer provides error and error matrix
{ return true; }
const double * Errors() const
 return errors at the minimum
{ return &fErrors.front(); }
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

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.
       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

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.
       The array will be filled as h[i *ndim + j]

int CovMatrixStatus() const
return status of covariance matrix
double GlobalCC(unsigned int ) const
global correlation coefficient for variable i
bool GetMinosError(unsigned int i, double& errLow, double& errUp, int = 0)
 minos error for variable i, return false if Minos failed
bool Hesse()
      perform a full calculation of the Hessian matrix for error calculation

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. A minimization must have been done before,
      return false if it is not the case

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();

void PrintResults()
std::string VariableName(unsigned int ivar) const
 return reference to the objective function
virtual const ROOT::Math::IGenFunction & Function() const;
 get name of variables (override if minimizer support storing of variable names)
int VariableIndex(const string& name) const
 get index of variable given a variable given a name
 return always -1 . (It is Not implemented)
bool static UseStaticMinuit(bool on = true)
 static function to switch on/off usage of static global TMinuit instance (gMinuit)
 By default it is used (i.e. is on). Method returns the previous state
void SuppressMinuitWarnings(bool nowarn = true)
 suppress the minuit warnings (if called with false will enable them)
 By default they are suppressed only when the printlevel is <= 0
void Fcn(int& , double* , double& f, double* , int )
 implementation of FCN for Minuit
void FcnGrad(int& , double* g, double& f, double* , int )
 implementation of FCN for Minuit when user provided gradient is used
void InitTMinuit(int ndim)
 initialize the TMinuit instance
void DoClear()
 reset
void DoReleaseFixParameter(int ivar)
release a parameter that is fixed  when it is redefined
void RetrieveParams()
 retrieve minimum parameters and errors from TMinuit
void RetrieveErrorMatrix()
 retrieve error matrix from TMinuit
bool CheckMinuitInstance() const
 check TMinuit instance
bool CheckVarIndex(unsigned int ivar) const
check parameter