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.

Public Member Functions
	Minuit2Minimizer (const char *type)
	Constructor with a char (used by PM) More...

	Minuit2Minimizer (ROOT::Minuit2::EMinimizerType type=ROOT::Minuit2::kMigrad)
	Default constructor. More...

virtual	~Minuit2Minimizer ()
	Destructor (no operations) More...

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)
	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(); 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 i, unsigned int j) const
	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. More...

virtual int	CovMatrixStatus () const
	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 More...

virtual double	Edm () const
	return expected distance reached from the minimum 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
	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 *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. More...

virtual bool	GetMinosError (unsigned int i, double &errLow, double &errUp, int=0)
	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 More...

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
	get global correlation coefficient for the variable i. More...

virtual bool	Hesse ()
	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 More...

virtual bool	IsFixedVariable (unsigned int ivar) const
	query if an existing variable is fixed (i.e. More...

virtual const double *	MinGradient () const
	return pointer to gradient values at the minimum More...

virtual bool	Minimize ()
	method to perform the minimization. More...

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 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)
	scan a parameter i around the minimum. 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	SetStorageLevel (int level)
	set storage level = 1 : store all iteration states (default) = 0 : store only first and last state to save memory More...

void	SetTraceObject (MnTraceObject &obj)
	set an object to trace operation for each iteration The object must be a (or inherit from) ROOT::Minuit2::MnTraceObject and implement operator() (int, const 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...

virtual bool	SetVariable (unsigned int ivar, const std::string &name, double val, double step)
	set free 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...

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

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

Public Member Functions inherited from ROOT::Math::Minimizer
	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 double *	Errors () 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 (This feature is not yet implemented) 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 double *	MinGradient () const
	return pointer to gradient values at the minimum More...

virtual bool	Minimize ()=0
	method to perform the minimization 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...

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 double *	X () const =0
	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)

Private Member Functions
	Minuit2Minimizer (const Minuit2Minimizer &)
	Copy constructor. More...

Minuit2Minimizer &	operator= (const Minuit2Minimizer &rhs)
	Assignment operator. More...

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

Additional Inherited Members
Protected Attributes inherited from ROOT::Math::Minimizer
MinimizerOptions	fOptions

int	fStatus

bool	fValidError

#include <Minuit2/Minuit2Minimizer.h>

Inheritance diagram for ROOT::Minuit2::Minuit2Minimizer:

[legend]

Constructor & Destructor Documentation

◆ Minuit2Minimizer() [1/3]

ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer ( ROOT::Minuit2::EMinimizerType type = ROOT::Minuit2::kMigrad )

Default constructor.

Definition at line 82 of file Minuit2Minimizer.cxx.

◆ Minuit2Minimizer() [2/3]

ROOT::Minuit2::Minuit2Minimizer::Minuit2Minimizer ( const char * type )

Constructor with a char (used by PM)

Definition at line 93 of file Minuit2Minimizer.cxx.

◆ ~Minuit2Minimizer()

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

virtual

Destructor (no operations)

Definition at line 150 of file Minuit2Minimizer.cxx.

◆ Minuit2Minimizer() [3/3]

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

private

Copy constructor.

Definition at line 158 of file Minuit2Minimizer.cxx.

Member Function Documentation

◆ Clear()

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

virtual

reset for consecutive minimizations - implement if needed

Reimplemented from ROOT::Math::Minimizer.

Definition at line 172 of file Minuit2Minimizer.cxx.

◆ Contour()

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.

Definition at line 978 of file Minuit2Minimizer.cxx.

◆ Correlation()

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.

Definition at line 745 of file Minuit2Minimizer.cxx.

◆ CovMatrix()

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.

Definition at line 678 of file Minuit2Minimizer.cxx.

◆ CovMatrixStatus()

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.

Definition at line 1121 of file Minuit2Minimizer.cxx.

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

◆ Errors()

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

virtual

return errors at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 658 of file Minuit2Minimizer.cxx.

◆ ExamineMinimum()

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

protected

examine the minimum result

Definition at line 538 of file Minuit2Minimizer.cxx.

◆ FixVariable()

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

virtual

fix an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 309 of file Minuit2Minimizer.cxx.

◆ GetCovMatrix()

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.

Definition at line 689 of file Minuit2Minimizer.cxx.

◆ GetFCN()

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

inlineprotectedvirtual

Definition at line 303 of file Minuit2Minimizer.h.

◆ GetHessianMatrix()

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.

Definition at line 716 of file Minuit2Minimizer.cxx.

◆ GetMinimizer()

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

inlineprotectedvirtual

Definition at line 297 of file Minuit2Minimizer.h.

◆ GetMinosError()

