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

Note: Some gradient calculations, such as Numerical2PGradientCalculator support parallelization via OpenMP. To profit from this acceleration, one needs to build ROOT using minuit2_omp=ON and later call GradientCalculator::SetParallelOMP()

Definition at line 58 of file Minuit2Minimizer.h.

Public Member Functions
	Minuit2Minimizer (const char *type)
	Constructor with a char (used by PM).
	Minuit2Minimizer (ROOT::Minuit2::EMinimizerType type=ROOT::Minuit2::kMigrad)
	Default constructor.
	~Minuit2Minimizer () override
	Destructor (no operations).
void	Clear () override
	Reset for consecutive minimization - implement if needed.
bool	Contour (unsigned int i, unsigned int j, unsigned int &npoints, double xi, double xj) override
	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();
double	Correlation (unsigned int i, unsigned int j) const override
	return correlation coefficient between variable i and j.
double	CovMatrix (unsigned int i, unsigned int j) const override
	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.
int	CovMatrixStatus () const override
	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
double	Edm () const override
	return expected distance reached from the minimum
double	ErrorDef () const
const double *	Errors () const override
	return errors at the minimum
bool	FixVariable (unsigned int ivar) override
	fix an existing variable
bool	GetCovMatrix (double *cov) const override
	Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero.
ROOT::Minuit2::FCNBase *	GetFCN ()
const ROOT::Minuit2::FCNBase *	GetFCN () const
bool	GetHessianMatrix (double *h) const override
	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.
bool	GetMinosError (unsigned int i, double &errLow, double &errUp, int=0) override
	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.
bool	GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &varObj) const override
	get variable settings in a variable object (like ROOT::Fit::ParamsSettings)
std::vector< double >	GlobalCC () const override
	get global correlation coefficient for the variable i.
bool	Hesse () override
	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
bool	IsFixedVariable (unsigned int ivar) const override
	query if an existing variable is fixed (i.e.
bool	IsValidError () const
unsigned int	MaxFunctionCalls () const
	Max number of function calls.
unsigned int	MaxIterations () const
	Max iterations.
const double *	MinGradient () const override
	return pointer to gradient values at the minimum
bool	Minimize () override
	method to perform the minimization.
int	MinosStatus () const override
	MINOS status code of last Minos run status & 1 > 0 : invalid lower error status & 2 > 0 : invalid upper error status & 4 > 0 : invalid because maximum number of function calls exceeded status & 8 > 0 : a new minimum has been found status & 16 > 0 : error is truncated because parameter is at lower/upper limit.
double	MinValue () const override
	return minimum function value
unsigned int	NCalls () const override
	number of function calls to reach the minimum
unsigned int	NDim () const override
	this is <= Function().NDim() which is the total number of variables (free+ constrained ones)
unsigned int	NFree () const override
	number of free variables (real dimension of the problem) this is <= Function().NDim() which is the total
virtual unsigned int	NIterations () const
	Number of iterations to reach the minimum.
virtual MinimizerOptions	Options () const
	Retrieve the minimizer options (implement derived class if needed).
double	Precision () const
	Precision of minimizer in the evaluation of the objective function.
int	PrintLevel () const
	Set print level.
void	PrintResults () override
	return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const;
bool	ProvidesError () const override
	minimizer provides error and error matrix
bool	ReleaseVariable (unsigned int ivar) override
	release an existing variable
bool	Scan (unsigned int i, unsigned int &nstep, double x, double y, double xmin=0, double xmax=0) override
	scan a parameter i around the minimum.
void	SetDefaultOptions ()
	Reset the default options (defined in MinimizerOptions).
void	SetErrorDef (double up)
	Set scale for calculating the errors.
void	SetExtraOptions (const IOptions &extraOptions)
	Set only the extra options.
void	SetFCN (unsigned int nDim, std::unique_ptr< ROOT::Minuit2::FCNBase > fcn)
	To set the function directly to a Minuit 2 function.
bool	SetFixedVariable (unsigned int, const std::string &, double) override
	set fixed variable (override if minimizer supports them )
void	SetFunction (const ROOT::Math::IMultiGenFunction &func) override
	set the function to minimize
void	SetHessianFunction (std::function< bool(std::span< const double >, double *)> hfunc) override
	set the function implementing Hessian computation
bool	SetLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double, double) override
	set upper/lower limited variable (override if minimizer supports them )
