Logo ROOT  
Reference Guide
ROOT::Math::Minimizer Class Referenceabstract

Abstract Minimizer class, defining the interface for the various minimizer (like Minuit2, Minuit, GSL, etc..) Plug-in's exist in ROOT to be able to instantiate the derived classes like ROOT::Math::GSLMinimizer or ROOT::Math::Minuit2Minimizer via the plug-in manager.

Provides interface for setting the function to be minimized. The function must implemente the multi-dimensional generic interface ROOT::Math::IBaseFunctionMultiDim. If the function provides gradient calculation (implements the ROOT::Math::IGradientFunctionMultiDim interface) this will be used by the Minimizer.

It Defines also interface for setting the initial values for the function variables (which are the parameters in of the model function in case of solving for fitting) and especifying their limits.

It defines the interface to set and retrieve basic minimization parameters (for specific Minimizer parameters one must use the derived classes).

Then it defines the interface to retrieve the result of minimization ( minimum X values, function value, gradient, error on the mimnimum, etc...)

Definition at line 75 of file Minimizer.h.

Public Member Functions

 Minimizer ()
 Default constructor. More...
 
virtual ~Minimizer ()
 Destructor (no operations) More...
 
virtual void Clear ()
 reset for consecutive minimizations - implement if needed More...
 
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(); More...
 
virtual double Correlation (unsigned int i, unsigned int j) const
 return correlation coefficient between variable i and j. More...
 
virtual double CovMatrix (unsigned int ivar, unsigned int jvar) const
 return covariance matrices element for variables ivar,jvar if the variable is fixed the return value is zero The ordering of the variables is the same as in the parameter and errors vectors More...
 
virtual int CovMatrixStatus () const
 return status of covariance matrix using Minuit convention {0 not calculated 1 approximated 2 made pos def , 3 accurate} Minimizer who implements covariance matrix calculation will re-implement the method More...
 
virtual double Edm () const
 return expected distance reached from the minimum (re-implement if minimizer provides it 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...
 
virtual const doubleErrors () const
 return errors at the minimum More...
 
virtual bool FixVariable (unsigned int ivar)
 fix an existing variable More...
 
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. More...
 
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. More...
 
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 More...
 
virtual bool GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &pars) const
 get variable settings in a variable object (like ROOT::Fit::ParamsSettings) More...
 
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. More...
 
virtual bool Hesse ()
 perform a full calculation of the Hessian matrix for error calculation More...
 
virtual bool IsFixedVariable (unsigned int ivar) const
 query if an existing variable is fixed (i.e. More...
 
bool IsValidError () const
 return true if Minimizer has performed a detailed error validation (e.g. run Hesse for Minuit) More...
 
unsigned int MaxFunctionCalls () const
 max number of function calls More...
 
unsigned int MaxIterations () const
 max iterations More...
 
virtual const doubleMinGradient () const
 return pointer to gradient values at the minimum More...
 
virtual bool Minimize ()=0
 method to perform the minimization More...
 
virtual int MinosStatus () const
 status code of Minos (to be re-implemented by the minimizers supporting Minos) More...
 
virtual double MinValue () const =0
 return minimum function value More...
 
virtual unsigned int NCalls () const
 number of function calls to reach the minimum More...
 
virtual unsigned int NDim () const =0
 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 (re-implement if minimizer supports bounded parameters) More...
 
virtual unsigned int NIterations () const
 number of iterations to reach the minimum More...
 
virtual MinimizerOptions Options () const
 retrieve the minimizer options (implement derived class if needed) 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 PrintLevel () const
 minimizer configuration parameters More...
 
virtual void PrintResults ()
 return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const = 0; More...
 
virtual bool ProvidesError () const
 minimizer provides error and error matrix More...
 
virtual bool ReleaseVariable (unsigned int ivar)
 release an existing variable More...
 
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. More...
 
void SetDefaultOptions ()
 reset the defaut options (defined in MinimizerOptions) More...
 
void SetErrorDef (double up)
 set scale for calculating the errors More...
 
void SetExtraOptions (const IOptions &extraOptions)
 set only the extra options More...
 
virtual bool SetFixedVariable (unsigned int ivar, const std::string &name, double val)
 set a new fixed variable (override if minimizer supports them ) More...
 
virtual void SetFunction (const ROOT::Math::IMultiGenFunction &func)=0
 set the function to minimize More...
 
virtual void SetFunction (const ROOT::Math::IMultiGradFunction &func)
 set a function to minimize using gradient More...
 
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 More...
 
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 ) 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 SetOptions (const MinimizerOptions &opt)
 set all options in one go 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 SetPrintLevel (int level)
 set print level More...
 