bool ROOT::Minuit2::Minuit2Minimizer::GetMinosError	(	unsigned int	i,
		double &	errLow,
		double &	errUp,
		int	runopt = `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.

Definition at line 773 of file Minuit2Minimizer.cxx.

◆ GetVariableSettings()

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.

Definition at line 332 of file Minuit2Minimizer.cxx.

◆ GlobalCC()

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.

Definition at line 759 of file Minuit2Minimizer.cxx.

◆ Hesse()

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.

Definition at line 1035 of file Minuit2Minimizer.cxx.

◆ IsFixedVariable()

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.

Definition at line 323 of file Minuit2Minimizer.cxx.

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

◆ Minimize()

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.

Definition at line 391 of file Minuit2Minimizer.cxx.

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

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

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

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

◆ operator=()

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

private

Assignment operator.

Definition at line 164 of file Minuit2Minimizer.cxx.

◆ PrintResults()

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.

Definition at line 612 of file Minuit2Minimizer.cxx.

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

◆ ReleaseVariable()

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

virtual

release an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 316 of file Minuit2Minimizer.cxx.

◆ Scan()

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.

Definition at line 920 of file Minuit2Minimizer.cxx.

◆ SetFixedVariable()

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

virtual

set fixed variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

Definition at line 236 of file Minuit2Minimizer.cxx.

◆ SetFunction() [1/2]

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

virtual

set the function to minimize

Implements ROOT::Math::Minimizer.

Definition at line 355 of file Minuit2Minimizer.cxx.

◆ SetFunction() [2/2]

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

virtual

set gradient the function to minimize

Reimplemented from ROOT::Math::Minimizer.

Definition at line 373 of file Minuit2Minimizer.cxx.

◆ SetLimitedVariable()

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

virtual

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 229 of file Minuit2Minimizer.cxx.

◆ SetLowerLimitedVariable()

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.

Definition at line 213 of file Minuit2Minimizer.cxx.

◆ SetMinimizer()

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

inlineprotectedvirtual

Definition at line 299 of file Minuit2Minimizer.h.

◆ SetMinimizerType()

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

protected

Definition at line 116 of file Minuit2Minimizer.cxx.

◆ 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

Definition at line 1150 of file Minuit2Minimizer.cxx.

◆ SetTraceObject()

void ROOT::Minuit2::Minuit2Minimizer::SetTraceObject ( MnTraceObject & obj )

set an object to trace operation for each iteration The object must be a (or inherit from) ROOT::Minuit2::MnTraceObject and implement operator() (int, const MinimumState & state)

Definition at line 1144 of file Minuit2Minimizer.cxx.

◆ SetUpperLimitedVariable()

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.

Definition at line 220 of file Minuit2Minimizer.cxx.

◆ SetVariable()

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

virtual

set free variable

Implements ROOT::Math::Minimizer.

Definition at line 183 of file Minuit2Minimizer.cxx.

◆ SetVariableLimits()

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.

Definition at line 301 of file Minuit2Minimizer.cxx.

◆ SetVariableLowerLimit()

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.

Definition at line 286 of file Minuit2Minimizer.cxx.

◆ SetVariableStepSize()

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.

Definition at line 278 of file Minuit2Minimizer.cxx.

◆ SetVariableUpperLimit()

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.

Definition at line 293 of file Minuit2Minimizer.cxx.

◆ SetVariableValue()

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

virtual

set variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 262 of file Minuit2Minimizer.cxx.

◆ SetVariableValues()

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.

Definition at line 269 of file Minuit2Minimizer.cxx.

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

◆ VariableIndex()

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.

Definition at line 255 of file Minuit2Minimizer.cxx.

◆ VariableName()

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.

Definition at line 248 of file Minuit2Minimizer.cxx.

◆ X()

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

virtual

return pointer to X values at the minimum

Implements ROOT::Math::Minimizer.

Definition at line 642 of file Minuit2Minimizer.cxx.

Member Data Documentation

◆ fDim

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

private

Definition at line 310 of file Minuit2Minimizer.h.

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

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

◆ fState

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

private

Definition at line 313 of file Minuit2Minimizer.h.

◆ fUseFumili

bool ROOT::Minuit2::Minuit2Minimizer::fUseFumili

private

Definition at line 311 of file Minuit2Minimizer.h.

◆ fValues

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

mutableprivate

Definition at line 318 of file Minuit2Minimizer.h.

Libraries for ROOT::Minuit2::Minuit2Minimizer:

[legend]

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Minuit2Minimizer() [1/3]

◆ Minuit2Minimizer() [2/3]

◆ ~Minuit2Minimizer()

◆ Minuit2Minimizer() [3/3]

Member Function Documentation

◆ Clear()

◆ Contour()

◆ Correlation()

◆ CovMatrix()

◆ CovMatrixStatus()

◆ Edm()

◆ Errors()

◆ ExamineMinimum()

◆ FixVariable()

◆ GetCovMatrix()

◆ GetFCN()

◆ GetHessianMatrix()

◆ GetMinimizer()

◆ GetMinosError()

◆ GetVariableSettings()

◆ GlobalCC()

◆ Hesse()

◆ IsFixedVariable()

◆ MinGradient()

◆ Minimize()

◆ MinValue()

◆ NCalls()

◆ NDim()

◆ NFree()

◆ operator=()

◆ PrintResults()

◆ ProvidesError()

◆ ReleaseVariable()

◆ Scan()

◆ SetFixedVariable()

◆ SetFunction() [1/2]

◆ SetFunction() [2/2]

◆ SetLimitedVariable()

◆ SetLowerLimitedVariable()

◆ SetMinimizer()

◆ SetMinimizerType()

◆ SetStorageLevel()

◆ SetTraceObject()

◆ SetUpperLimitedVariable()

◆ SetVariable()

◆ SetVariableLimits()

◆ SetVariableLowerLimit()

◆ SetVariableStepSize()

◆ SetVariableUpperLimit()

◆ SetVariableValue()

◆ SetVariableValues()

◆ State()

◆ VariableIndex()

◆ VariableName()

◆ X()

Member Data Documentation

◆ fDim

◆ fErrors

◆ fMinimizer

◆ fMinimum

◆ fMinuitFCN

◆ fState

◆ fUseFumili

◆ fValues