bool	SetLowerLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double lower) override
	set lower limit variable (override if minimizer supports them )
void	SetMaxFunctionCalls (unsigned int maxfcn)
	Set maximum of function calls.
void	SetMaxIterations (unsigned int maxiter)
	Set maximum iterations (one iteration can have many function calls).
void	SetOptions (const MinimizerOptions &opt)
	Set all options in one go.
void	SetPrecision (double prec)
	Set in the minimizer the objective function evaluation precision.
void	SetPrintLevel (int level)
	Set print level.
void	SetStorageLevel (int level)
	set storage level = 1 : store all iteration states (default) = 0 : store only first and last state to save memory
void	SetStrategy (int strategyLevel)
	Set the strategy.
void	SetTolerance (double tol)
	Set the tolerance.
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)
bool	SetUpperLimitedVariable (unsigned int ivar, const std::string &name, double val, double step, double upper) override
	set upper limit variable (override if minimizer supports them )
void	SetValidError (bool on)
	Flag to check if minimizer needs to perform accurate error analysis (e.g. run Hesse for Minuit).
bool	SetVariable (unsigned int ivar, const std::string &name, double val, double step) override
	set free variable
virtual bool	SetVariableInitialRange (unsigned int, double, double)
	Set the initial range of an existing variable.
bool	SetVariableLimits (unsigned int ivar, double lower, double upper) override
	set the limits of an already existing variable
bool	SetVariableLowerLimit (unsigned int ivar, double lower) override
	set the lower-limit of an already existing variable
template<class VariableIterator>
int	SetVariables (const VariableIterator &begin, const VariableIterator &end)
	Add variables.
bool	SetVariableStepSize (unsigned int ivar, double step) override
	set the step size of an already existing variable
bool	SetVariableUpperLimit (unsigned int ivar, double upper) override
	set the upper-limit of an already existing variable
bool	SetVariableValue (unsigned int ivar, double val) override
	set variable
bool	SetVariableValues (const double *val) override
	Set the values of all existing variables (array must be dimensioned to the size of the existing parameters).
const ROOT::Minuit2::MnUserParameterState &	State ()
	return the minimizer state (containing values, step size , etc..)
int	Status () const
	Status code of minimizer.
int	Strategy () const
	Strategy.
double	Tolerance () const
	Absolute tolerance.
int	VariableIndex (const std::string &name) const override
	get index of variable given a variable given a name return -1 if variable is not found
std::string	VariableName (unsigned int ivar) const override
	get name of variables (override if minimizer support storing of variable names)
const double *	X () const override
	return pointer to X values at the minimum

Protected Member Functions
bool	ExamineMinimum (const ROOT::Minuit2::FunctionMinimum &min)
	examine the minimum result
virtual const ROOT::Minuit2::ModularFunctionMinimizer *	GetMinimizer () const
int	RunMinosError (unsigned int i, double &errLow, double &errUp, int runopt)
bool	SetCovariance (std::span< const double > cov, unsigned int nrow) override
	set initial covariance matrix
virtual bool	SetCovarianceDiag (std::span< const double > d2, unsigned int n) override
	set initial second derivatives
void	SetMinimizerType (ROOT::Minuit2::EMinimizerType type)

Protected Attributes
MinimizerOptions	fOptions
	minimizer options
int	fStatus = -1
	status of minimizer
bool	fValidError = false
	flag to control if errors have been validated (Hesse has been run in case of Minuit)

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

#include <Minuit2/Minuit2Minimizer.h>

Inheritance diagram for ROOT::Minuit2::Minuit2Minimizer:

Constructor & Destructor Documentation

◆ Minuit2Minimizer() [1/2]

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

Default constructor.

Definition at line 84 of file Minuit2Minimizer.cxx.

◆ Minuit2Minimizer() [2/2]

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

Constructor with a char (used by PM).

Definition at line 90 of file Minuit2Minimizer.cxx.

◆ ~Minuit2Minimizer()

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

overridedefault

Destructor (no operations).

Member Function Documentation

◆ Clear()

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

overridevirtual

Reset for consecutive minimization - implement if needed.

Reimplemented from ROOT::Math::Minimizer.

Definition at line 137 of file Minuit2Minimizer.cxx.

◆ Contour()

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

overridevirtual

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 1156 of file Minuit2Minimizer.cxx.

◆ Correlation()

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

overridevirtual

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 817 of file Minuit2Minimizer.cxx.

◆ CovMatrix()

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

overridevirtual

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 741 of file Minuit2Minimizer.cxx.

◆ CovMatrixStatus()

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

overridevirtual

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 1314 of file Minuit2Minimizer.cxx.

◆ Edm()

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

inlineoverridevirtual

return expected distance reached from the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 144 of file Minuit2Minimizer.h.

◆ ErrorDef()

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

inlineinherited

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

Definition at line 334 of file Minimizer.h.

◆ Errors()

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

overridevirtual

return errors at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 719 of file Minuit2Minimizer.cxx.

◆ ExamineMinimum()

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

protected

examine the minimum result

Definition at line 596 of file Minuit2Minimizer.cxx.

◆ FixVariable()

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

overridevirtual

fix an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 317 of file Minuit2Minimizer.cxx.

◆ GetCovMatrix()

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

overridevirtual

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 757 of file Minuit2Minimizer.cxx.

◆ GetFCN() [1/2]

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

inline

Definition at line 286 of file Minuit2Minimizer.h.

◆ GetFCN() [2/2]

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

inline

Definition at line 285 of file Minuit2Minimizer.h.

◆ GetHessianMatrix()

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

overridevirtual

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 786 of file Minuit2Minimizer.cxx.

◆ GetMinimizer()

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

inlineprotectedvirtual

Definition at line 291 of file Minuit2Minimizer.h.

◆ GetMinosError()

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

overridevirtual

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.

The Minos status of last Minos run can also be retrieved by calling MinosStatus()

Reimplemented from ROOT::Math::Minimizer.

Definition at line 860 of file Minuit2Minimizer.cxx.

◆ GetVariableSettings()

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

overridevirtual

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 346 of file Minuit2Minimizer.cxx.

◆ GlobalCC()

std::vector< double > ROOT::Minuit2::Minuit2Minimizer::GlobalCC ( ) const

overridevirtual

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 837 of file Minuit2Minimizer.cxx.

◆ Hesse()

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

overridevirtual

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 1220 of file Minuit2Minimizer.cxx.

◆ IsFixedVariable()

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

overridevirtual

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 335 of file Minuit2Minimizer.cxx.

◆ IsValidError()

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

inlineinherited

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

Definition at line 337 of file Minimizer.h.

◆ MaxFunctionCalls()

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

inlineinherited

Max number of function calls.

Definition at line 311 of file Minimizer.h.

◆ MaxIterations()

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

inlineinherited

Max iterations.

Definition at line 314 of file Minimizer.h.

◆ MinGradient()

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

inlineoverridevirtual

return pointer to gradient values at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 150 of file Minuit2Minimizer.h.

◆ Minimize()

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

overridevirtual

method to perform the minimization.

Perform the minimization and store a copy of FunctionMinimum.

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