void SetStrategy (int strategyLevel)
 set the strategy More...
 
void SetTolerance (double tol)
 set the tolerance More...
 
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 ) More...
 
void SetValidError (bool on)
 flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit) More...
 
virtual bool SetVariable (unsigned int ivar, const std::string &name, double val, double step)=0
 set a new free variable More...
 
virtual bool SetVariableInitialRange (unsigned int, double, double)
 set the initial range of an existing variable More...
 
virtual bool SetVariableLimits (unsigned int ivar, double lower, double upper)
 set the limits of an already existing variable More...
 
virtual bool SetVariableLowerLimit (unsigned int ivar, double lower)
 set the lower-limit of an already existing variable More...
 
template<class VariableIterator >
int SetVariables (const VariableIterator &begin, const VariableIterator &end)
 add variables . Return number of variables successfully added More...
 
virtual bool SetVariableStepSize (unsigned int ivar, double value)
 set the step size 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 SetVariableValue (unsigned int ivar, double value)
 set the value of an already existing variable More...
 
virtual bool SetVariableValues (const double *x)
 set the values of all existing variables (array must be dimensioned to the size of the existing parameters) More...
 
int Status () const
 status code of minimizer More...
 
int Strategy () const
 strategy More...
 
double Tolerance () const
 absolute tolerance 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 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 More...
 
virtual const doubleX () const =0
 return pointer to X values at the minimum More...
 

Protected Attributes

MinimizerOptions fOptions
 
int fStatus
 
bool fValidError
 

Private Member Functions

 Minimizer (const Minimizer &)
 Copy constructor. More...
 
Minimizeroperator= (const Minimizer &rhs)
 Assignment operator. More...
 

#include <Math/Minimizer.h>

Inheritance diagram for ROOT::Math::Minimizer:
[legend]

Constructor & Destructor Documentation

◆ Minimizer() [1/2]

ROOT::Math::Minimizer::Minimizer ( )
inline

Default constructor.

Definition at line 82 of file Minimizer.h.

◆ ~Minimizer()

virtual ROOT::Math::Minimizer::~Minimizer ( )
inlinevirtual

Destructor (no operations)

Definition at line 90 of file Minimizer.h.

◆ Minimizer() [2/2]

ROOT::Math::Minimizer::Minimizer ( const Minimizer )
inlineprivate

Copy constructor.

Definition at line 101 of file Minimizer.h.

Member Function Documentation

◆ Clear()

virtual void ROOT::Math::Minimizer::Clear ( )
inlinevirtual

reset for consecutive minimizations - implement if needed

Reimplemented in ROOT::Math::GeneticMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 114 of file Minimizer.h.

◆ Contour()

virtual bool ROOT::Math::Minimizer::Contour ( unsigned int  ivar,
unsigned int  jvar,
unsigned int &  npoints,
double xi,
double xj 
)
inlinevirtual

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 TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 375 of file Minimizer.h.

◆ Correlation()

virtual double ROOT::Math::Minimizer::Correlation ( unsigned int  i,
unsigned int  j 
) const
inlinevirtual

return correlation coefficient between variable i and j.

If the variable is fixed or const the return value is zero

Reimplemented in ROOT::Minuit2::Minuit2Minimizer.

Definition at line 323 of file Minimizer.h.

◆ CovMatrix()

virtual double ROOT::Math::Minimizer::CovMatrix ( unsigned int  ivar,
unsigned int  jvar 
) const
inlinevirtual

