ROOT::Minuit2::Minuit2Minimizer Class Reference

Description

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

Refer to the guide for an introduction how Minuit works.

Definition at line 58 of file Minuit2Minimizer.h.

Inheritance diagram for ROOT::Minuit2::Minuit2Minimizer:

Collaboration diagram for ROOT::Minuit2::Minuit2Minimizer:

Public Member Functions
	Minuit2Minimizer (const char *type)
	Minuit2Minimizer (ROOT::Minuit2::EMinimizerType type=ROOT::Minuit2::kMigrad)
virtual	~Minuit2Minimizer ()
virtual void	Clear ()
	reset for consecutive minimizations - implement if needed More...
virtual bool	Contour (unsigned int i, unsigned int j, unsigned int &npoints, double *xi, double *xj)
virtual double	Correlation (unsigned int i, unsigned int j) const
virtual double	CovMatrix (unsigned int i, unsigned int j) const
virtual int	CovMatrixStatus () const
virtual double	Edm () const
	return expected distance reached from the minimum 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 double *	Errors () const
	return errors at the minimum More...
virtual bool	FixVariable (unsigned int ivar)
	fix an existing variable More...
virtual bool	GetCovMatrix (double *cov) const
virtual bool	GetHessianMatrix (double *h) const
virtual bool	GetMinosError (unsigned int i, double &errLow, double &errUp, int=0)
virtual bool	GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &varObj) const
	get variable settings in a variable object (like ROOT::Fit::ParamsSettings) More...
virtual double	GlobalCC (unsigned int i) const
virtual bool	Hesse ()
virtual bool	IsFixedVariable (unsigned int ivar) const
	query if an existing variable is fixed (i.e. considered constant in the minimization) note that by default all variables are not fixed 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 double *	MinGradient () const
	return pointer to gradient values at the minimum More...
virtual bool	Minimize ()
virtual double	MinValue () const
	return minimum function value 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 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
	set print level More...
virtual void	PrintResults ()
	return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const; 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 i, unsigned int &nstep, double *x, double *y, double xmin=0, double xmax=0)
void	SetDefaultOptions ()
	reset the defaut options (defined in MinimizerOptions) More...
void	SetErrorDef (double up)
	set scale for calculating the errors More...
virtual bool	SetFixedVariable (unsigned int, const std::string &, double)
	set fixed variable (override if minimizer supports them ) 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	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	SetLowerLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower)
	set 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. default case) More...
void	SetPrintLevel (int level)
	set print level 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...
void	SetStrategy (int strategyLevel)
	set the strategy More...
void	SetTolerance (double tol)
	set the tolerance More...
void	SetTraceObject (MnTraceObject &obj)
	set an object to trace operation for each iteration The object muust implement operator() (unsigned int, MinimumState & state) 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...
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)
	set 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 step)
	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 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...
const ROOT::Minuit2::MnUserParameterState &	State ()
	return the minimizer state (containing values, step size , etc..) 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) More...
virtual const double *	X () const
	return pointer to X values at the minimum More...

Protected Member Functions
bool	ExamineMinimum (const ROOT::Minuit2::FunctionMinimum &min)
	examine the minimum result More...
virtual const ROOT::Minuit2::FCNBase *	GetFCN () const
virtual const ROOT::Minuit2::ModularFunctionMinimizer *	GetMinimizer () const
virtual void	SetMinimizer (ROOT::Minuit2::ModularFunctionMinimizer *m)
void	SetMinimizerType (ROOT::Minuit2::EMinimizerType type)

Protected Attributes
MinimizerOptions	fOptions
int	fStatus
bool	fValidError

Private Member Functions
	Minuit2Minimizer (const Minuit2Minimizer &)
Minuit2Minimizer &	operator= (const Minuit2Minimizer &rhs)

Private Attributes
unsigned int	fDim
std::vector< double >	fErrors
ROOT::Minuit2::ModularFunctionMinimizer *	fMinimizer
ROOT::Minuit2::FunctionMinimum *	fMinimum
ROOT::Minuit2::FCNBase *	fMinuitFCN
ROOT::Minuit2::MnUserParameterState	fState
bool	fUseFumili
std::vector< double >	fValues