The maximum number of function calls used can be checked via this->MaxFunctionCalls(), if this value is 0 (the default), then it is replaced with 2 * (nvar + 1) * (200 + 100 * nvar + 5 * nvar * nvar where nvar is number of variable parameters.

See also: MnMinos::FindCrossValue Other minimization settings can be retrieved via Tolerance(), Strategy(), ErrorDef(), Precision(); ROOT::Math::MinimizerOptions::PrintDefault()

Implements ROOT::Math::Minimizer.

Definition at line 458 of file Minuit2Minimizer.cxx.

◆ MinosStatus()

int ROOT::Minuit2::Minuit2Minimizer::MinosStatus ( ) const

inlineoverridevirtual

MINOS status code of last Minos run status & 1 > 0 : invalid lower error status & 2 > 0 : invalid upper error status & 4 > 0 : invalid because maximum number of function calls exceeded status & 8 > 0 : a new minimum has been found status & 16 > 0 : error is truncated because parameter is at lower/upper limit.

Reimplemented from ROOT::Math::Minimizer.

Definition at line 238 of file Minuit2Minimizer.h.

◆ MinValue()

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

inlineoverridevirtual

return minimum function value

Implements ROOT::Math::Minimizer.

Definition at line 141 of file Minuit2Minimizer.h.

◆ NCalls()

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

inlineoverridevirtual

number of function calls to reach the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 153 of file Minuit2Minimizer.h.

◆ NDim()

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

inlineoverridevirtual

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

Implements ROOT::Math::Minimizer.

Definition at line 157 of file Minuit2Minimizer.h.

◆ NFree()

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

inlineoverridevirtual

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

◆ NIterations()

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

inlinevirtualinherited

Number of iterations to reach the minimum.

Definition at line 248 of file Minimizer.h.

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

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

◆ PrintLevel()

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

inlineinherited

Set print level.

Definition at line 308 of file Minimizer.h.

◆ PrintResults()

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

overridevirtual

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 686 of file Minuit2Minimizer.cxx.

◆ ProvidesError()

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

inlineoverridevirtual

minimizer provides error and error matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 164 of file Minuit2Minimizer.h.

◆ ReleaseVariable()

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

overridevirtual

release an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 326 of file Minuit2Minimizer.cxx.

◆ RunMinosError()

int ROOT::Minuit2::Minuit2Minimizer::RunMinosError	(	unsigned int	i,
		double &	errLow,
		double &	errUp,
		int	runopt )

protected

Definition at line 931 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 )

overridevirtual

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 1097 of file Minuit2Minimizer.cxx.

◆ SetCovariance()

bool ROOT::Minuit2::Minuit2Minimizer::SetCovariance	(	std::span< const double >	cov,
		unsigned int	nrow )

overrideprotectedvirtual

set initial covariance matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 191 of file Minuit2Minimizer.cxx.

◆ SetCovarianceDiag()

bool ROOT::Minuit2::Minuit2Minimizer::SetCovarianceDiag	(	std::span< const double >	d2,
		unsigned int	n )

overrideprotectedvirtual

set initial second derivatives

Reimplemented from ROOT::Math::Minimizer.

Definition at line 177 of file Minuit2Minimizer.cxx.

◆ SetDefaultOptions()

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

inlineinherited

Reset the default options (defined in MinimizerOptions).

Definition at line 378 of file Minimizer.h.

◆ SetErrorDef()

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

inlineinherited

Set scale for calculating the errors.

Definition at line 364 of file Minimizer.h.

◆ SetExtraOptions()

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

inlineinherited

Set only the extra options.

Definition at line 375 of file Minimizer.h.

◆ SetFCN()

void ROOT::Minuit2::Minuit2Minimizer::SetFCN	(	unsigned int	nDim,
		std::unique_ptr< ROOT::Minuit2::FCNBase >	fcn )

To set the function directly to a Minuit 2 function.

Definition at line 1355 of file Minuit2Minimizer.cxx.

◆ SetFixedVariable()

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

overridevirtual

set fixed variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

Definition at line 230 of file Minuit2Minimizer.cxx.

◆ SetFunction()

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

overridevirtual

set the function to minimize

Implements ROOT::Math::Minimizer.

Definition at line 370 of file Minuit2Minimizer.cxx.