return covariance matrices element for variables ivar,jvar if the variable is fixed the return value is zero The ordering of the variables is the same as in the parameter and errors vectors

Reimplemented in TFumiliMinimizer, ROOT::Math::GeneticMinimizer, TLinearMinimizer, TMinuitMinimizer, ROOT::Minuit2::Minuit2Minimizer, ROOT::Math::RMinimizer, ROOT::Math::GSLMinimizer, and ROOT::Math::GSLNLSMinimizer.

Definition at line 281 of file Minimizer.h.

◆ CovMatrixStatus()

virtual int ROOT::Math::Minimizer::CovMatrixStatus ( ) const
inlinevirtual

return status of covariance matrix using Minuit convention {0 not calculated 1 approximated 2 made pos def , 3 accurate} Minimizer who implements covariance matrix calculation will re-implement the method

Reimplemented in TFumiliMinimizer, ROOT::Math::GSLNLSMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 315 of file Minimizer.h.

◆ Edm()

virtual double ROOT::Math::Minimizer::Edm ( ) const
inlinevirtual

return expected distance reached from the minimum (re-implement if minimizer provides it

Reimplemented in TFumiliMinimizer, ROOT::Math::GeneticMinimizer, ROOT::Math::GSLMinimizer, ROOT::Math::GSLNLSMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 251 of file Minimizer.h.

◆ ErrorDef()

double ROOT::Math::Minimizer::ErrorDef ( ) const
inline

return the statistical scale used for calculate the error is typically 1 for Chi2 and 0.5 for likelihood minimization

Definition at line 433 of file Minimizer.h.

◆ Errors()

virtual const double * ROOT::Math::Minimizer::Errors ( ) const
inlinevirtual

◆ FixVariable()

virtual bool ROOT::Math::Minimizer::FixVariable ( unsigned int  ivar)
inlinevirtual

fix an existing variable

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 210 of file Minimizer.h.

◆ GetCovMatrix()

virtual bool ROOT::Math::Minimizer::GetCovMatrix ( double covMat) const
inlinevirtual

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 TMinuitMinimizer, ROOT::Minuit2::Minuit2Minimizer, and ROOT::Math::RMinimizer.

Definition at line 294 of file Minimizer.h.

◆ GetHessianMatrix()

virtual bool ROOT::Math::Minimizer::GetHessianMatrix ( double hMat) const
inlinevirtual

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 TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 306 of file Minimizer.h.

◆ GetMinosError()

virtual bool ROOT::Math::Minimizer::GetMinosError ( unsigned int  ivar,
double errLow,
double errUp,
int  option = 0 
)
inlinevirtual

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 TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 345 of file Minimizer.h.

◆ GetVariableSettings()

virtual bool ROOT::Math::Minimizer::GetVariableSettings ( unsigned int  ivar,
ROOT::Fit::ParameterSettings pars 
) const
inlinevirtual

get variable settings in a variable object (like ROOT::Fit::ParamsSettings)

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 229 of file Minimizer.h.

◆ GlobalCC()

virtual double ROOT::Math::Minimizer::GlobalCC ( unsigned int  ivar) const
inlinevirtual

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.

Minimizer must overload method if implemented

Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 335 of file Minimizer.h.

◆ Hesse()

virtual bool ROOT::Math::Minimizer::Hesse ( )
inlinevirtual

perform a full calculation of the Hessian matrix for error calculation

Reimplemented in TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 354 of file Minimizer.h.

◆ IsFixedVariable()

virtual bool ROOT::Math::Minimizer::IsFixedVariable ( unsigned int  ivar) const
inlinevirtual

query if an existing variable is fixed (i.e.

considered constant in the minimization) note that by default all variables are not fixed

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 223 of file Minimizer.h.

◆ IsValidError()

bool ROOT::Math::Minimizer::IsValidError ( ) const
inline

return true if Minimizer has performed a detailed error validation (e.g. run Hesse for Minuit)

Definition at line 436 of file Minimizer.h.

◆ MaxFunctionCalls()

unsigned int ROOT::Math::Minimizer::MaxFunctionCalls ( ) const
inline

max number of function calls

Definition at line 410 of file Minimizer.h.

◆ MaxIterations()

unsigned int ROOT::Math::Minimizer::MaxIterations ( ) const
inline

max iterations

Definition at line 413 of file Minimizer.h.

◆ MinGradient()

virtual const double * ROOT::Math::Minimizer::MinGradient ( ) const
inlinevirtual

return pointer to gradient values at the minimum

Reimplemented in TFumiliMinimizer, ROOT::Math::GeneticMinimizer, ROOT::Math::GSLMinimizer, ROOT::Math::GSLNLSMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 254 of file Minimizer.h.

◆ Minimize()

◆ MinosStatus()

virtual int ROOT::Math::Minimizer::MinosStatus ( ) const
inlinevirtual

status code of Minos (to be re-implemented by the minimizers supporting Minos)

Reimplemented in TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 429 of file Minimizer.h.

◆ MinValue()

virtual double ROOT::Math::Minimizer::MinValue ( ) const
pure virtual

◆ NCalls()

virtual unsigned int ROOT::Math::Minimizer::NCalls ( ) const
inlinevirtual

◆ NDim()

virtual unsigned int ROOT::Math::Minimizer::NDim ( ) const
pure virtual

this is <= Function().NDim() which is the total number of variables (free+ constrained ones)

Implemented in TFumiliMinimizer, ROOT::Math::GeneticMinimizer, ROOT::Math::BasicMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

◆ NFree()

virtual unsigned int ROOT::Math::Minimizer::NFree ( ) const
inlinevirtual

number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total (re-implement if minimizer supports bounded parameters)

Reimplemented in TFumiliMinimizer, ROOT::Math::GeneticMinimizer, ROOT::Math::BasicMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 269 of file Minimizer.h.

◆ NIterations()

virtual unsigned int ROOT::Math::Minimizer::NIterations ( ) const
inlinevirtual

number of iterations to reach the minimum

Definition at line 260 of file Minimizer.h.

◆ operator=()

Minimizer & ROOT::Math::Minimizer::operator= ( const Minimizer rhs)
inlineprivate

Assignment operator.

Definition at line 106 of file Minimizer.h.

◆ Options()

virtual MinimizerOptions ROOT::Math::Minimizer::Options ( ) const
inlinevirtual

retrieve the minimizer options (implement derived class if needed)

Reimplemented in ROOT::Math::GeneticMinimizer.

Definition at line 439 of file Minimizer.h.

◆ Precision()

double ROOT::Math::Minimizer::Precision ( ) const
inline

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 420 of file Minimizer.h.

◆ PrintLevel()

int ROOT::Math::Minimizer::PrintLevel ( ) const
inline

minimizer configuration parameters

set print level

Definition at line 407 of file Minimizer.h.

◆ PrintResults()

virtual void ROOT::Math::Minimizer::PrintResults ( )
inlinevirtual

return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const = 0;

print the result according to set level (implemented for TMinuit for mantaining Minuit-style printing)

Reimplemented in TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 387 of file Minimizer.h.

◆ ProvidesError()

virtual bool ROOT::Math::Minimizer::ProvidesError ( ) const
inlinevirtual

◆ ReleaseVariable()

virtual bool ROOT::Math::Minimizer::ReleaseVariable ( unsigned int  ivar)
inlinevirtual

release an existing variable

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 216 of file Minimizer.h.

◆ Scan()

virtual bool ROOT::Math::Minimizer::Scan ( unsigned int  ivar,
unsigned int &  nstep,
double x,
double y,
double  xmin = 0,
double  xmax = 0 
)
inlinevirtual

scan function minimum for variable i.

Variable and function must be set before using Scan Return false if an error or if minimizer does not support this functionality

Reimplemented in TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 363 of file Minimizer.h.

◆ SetDefaultOptions()

void ROOT::Math::Minimizer::SetDefaultOptions ( )
inline

reset the defaut options (defined in MinimizerOptions)

Definition at line 477 of file Minimizer.h.

◆ SetErrorDef()

void ROOT::Math::Minimizer::SetErrorDef ( double  up)
inline

set scale for calculating the errors

Definition at line 463 of file Minimizer.h.

◆ SetExtraOptions()

void ROOT::Math::Minimizer::SetExtraOptions ( const IOptions extraOptions)
inline

set only the extra options

Definition at line 474 of file Minimizer.h.

◆ SetFixedVariable()

virtual bool ROOT::Math::Minimizer::SetFixedVariable ( unsigned int  ivar,
const std::string &  name,
double  val 
)
inlinevirtual

set a new fixed variable (override if minimizer supports them )

Reimplemented in ROOT::Math::GeneticMinimizer, TFumiliMinimizer, ROOT::Math::BasicMinimizer, TLinearMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 167 of file Minimizer.h.

◆ SetFunction() [1/2]

◆ SetFunction() [2/2]

virtual void ROOT::Math::Minimizer::SetFunction ( const ROOT::Math::IMultiGradFunction func)
inlinevirtual

◆ SetLimitedVariable()

virtual bool ROOT::Math::Minimizer::SetLimitedVariable ( unsigned int  ivar,
const std::string &  name,
double  val,
double  step,
double  lower,
double  upper 
)
inlinevirtual

set a new upper/lower limited variable (override if minimizer supports them ) otherwise as default set an unlimited variable

Reimplemented in TFumiliMinimizer, ROOT::Math::BasicMinimizer, TMinuitMinimizer, ROOT::Minuit2::Minuit2Minimizer, and ROOT::Math::GeneticMinimizer.

Definition at line 160 of file Minimizer.h.

◆ SetLowerLimitedVariable()

virtual bool ROOT::Math::Minimizer::SetLowerLimitedVariable ( unsigned int  ivar,
const std::string &  name,
double  val,
double  step,
double  lower 
)
inlinevirtual

set a new lower limit variable (override if minimizer supports them )

Reimplemented in ROOT::Math::BasicMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 152 of file Minimizer.h.

◆ SetMaxFunctionCalls()

void ROOT::Math::Minimizer::SetMaxFunctionCalls ( unsigned int  maxfcn)
inline

set maximum of function calls

Definition at line 447 of file Minimizer.h.

◆ SetMaxIterations()

void ROOT::Math::Minimizer::SetMaxIterations ( unsigned int  maxiter)
inline

set maximum iterations (one iteration can have many function calls)

Definition at line 450 of file Minimizer.h.

◆ SetOptions()

void ROOT::Math::Minimizer::SetOptions ( const MinimizerOptions opt)
inline

set all options in one go

Definition at line 469 of file Minimizer.h.

◆ SetPrecision()

void ROOT::Math::Minimizer::SetPrecision ( double  prec)
inline

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 457 of file Minimizer.h.

◆ SetPrintLevel()

void ROOT::Math::Minimizer::SetPrintLevel ( int  level)
inline

set print level

Definition at line 444 of file Minimizer.h.

◆ SetStrategy()

void ROOT::Math::Minimizer::SetStrategy ( int  strategyLevel)
inline

set the strategy

Definition at line 460 of file Minimizer.h.

◆ SetTolerance()

void ROOT::Math::Minimizer::SetTolerance ( double  tol)
inline

set the tolerance

Definition at line 453 of file Minimizer.h.

◆ SetUpperLimitedVariable()

virtual bool ROOT::Math::Minimizer::SetUpperLimitedVariable ( unsigned int  ivar,
const std::string &  name,
double  val,
double  step,
double  upper 
)
inlinevirtual

set a new upper limit variable (override if minimizer supports them )

Reimplemented in ROOT::Math::BasicMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 156 of file Minimizer.h.

◆ SetValidError()

void ROOT::Math::Minimizer::SetValidError ( bool  on)
inline

flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit)