Constructor & Destructor Documentation

Minuit2Minimizer() [1/3]

ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer

(

ROOT::Minuit2::EMinimizerType

type = ROOT::Minuit2::kMigrad

)

Default constructor

Minuit2Minimizer() [2/3]

ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer

(

const char *

type

)

Constructor with a char (used by PM)

~Minuit2Minimizer()

virtual ROOT::Minuit2::Minuit2Minimizer::~Minuit2Minimizer ( )

virtual

Destructor (no operations)

Minuit2Minimizer() [3/3]

ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer ( const Minuit2Minimizer &  )

private

Copy constructor

Member Function Documentation

Clear()

virtual void ROOT::Minuit2::Minuit2Minimizer::Clear ( )

virtual

reset for consecutive minimizations - implement if needed

Reimplemented from ROOT::Math::Minimizer.

Contour()

virtual bool ROOT::Minuit2::Minuit2Minimizer::Contour ( unsigned int  i, unsigned int  j, unsigned int &  npoints, double *  xi, double *  xj  )

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.

Correlation()

virtual double ROOT::Minuit2::Minuit2Minimizer::Correlation ( unsigned int  i, unsigned int  j  ) const

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.

CovMatrix()

virtual double ROOT::Minuit2::Minuit2Minimizer::CovMatrix ( unsigned int  i, unsigned int  j  ) const

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.

CovMatrixStatus()

virtual int ROOT::Minuit2::Minuit2Minimizer::CovMatrixStatus ( ) const

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.

Edm()

virtual double ROOT::Minuit2::Minuit2Minimizer::Edm ( ) const

inlinevirtual

return expected distance reached from the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 157 of file Minuit2Minimizer.h.

{ return fState.Edm(); }

References ROOT::Minuit2::MnUserParameterState::Edm(), and fState.

Here is the call graph for this function:

ErrorDef()

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

inlineinherited

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

Definition at line 434 of file Minimizer.h.

{ return fOptions.ErrorDef(); }

References ROOT::Math::MinimizerOptions::ErrorDef(), and ROOT::Math::Minimizer::fOptions.

Here is the call graph for this function:

Errors()

virtual const double* ROOT::Minuit2::Minuit2Minimizer::Errors ( ) const

virtual

return errors at the minimum

Reimplemented from ROOT::Math::Minimizer.

ExamineMinimum()

bool ROOT::Minuit2::Minuit2Minimizer::ExamineMinimum ( const ROOT::Minuit2::FunctionMinimum &  min )

protected

examine the minimum result

FixVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::FixVariable ( unsigned int  ivar )

virtual

fix an existing variable

Reimplemented from ROOT::Math::Minimizer.

GetCovMatrix()

virtual bool ROOT::Minuit2::Minuit2Minimizer::GetCovMatrix ( double *  cov ) const

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.

GetFCN()

virtual const ROOT::Minuit2::FCNBase* ROOT::Minuit2::Minuit2Minimizer::GetFCN ( ) const

inlineprotectedvirtual

Definition at line 303 of file Minuit2Minimizer.h.

{ return fMinuitFCN; }

References fMinuitFCN.

GetHessianMatrix()

virtual bool ROOT::Minuit2::Minuit2Minimizer::GetHessianMatrix ( double *  h ) const

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.

GetMinimizer()

virtual const ROOT::Minuit2::ModularFunctionMinimizer* ROOT::Minuit2::Minuit2Minimizer::GetMinimizer ( ) const

inlineprotectedvirtual

Definition at line 297 of file Minuit2Minimizer.h.

{ return fMinimizer; }

References fMinimizer.

GetMinosError()

virtual bool ROOT::Minuit2::Minuit2Minimizer::GetMinosError ( unsigned int  i, double &  errLow, double &  errUp, int  = 0  )

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.

GetVariableSettings()

virtual bool ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings ( unsigned int  ivar, ROOT::Fit::ParameterSettings &  varObj  ) const