◆ SetHessianFunction()

void ROOT::Minuit2::Minuit2Minimizer::SetHessianFunction ( std::function< bool(std::span< const double >, double *)> hfunc )

overridevirtual

set the function implementing Hessian computation

Reimplemented from ROOT::Math::Minimizer.

Definition at line 410 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 )

overridevirtual

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 220 of file Minuit2Minimizer.cxx.

◆ SetLowerLimitedVariable()

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

overridevirtual

set lower limit variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

Definition at line 200 of file Minuit2Minimizer.cxx.

◆ SetMaxFunctionCalls()

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

inlineinherited

Set maximum of function calls.

Definition at line 348 of file Minimizer.h.

◆ SetMaxIterations()

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

inlineinherited

Set maximum iterations (one iteration can have many function calls).

Definition at line 351 of file Minimizer.h.

◆ SetMinimizerType()

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

protected

Definition at line 113 of file Minuit2Minimizer.cxx.

◆ SetOptions()

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

inlineinherited

Set all options in one go.

Definition at line 370 of file Minimizer.h.

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

◆ SetPrintLevel()

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

inlineinherited

Set print level.

Definition at line 345 of file Minimizer.h.

◆ 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 1348 of file Minuit2Minimizer.cxx.

◆ SetStrategy()

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

inlineinherited

Set the strategy.

Definition at line 361 of file Minimizer.h.

◆ SetTolerance()

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

inlineinherited

Set the tolerance.

Definition at line 354 of file Minimizer.h.

◆ 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 1341 of file Minuit2Minimizer.cxx.

◆ SetUpperLimitedVariable()

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

overridevirtual

set upper limit variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

Definition at line 210 of file Minuit2Minimizer.cxx.

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

◆ SetVariable()

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

overridevirtual

set free variable

Implements ROOT::Math::Minimizer.

Definition at line 147 of file Minuit2Minimizer.cxx.

◆ SetVariableInitialRange()

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

inlinevirtualinherited

Set the initial range of an existing variable.

Definition at line 225 of file Minimizer.h.

◆ SetVariableLimits()

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

overridevirtual

set the limits of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 307 of file Minuit2Minimizer.cxx.

◆ SetVariableLowerLimit()

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

overridevirtual

set the lower-limit of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 288 of file Minuit2Minimizer.cxx.

◆ SetVariables()

template<class VariableIterator>

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

inlineinherited

Add variables.

Returns: number of variables successfully added

Definition at line 151 of file Minimizer.h.

◆ SetVariableStepSize()

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

overridevirtual

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 )

overridevirtual

set the upper-limit of an already existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 297 of file Minuit2Minimizer.cxx.

◆ SetVariableValue()

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

overridevirtual

set variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 258 of file Minuit2Minimizer.cxx.

◆ SetVariableValues()

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

overridevirtual

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

◆ Status()

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

inlineinherited

Status code of minimizer.

Definition at line 327 of file Minimizer.h.

◆ Strategy()

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

inlineinherited

Strategy.

Definition at line 324 of file Minimizer.h.

◆ Tolerance()

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

inlineinherited

Absolute tolerance.

Definition at line 317 of file Minimizer.h.

◆ VariableIndex()

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

overridevirtual

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 251 of file Minuit2Minimizer.cxx.

◆ VariableName()

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

overridevirtual

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 243 of file Minuit2Minimizer.cxx.

◆ X()

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

inlineoverridevirtual

return pointer to X values at the minimum

Implements ROOT::Math::Minimizer.

Definition at line 147 of file Minuit2Minimizer.h.

Member Data Documentation

◆ fDim

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

private

Definition at line 308 of file Minuit2Minimizer.h.

◆ fErrors

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

mutableprivate

Definition at line 317 of file Minuit2Minimizer.h.

◆ fMinimizer

std::unique_ptr<ROOT::Minuit2::ModularFunctionMinimizer> ROOT::Minuit2::Minuit2Minimizer::fMinimizer

private

Definition at line 313 of file Minuit2Minimizer.h.

◆ fMinimum

std::unique_ptr<ROOT::Minuit2::FunctionMinimum> ROOT::Minuit2::Minuit2Minimizer::fMinimum

private

Definition at line 315 of file Minuit2Minimizer.h.

◆ fMinosStatus

int ROOT::Minuit2::Minuit2Minimizer::fMinosStatus = -1

private

Definition at line 310 of file Minuit2Minimizer.h.

◆ fMinuitFCN

std::unique_ptr<ROOT::Minuit2::FCNBase> ROOT::Minuit2::Minuit2Minimizer::fMinuitFCN

private

Definition at line 314 of file Minuit2Minimizer.h.

◆ fOptions

MinimizerOptions ROOT::Math::Minimizer::fOptions

protectedinherited

minimizer options

Definition at line 387 of file Minimizer.h.

◆ fState

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

private

Definition at line 312 of file Minuit2Minimizer.h.

◆ fStatus

int ROOT::Math::Minimizer::fStatus = -1

protectedinherited

status of minimizer

Definition at line 388 of file Minimizer.h.

◆ fUseFumili

bool ROOT::Minuit2::Minuit2Minimizer::fUseFumili

private

Definition at line 309 of file Minuit2Minimizer.h.

◆ fValidError

bool ROOT::Math::Minimizer::fValidError = false

protectedinherited

flag to control if errors have been validated (Hesse has been run in case of Minuit)

Definition at line 386 of file Minimizer.h.

◆ fValues

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

mutableprivate

Definition at line 316 of file Minuit2Minimizer.h.

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

math/minuit2/inc/Minuit2/Minuit2Minimizer.h
math/minuit2/src/Minuit2Minimizer.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ Minuit2Minimizer() [1/2]

◆ Minuit2Minimizer() [2/2]

◆ ~Minuit2Minimizer()

Member Function Documentation

◆ Clear()

◆ Contour()

◆ Correlation()

◆ CovMatrix()

◆ CovMatrixStatus()

◆ Edm()

◆ ErrorDef()

◆ Errors()

◆ ExamineMinimum()

◆ FixVariable()

◆ GetCovMatrix()

◆ GetFCN() [1/2]

◆ GetFCN() [2/2]

◆ GetHessianMatrix()

◆ GetMinimizer()

◆ GetMinosError()

◆ GetVariableSettings()

◆ GlobalCC()

◆ Hesse()

◆ IsFixedVariable()

◆ IsValidError()

◆ MaxFunctionCalls()

◆ MaxIterations()

◆ MinGradient()

◆ Minimize()

◆ MinosStatus()

◆ MinValue()

◆ NCalls()

◆ NDim()

◆ NFree()

◆ NIterations()

◆ Options()

◆ Precision()

◆ PrintLevel()

◆ PrintResults()

◆ ProvidesError()

◆ ReleaseVariable()

◆ RunMinosError()

◆ Scan()

◆ SetCovariance()

◆ SetCovarianceDiag()

◆ SetDefaultOptions()

◆ SetErrorDef()

◆ SetExtraOptions()

◆ SetFCN()

◆ SetFixedVariable()

◆ SetFunction()

◆ SetHessianFunction()

◆ SetLimitedVariable()

◆ SetLowerLimitedVariable()

◆ SetMaxFunctionCalls()

◆ SetMaxIterations()

◆ SetMinimizerType()

◆ SetOptions()

◆ SetPrecision()

◆ SetPrintLevel()

◆ SetStorageLevel()

◆ SetStrategy()

◆ SetTolerance()

◆ SetTraceObject()

◆ SetUpperLimitedVariable()

◆ SetValidError()

◆ SetVariable()

◆ SetVariableInitialRange()

◆ SetVariableLimits()

◆ SetVariableLowerLimit()

◆ SetVariables()

◆ SetVariableStepSize()

◆ SetVariableUpperLimit()

◆ SetVariableValue()

◆ SetVariableValues()