Definition at line 466 of file Minimizer.h.

◆ SetVariable()

virtual bool ROOT::Math::Minimizer::SetVariable ( unsigned int  ivar,
const std::string &  name,
double  val,
double  step 
)
pure virtual

◆ SetVariableInitialRange()

virtual bool ROOT::Math::Minimizer::SetVariableInitialRange ( unsigned int  ,
double  ,
double   
)
inlinevirtual

set the initial range of an existing variable

Definition at line 237 of file Minimizer.h.

◆ SetVariableLimits()

virtual bool ROOT::Math::Minimizer::SetVariableLimits ( unsigned int  ivar,
double  lower,
double  upper 
)
inlinevirtual

set the limits of an already existing variable

Reimplemented in ROOT::Math::BasicMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 206 of file Minimizer.h.

◆ SetVariableLowerLimit()

virtual bool ROOT::Math::Minimizer::SetVariableLowerLimit ( unsigned int  ivar,
double  lower 
)
inlinevirtual

set the lower-limit of an already existing variable

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 194 of file Minimizer.h.

◆ SetVariables()

template<class VariableIterator >
int ROOT::Math::Minimizer::SetVariables ( const VariableIterator &  begin,
const VariableIterator &  end 
)
inline

add variables . Return number of variables successfully added

Definition at line 128 of file Minimizer.h.