virtual

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

Reimplemented from ROOT::Math::Minimizer.

GlobalCC()

virtual double ROOT::Minuit2::Minuit2Minimizer::GlobalCC ( unsigned int  i ) const

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.

Hesse()

virtual bool ROOT::Minuit2::Minuit2Minimizer::Hesse ( )

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.

IsFixedVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::IsFixedVariable ( unsigned int  ivar ) const

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.

IsValidError()

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

inlineinherited

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

Definition at line 437 of file Minimizer.h.

{ return fValidError; }

References ROOT::Math::Minimizer::fValidError.

MaxFunctionCalls()

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

inlineinherited

max number of function calls

Definition at line 414 of file Minimizer.h.

{ return fOptions.MaxFunctionCalls(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::MaxFunctionCalls().

Here is the call graph for this function:

MaxIterations()

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

inlineinherited

max iterations

Definition at line 417 of file Minimizer.h.

{ return fOptions.MaxIterations(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::MaxIterations().

Here is the call graph for this function:

MinGradient()

virtual const double* ROOT::Minuit2::Minuit2Minimizer::MinGradient ( ) const

inlinevirtual

return pointer to gradient values at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 163 of file Minuit2Minimizer.h.

{ return 0; } // not available in Minuit2

Minimize()

virtual bool ROOT::Minuit2::Minuit2Minimizer::Minimize ( )

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.

MinValue()

virtual double ROOT::Minuit2::Minuit2Minimizer::MinValue ( ) const

inlinevirtual

return minimum function value

Implements ROOT::Math::Minimizer.

Definition at line 154 of file Minuit2Minimizer.h.

{ return fState.Fval(); }

References fState, and ROOT::Minuit2::MnUserParameterState::Fval().

Here is the call graph for this function:

NCalls()

virtual unsigned int ROOT::Minuit2::Minuit2Minimizer::NCalls ( ) const

inlinevirtual

number of function calls to reach the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 166 of file Minuit2Minimizer.h.

{ return fState.NFcn(); }

References fState, and ROOT::Minuit2::MnUserParameterState::NFcn().

Here is the call graph for this function:

NDim()

virtual unsigned int ROOT::Minuit2::Minuit2Minimizer::NDim ( ) const

inlinevirtual

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

Implements ROOT::Math::Minimizer.

Definition at line 170 of file Minuit2Minimizer.h.

{ return fDim; }

References fDim.

NFree()

virtual unsigned int ROOT::Minuit2::Minuit2Minimizer::NFree ( ) const

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 174 of file Minuit2Minimizer.h.

{ return fState.VariableParameters(); }

References fState, and ROOT::Minuit2::MnUserParameterState::VariableParameters().

Here is the call graph for this function:

NIterations()

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

inlinevirtualinherited

number of iterations to reach the minimum

Definition at line 263 of file Minimizer.h.

{ return NCalls(); }

References ROOT::Math::Minimizer::NCalls().

Here is the call graph for this function:

operator=()

Minuit2Minimizer& ROOT::Minuit2::Minuit2Minimizer::operator= ( const Minuit2Minimizer &  rhs )

private

Assignment operator

Options()

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

inlinevirtualinherited

retrieve the minimizer options (implement derived class if needed)

Reimplemented in ROOT::Math::GeneticMinimizer.

Definition at line 440 of file Minimizer.h.

                                             {
      return fOptions;
   }

References ROOT::Math::Minimizer::fOptions.

Precision()

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

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

{ return fOptions.Precision(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::Precision().

Here is the call graph for this function:

PrintLevel()

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

inlineinherited

set print level

minimizer configuration parameters

Definition at line 411 of file Minimizer.h.

{ return fOptions.PrintLevel(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::PrintLevel().

Here is the call graph for this function:

PrintResults()

virtual void ROOT::Minuit2::Minuit2Minimizer::PrintResults ( )

virtual

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

print result of minimization

Reimplemented from ROOT::Math::Minimizer.

ProvidesError()

virtual bool ROOT::Minuit2::Minuit2Minimizer::ProvidesError ( ) const

inlinevirtual

minimizer provides error and error matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 177 of file Minuit2Minimizer.h.

{ return true; }

ReleaseVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::ReleaseVariable ( unsigned int  ivar )

virtual

release an existing variable

Reimplemented from ROOT::Math::Minimizer.

Scan()

virtual bool ROOT::Minuit2::Minuit2Minimizer::Scan ( unsigned int  i, unsigned int &  nstep, double *  x, double *  y, double  xmin = 0, double  xmax = 0  )

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.

SetDefaultOptions()

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

inlineinherited

reset the defaut options (defined in MinimizerOptions)

Definition at line 475 of file Minimizer.h.

                            {
      fOptions.ResetToDefaultOptions();
   }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::ResetToDefaultOptions().

Here is the call graph for this function:

SetErrorDef()

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

inlineinherited

set scale for calculating the errors

Definition at line 464 of file Minimizer.h.

{ fOptions.SetErrorDef(up); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetErrorDef().

Here is the call graph for this function:

SetFixedVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetFixedVariable ( unsigned int  , const std::string &  , double    )

virtual

set fixed variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

SetFunction() [1/2]

virtual void ROOT::Minuit2::Minuit2Minimizer::SetFunction ( const ROOT::Math::IMultiGenFunction &  func )

virtual

set the function to minimize

Implements ROOT::Math::Minimizer.

SetFunction() [2/2]

virtual void ROOT::Minuit2::Minuit2Minimizer::SetFunction ( const ROOT::Math::IMultiGradFunction &  func )

virtual

set gradient the function to minimize

Reimplemented from ROOT::Math::Minimizer.

SetLimitedVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetLimitedVariable ( unsigned int  ivar, const std::string &  name, double  val, double  step, double  , double    )

virtual

set upper/lower limited variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

SetLowerLimitedVariable()

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

virtual

set lower limit variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

SetMaxFunctionCalls()

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

inlineinherited

set maximum of function calls

Definition at line 448 of file Minimizer.h.

{ if (maxfcn > 0) fOptions.SetMaxFunctionCalls(maxfcn); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetMaxFunctionCalls().

Here is the call graph for this function:

SetMaxIterations()

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

inlineinherited

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

Definition at line 451 of file Minimizer.h.

{ if (maxiter > 0) fOptions.SetMaxIterations(maxiter); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetMaxIterations().

Here is the call graph for this function:

SetMinimizer()

virtual void ROOT::Minuit2::Minuit2Minimizer::SetMinimizer ( ROOT::Minuit2::ModularFunctionMinimizer *  m )

inlineprotectedvirtual

Definition at line 299 of file Minuit2Minimizer.h.

{ fMinimizer = m; }

References fMinimizer.

SetMinimizerType()

void ROOT::Minuit2::Minuit2Minimizer::SetMinimizerType ( ROOT::Minuit2::EMinimizerType  type )

protected

SetOptions()

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

inlineinherited

set all options in one go

Definition at line 470 of file Minimizer.h.

                                                 {
      fOptions = opt;
   }

References ROOT::Math::Minimizer::fOptions.

SetPrecision()

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

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

{ fOptions.SetPrecision(prec); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetPrecision().

Here is the call graph for this function:

SetPrintLevel()

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

inlineinherited

set print level

Definition at line 445 of file Minimizer.h.

{ fOptions.SetPrintLevel(level); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetPrintLevel().

Here is the call graph for this function:

SetStorageLevel()

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

SetStrategy()

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

inlineinherited

set the strategy

Definition at line 461 of file Minimizer.h.

{ fOptions.SetStrategy(strategyLevel); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetStrategy().

Here is the call graph for this function:

SetTolerance()

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

inlineinherited

set the tolerance

Definition at line 454 of file Minimizer.h.

{ fOptions.SetTolerance(tol); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::SetTolerance().

Here is the call graph for this function:

SetTraceObject()

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)

SetUpperLimitedVariable()

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

virtual

set upper limit variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

SetValidError()

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

inlineinherited

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

Definition at line 467 of file Minimizer.h.

{ fValidError = on; }

References ROOT::Math::Minimizer::fValidError.

SetVariable()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariable ( unsigned int  ivar, const std::string &  name, double  val, double  step  )

virtual

set free variable

Implements ROOT::Math::Minimizer.

SetVariableInitialRange()

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

inlinevirtualinherited

set the initial range of an existing variable

Definition at line 240 of file Minimizer.h.

                                                                            {
     return false;
   }

SetVariableLimits()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableLimits ( unsigned int  ivar, double  lower, double  upper  )

virtual

set the limits of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

SetVariableLowerLimit()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableLowerLimit ( unsigned int  ivar, double  lower  )

virtual

set the lower-limit of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

SetVariables()

template<class VariableIterator >

int ROOT::Math::Minimizer::SetVariables ( const VariableIterator &  begin, const VariableIterator &  end  )

inlineinherited

add variables . Return number of variables successfully added

Definition at line 131 of file Minimizer.h.

                                                                                  {
      unsigned int ivar = 0;
      for ( VariableIterator vitr = begin; vitr != end; ++vitr) {
         bool iret = false;
         if (vitr->IsFixed() )
            iret = SetFixedVariable(ivar,  vitr->Name(), vitr->Value() );
         else if (vitr->IsDoubleBound() )
            iret = SetLimitedVariable(ivar,  vitr->Name(), vitr->Value(), vitr->StepSize(), vitr->LowerLimit(), vitr->UpperLimit() );
         else if (vitr->HasLowerLimit() )
            iret = SetLowerLimitedVariable(ivar,  vitr->Name(), vitr->Value(), vitr->StepSize(), vitr->LowerLimit() );
         else if (vitr->HasUpperLimit() )
            iret = SetUpperLimitedVariable(ivar,  vitr->Name(), vitr->Value(), vitr->StepSize(), vitr->UpperLimit() );
         else
            iret = SetVariable( ivar, vitr->Name(), vitr->Value(), vitr->StepSize() );
 
         if (iret) ivar++;
 
         // an error message should be eventually be reported in the virtual single SetVariable methods
      }
      return ivar;
   }

References ROOT::Math::Minimizer::SetFixedVariable(), ROOT::Math::Minimizer::SetLimitedVariable(), ROOT::Math::Minimizer::SetLowerLimitedVariable(), ROOT::Math::Minimizer::SetUpperLimitedVariable(), and ROOT::Math::Minimizer::SetVariable().

Here is the call graph for this function:

SetVariableStepSize()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableStepSize ( unsigned int  ivar, double  step  )

virtual

set the step size of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

SetVariableUpperLimit()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableUpperLimit ( unsigned int  ivar, double  upper  )

virtual

set the upper-limit of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

SetVariableValue()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableValue ( unsigned int  ivar, double  val  )

virtual

set variable

Reimplemented from ROOT::Math::Minimizer.

SetVariableValues()

virtual bool ROOT::Minuit2::Minuit2Minimizer::SetVariableValues ( const double *  x )

virtual

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

Reimplemented from ROOT::Math::Minimizer.

State()

const ROOT::Minuit2::MnUserParameterState& ROOT::Minuit2::Minuit2Minimizer::State ( )

inline

return the minimizer state (containing values, step size , etc..)

Definition at line 291 of file Minuit2Minimizer.h.

{ return fState; }

References fState.

Status()

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

inlineinherited

status code of minimizer

Definition at line 430 of file Minimizer.h.

{ return fStatus; }

References ROOT::Math::Minimizer::fStatus.

Referenced by GeneticMinimizer::statusToString(), and Minuit2Minimizer::statusToString().

Strategy()

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

inlineinherited

strategy

Definition at line 427 of file Minimizer.h.

{ return fOptions.Strategy(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::Strategy().

Here is the call graph for this function:

Tolerance()

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

inlineinherited

absolute tolerance

Definition at line 420 of file Minimizer.h.

{ return  fOptions.Tolerance(); }

References ROOT::Math::Minimizer::fOptions, and ROOT::Math::MinimizerOptions::Tolerance().

Here is the call graph for this function:

VariableIndex()

virtual int ROOT::Minuit2::Minuit2Minimizer::VariableIndex ( const std::string &  name ) const

virtual

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

Reimplemented from ROOT::Math::Minimizer.

VariableName()

virtual std::string ROOT::Minuit2::Minuit2Minimizer::VariableName ( unsigned int  ivar ) const

virtual

get name of variables (override if minimizer support storing of variable names)

Reimplemented from ROOT::Math::Minimizer.

X()

virtual const double* ROOT::Minuit2::Minuit2Minimizer::X ( ) const

virtual

return pointer to X values at the minimum

Implements ROOT::Math::Minimizer.

Member Data Documentation

fDim

unsigned int ROOT::Minuit2::Minuit2Minimizer::fDim

private

Definition at line 310 of file Minuit2Minimizer.h.

Referenced by NDim().

fErrors

std::vector<double> ROOT::Minuit2::Minuit2Minimizer::fErrors

mutableprivate

Definition at line 319 of file Minuit2Minimizer.h.

fMinimizer

ROOT::Minuit2::ModularFunctionMinimizer* ROOT::Minuit2::Minuit2Minimizer::fMinimizer

private

Definition at line 315 of file Minuit2Minimizer.h.

Referenced by GetMinimizer(), and SetMinimizer().

fMinimum

ROOT::Minuit2::FunctionMinimum* ROOT::Minuit2::Minuit2Minimizer::fMinimum

private

Definition at line 317 of file Minuit2Minimizer.h.

fMinuitFCN

ROOT::Minuit2::FCNBase* ROOT::Minuit2::Minuit2Minimizer::fMinuitFCN

private

Definition at line 316 of file Minuit2Minimizer.h.

Referenced by GetFCN().

fOptions

MinimizerOptions ROOT::Math::Minimizer::fOptions

protectedinherited

Definition at line 489 of file Minimizer.h.

Referenced by ROOT::Math::Minimizer::ErrorDef(), ROOT::Math::Minimizer::MaxFunctionCalls(), ROOT::Math::Minimizer::MaxIterations(), ROOT::Math::Minimizer::Options(), ROOT::Math::Minimizer::Precision(), ROOT::Math::Minimizer::PrintLevel(), ROOT::Math::Minimizer::SetDefaultOptions(), ROOT::Math::Minimizer::SetErrorDef(), ROOT::Math::Minimizer::SetMaxFunctionCalls(), ROOT::Math::Minimizer::SetMaxIterations(), ROOT::Math::Minimizer::SetOptions(), ROOT::Math::Minimizer::SetPrecision(), ROOT::Math::Minimizer::SetPrintLevel(), ROOT::Math::Minimizer::SetStrategy(), ROOT::Math::Minimizer::SetTolerance(), ROOT::Math::Minimizer::Strategy(), and ROOT::Math::Minimizer::Tolerance().

fState

ROOT::Minuit2::MnUserParameterState ROOT::Minuit2::Minuit2Minimizer::fState

private

Definition at line 313 of file Minuit2Minimizer.h.

Referenced by Edm(), MinValue(), NCalls(), NFree(), and State().

fStatus

int ROOT::Math::Minimizer::fStatus

protectedinherited

Definition at line 490 of file Minimizer.h.

Referenced by ROOT::Math::Minimizer::Status().

fUseFumili

bool ROOT::Minuit2::Minuit2Minimizer::fUseFumili

private

Definition at line 311 of file Minuit2Minimizer.h.

fValidError

bool ROOT::Math::Minimizer::fValidError

protectedinherited

Definition at line 488 of file Minimizer.h.

Referenced by ROOT::Math::Minimizer::IsValidError(), and ROOT::Math::Minimizer::SetValidError().

fValues

std::vector<double> ROOT::Minuit2::Minuit2Minimizer::fValues

mutableprivate

Definition at line 318 of file Minuit2Minimizer.h.

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/Minuit2/Minuit2Minimizer.h