◆ SetVariableStepSize()

virtual bool ROOT::Math::Minimizer::SetVariableStepSize ( unsigned int  ivar,
double  value 
)
inlinevirtual

set the step size of an already existing variable

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 188 of file Minimizer.h.

◆ SetVariableUpperLimit()

virtual bool ROOT::Math::Minimizer::SetVariableUpperLimit ( unsigned int  ivar,
double  upper 
)
inlinevirtual

set the upper-limit of an already existing variable

Reimplemented in ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 200 of file Minimizer.h.

◆ SetVariableValue()

virtual bool ROOT::Math::Minimizer::SetVariableValue ( unsigned int  ivar,
double  value 
)
inlinevirtual

set the value of an already existing variable

Reimplemented in TFumiliMinimizer, ROOT::Math::BasicMinimizer, ROOT::Minuit2::Minuit2Minimizer, and TMinuitMinimizer.

Definition at line 173 of file Minimizer.h.

◆ SetVariableValues()

virtual bool ROOT::Math::Minimizer::SetVariableValues ( const double x)
inlinevirtual

set the values of all existing variables (array must be dimensioned to the size of the existing parameters)

Reimplemented in ROOT::Minuit2::Minuit2Minimizer, and ROOT::Math::BasicMinimizer.

Definition at line 179 of file Minimizer.h.

◆ Status()

int ROOT::Math::Minimizer::Status ( ) const
inline

status code of minimizer

Definition at line 426 of file Minimizer.h.

◆ Strategy()

int ROOT::Math::Minimizer::Strategy ( ) const
inline

strategy

Definition at line 423 of file Minimizer.h.

◆ Tolerance()

double ROOT::Math::Minimizer::Tolerance ( ) const
inline

absolute tolerance

Definition at line 416 of file Minimizer.h.

◆ VariableIndex()

virtual int ROOT::Math::Minimizer::VariableIndex ( const std::string &  name) const
inlinevirtual

get index of variable given a variable given a name return -1 if variable is not found

Reimplemented in ROOT::Math::BasicMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 398 of file Minimizer.h.

◆ VariableName()

virtual std::string ROOT::Math::Minimizer::VariableName ( unsigned int  ivar) const
inlinevirtual

get name of variables (override if minimizer support storing of variable names) return an empty string if variable is not found

Reimplemented in ROOT::Math::BasicMinimizer, TMinuitMinimizer, and ROOT::Minuit2::Minuit2Minimizer.

Definition at line 391 of file Minimizer.h.

◆ X()

virtual const double * ROOT::Math::Minimizer::X ( ) const
pure virtual

Member Data Documentation

◆ fOptions

MinimizerOptions ROOT::Math::Minimizer::fOptions
protected

Definition at line 491 of file Minimizer.h.

◆ fStatus

int ROOT::Math::Minimizer::fStatus
protected

Definition at line 492 of file Minimizer.h.

◆ fValidError

bool ROOT::Math::Minimizer::fValidError
protected

Definition at line 490 of file Minimizer.h.

Libraries for ROOT::Math::Minimizer:
[legend]

The documentation for this class was generated from the following file: