TMinuitMinimizer class: ROOT::Math::Minimizer implementation based on TMinuit.

Note: See ROOT::Minuit2 for a newer version of this class TMinuitMinimizer class implementing the ROOT::Math::Minimizer interface using TMinuit. This class is normally instantiated using the plug-in manager (plug-in with name Minuit or TMinuit). In addition the user can choose the minimizer algorithm: Migrad (the default one), Simplex, or Minimize (combined Migrad + Simplex)

Definition at line 51 of file TMinuitMinimizer.h.

Public Member Functions
	TMinuitMinimizer (const char *type, unsigned int ndim=0)
	Constructor from a char * (used by PM).
	TMinuitMinimizer (ROOT::Minuit::EMinimizerType type=ROOT::Minuit::kMigrad, unsigned int ndim=0)
	Default constructor.
	~TMinuitMinimizer () override
	Destructor (no operations).
virtual void	Clear ()
	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();
virtual double	Correlation (unsigned int i, unsigned int j) const
double	CovMatrix (unsigned int i, unsigned int j) const override
	return covariance matrices elements if the variable is fixed the matrix is zero The ordering of the variables is the same as in errors
int	CovMatrixStatus () const override
	return status of covariance 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) 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.
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
	minos error for variable i, return false if Minos failed
bool	GetVariableSettings (unsigned int, ROOT::Fit::ParameterSettings &) const override
	get variable settings in a variable object (like ROOT::Fit::ParamsSettings)
std::vector< double >	GlobalCC () const override
	global correlation coefficient for variable i
bool	Hesse () override
	perform a full calculation of the Hessian matrix for error calculation
virtual TClass *	IsA () const
bool	IsFixedVariable (unsigned int) 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 minos status = -1 : Minos is not run = 0 : last MINOS run was successful > 0 : some problems encountered when running MINOS
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
	Print the result according to set level (implemented for TMinuit for maintaining Minuit-style printing).
bool	ProvidesError () const override
	minimizer provides error and error matrix
bool	ReleaseVariable (unsigned int) 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.
virtual bool	SetCovariance (std::span< const double > cov, unsigned int nrow)
	Set initial covariance matrix.
virtual bool	SetCovarianceDiag (std::span< const double > d2, unsigned int n)
	Set initial second derivatives.
bool	SetDebug (bool on=true)
	set debug mode. Return true if setting was successful
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.
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
virtual void	SetHessianFunction (std::function< bool(std::span< const double >, double *)>)
	Set the function implementing Hessian computation (re-implemented by Minimizer using it).
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	SetStrategy (int strategyLevel)
	Set the strategy.
void	SetTolerance (double tol)
	Set the tolerance.
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 existing variable
bool	SetVariableLowerLimit (unsigned int, double) override
	set the lower-limit of an existing variable
template<class VariableIterator>
int	SetVariables (const VariableIterator &begin, const VariableIterator &end)
	Add variables.
bool	SetVariableStepSize (unsigned int, double) override
	set the step size of an existing variable
bool	SetVariableUpperLimit (unsigned int, double) override
	set the upper-limit of an existing variable
bool	SetVariableValue (unsigned int, double) override
	set the value of an existing variable
virtual bool	SetVariableValues (const double *x)
	Set the values of all existing variables (array must be dimensioned to the size of the existing parameters).
int	Status () const
	Status code of minimizer.
int	Strategy () const
	Strategy.
virtual void	Streamer (TBuffer &)
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
void	SuppressMinuitWarnings (bool nowarn=true)
	suppress the minuit warnings (if called with false will enable them) By default they are suppressed only when the printlevel is <= 0
double	Tolerance () const
	Absolute tolerance.
int	VariableIndex (const std::string &name) const override
	get index of variable given a variable given a name return always -1 .
std::string	VariableName (unsigned int ivar) const override
	return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const;
const double *	X () const override
	return pointer to X values at the minimum

Static Public Member Functions
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static bool	UseStaticMinuit (bool on=true)
	static function to switch on/off usage of static global TMinuit instance (gMinuit) By default it is used (i.e.

Protected Member Functions
bool	CheckMinuitInstance () const
	check TMinuit instance
bool	CheckVarIndex (unsigned int ivar) const
	check parameter
void	DoClear ()
	reset
void	DoReleaseFixParameter (int ivar)
	release a parameter that is fixed when it is redefined
void	InitTMinuit (int ndim)
	initialize the TMinuit instance
void	RetrieveErrorMatrix ()
	retrieve error matrix from TMinuit
void	RetrieveParams ()
	retrieve minimum parameters and errors from TMinuit

Static Protected Member Functions
static void	Fcn (int &, double , double &f, double , int)
	implementation of FCN for Minuit
static void	FcnGrad (int &, double g, double &f, double , int)
	implementation of FCN for Minuit when user provided gradient is used

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
std::vector< double >	fCovar
unsigned int	fDim
std::vector< double >	fErrors
bool	fMinosRun
int	fMinosStatus = -1
TMinuit *	fMinuit
std::vector< double >	fParams
ROOT::Minuit::EMinimizerType	fType
bool	fUsed

Static Private Attributes
static TMinuit *	fgMinuit = nullptr
static bool	fgUsed = false
static bool	fgUseStaticMinuit = true

#include <TMinuitMinimizer.h>

Inheritance diagram for TMinuitMinimizer:

Constructor & Destructor Documentation

◆ TMinuitMinimizer() [1/2]

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

Default constructor.

Definition at line 56 of file TMinuitMinimizer.cxx.

◆ TMinuitMinimizer() [2/2]

TMinuitMinimizer::TMinuitMinimizer	(	const char *	type,
		unsigned int	ndim = 0 )

Constructor from a char * (used by PM).

Definition at line 72 of file TMinuitMinimizer.cxx.

◆ ~TMinuitMinimizer()

TMinuitMinimizer::~TMinuitMinimizer ( )

override

Destructor (no operations).

Definition at line 100 of file TMinuitMinimizer.cxx.

Member Function Documentation

◆ CheckMinuitInstance()

bool TMinuitMinimizer::CheckMinuitInstance ( ) const

protected

check TMinuit instance

Definition at line 289 of file TMinuitMinimizer.cxx.

◆ CheckVarIndex()

bool TMinuitMinimizer::CheckVarIndex ( unsigned int ivar ) const

protected

check parameter

Definition at line 298 of file TMinuitMinimizer.cxx.

◆ Class()

TClass * TMinuitMinimizer::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

const char * TMinuitMinimizer::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

constexpr Version_t TMinuitMinimizer::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 272 of file TMinuitMinimizer.h.

◆ Clear()

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

inlinevirtualinherited

Reset for consecutive minimization - implement if needed.

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

Definition at line 141 of file Minimizer.h.

◆ Contour()

bool TMinuitMinimizer::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 893 of file TMinuitMinimizer.cxx.

◆ Correlation()

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

inlinevirtualinherited

Returns: correlation coefficient between variable i and j. If the variable is fixed or const the return value is zero

Reimplemented in ROOT::Minuit2::Minuit2Minimizer.

Definition at line 281 of file Minimizer.h.

◆ CovMatrix()

double TMinuitMinimizer::CovMatrix	(	unsigned int	i,
		unsigned int	j ) const

inlineoverridevirtual

return covariance matrices elements if the variable is fixed the matrix is zero The ordering of the variables is the same as in errors

Reimplemented from ROOT::Math::Minimizer.

Definition at line 146 of file TMinuitMinimizer.h.

◆ CovMatrixStatus()

int TMinuitMinimizer::CovMatrixStatus ( ) const

overridevirtual

return status of covariance matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 720 of file TMinuitMinimizer.cxx.

◆ DeclFileName()

const char * TMinuitMinimizer::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 272 of file TMinuitMinimizer.h.

◆ DoClear()

void TMinuitMinimizer::DoClear ( )

protected

reset

Definition at line 835 of file TMinuitMinimizer.cxx.

◆ DoReleaseFixParameter()

void TMinuitMinimizer::DoReleaseFixParameter ( int ivar )

protected

release a parameter that is fixed when it is redefined

Definition at line 850 of file TMinuitMinimizer.cxx.

◆ Edm()

double TMinuitMinimizer::Edm ( ) const

overridevirtual

return expected distance reached from the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 653 of file TMinuitMinimizer.cxx.

◆ 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 * TMinuitMinimizer::Errors ( ) const

inlineoverridevirtual

return errors at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 140 of file TMinuitMinimizer.h.

◆ Fcn()

void TMinuitMinimizer::Fcn	(	int &	,
		double *	,
		double &	f,
		double *	x,
		int	)

staticprotected

implementation of FCN for Minuit

Definition at line 223 of file TMinuitMinimizer.cxx.

◆ FcnGrad()

void TMinuitMinimizer::FcnGrad	(	int &	,
		double *	g,
		double &	f,
		double *	x,
		int	iflag )

staticprotected

implementation of FCN for Minuit when user provided gradient is used

Definition at line 229 of file TMinuitMinimizer.cxx.

◆ FixVariable()

bool TMinuitMinimizer::FixVariable ( unsigned int ivar )

overridevirtual

fix an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 387 of file TMinuitMinimizer.cxx.

◆ GetCovMatrix()

bool TMinuitMinimizer::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 669 of file TMinuitMinimizer.cxx.

◆ GetHessianMatrix()

bool TMinuitMinimizer::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 681 of file TMinuitMinimizer.cxx.

◆ GetMinosError()

bool TMinuitMinimizer::GetMinosError	(	unsigned int	i,
		double &	errLow,
		double &	errUp,
		int	= 0 )

overridevirtual

minos error for variable i, return false if Minos failed

Reimplemented from ROOT::Math::Minimizer.

Definition at line 755 of file TMinuitMinimizer.cxx.

◆ GetVariableSettings()

bool TMinuitMinimizer::GetVariableSettings	(	unsigned int	ivar,
		ROOT::Fit::ParameterSettings &	var ) const

overridevirtual

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 410 of file TMinuitMinimizer.cxx.

◆ GlobalCC()

std::vector< double > TMinuitMinimizer::GlobalCC ( ) const

overridevirtual

global correlation coefficient for variable i

Reimplemented from ROOT::Math::Minimizer.

Definition at line 733 of file TMinuitMinimizer.cxx.

◆ Hesse()

bool TMinuitMinimizer::Hesse ( )

overridevirtual

perform a full calculation of the Hessian matrix for error calculation

Reimplemented from ROOT::Math::Minimizer.

Definition at line 1013 of file TMinuitMinimizer.cxx.

◆ InitTMinuit()

void TMinuitMinimizer::InitTMinuit ( int ndim )

protected

initialize the TMinuit instance

Definition at line 116 of file TMinuitMinimizer.cxx.

◆ IsA()

virtual TClass * TMinuitMinimizer::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Definition at line 272 of file TMinuitMinimizer.h.

◆ IsFixedVariable()

bool TMinuitMinimizer::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 403 of file TMinuitMinimizer.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 * TMinuitMinimizer::MinGradient ( ) const

inlineoverridevirtual

return pointer to gradient values at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 123 of file TMinuitMinimizer.h.

◆ Minimize()

bool TMinuitMinimizer::Minimize ( )

overridevirtual

method to perform the minimization

Implements ROOT::Math::Minimizer.

Definition at line 439 of file TMinuitMinimizer.cxx.

◆ MinosStatus()

int TMinuitMinimizer::MinosStatus ( ) const

inlineoverridevirtual

minos status code of last Minos run minos status = -1 : Minos is not run = 0 : last MINOS run was successful > 0 : some problems encountered when running MINOS

Reimplemented from ROOT::Math::Minimizer.

Definition at line 182 of file TMinuitMinimizer.h.

◆ MinValue()

double TMinuitMinimizer::MinValue ( ) const

overridevirtual

return minimum function value

Implements ROOT::Math::Minimizer.

Definition at line 643 of file TMinuitMinimizer.cxx.

◆ NCalls()

unsigned int TMinuitMinimizer::NCalls ( ) const

overridevirtual

number of function calls to reach the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 637 of file TMinuitMinimizer.cxx.

◆ NDim()

unsigned int TMinuitMinimizer::NDim ( ) const

inlineoverridevirtual

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

Implements ROOT::Math::Minimizer.

Definition at line 130 of file TMinuitMinimizer.h.

◆ NFree()

unsigned int TMinuitMinimizer::NFree ( ) const

overridevirtual

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 662 of file TMinuitMinimizer.cxx.

◆ 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 TMinuitMinimizer::PrintResults ( )

overridevirtual

Print the result according to set level (implemented for TMinuit for maintaining Minuit-style printing).

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 871 of file TMinuitMinimizer.cxx.

◆ ProvidesError()

bool TMinuitMinimizer::ProvidesError ( ) const

inlineoverridevirtual

minimizer provides error and error matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 137 of file TMinuitMinimizer.h.

◆ ReleaseVariable()

bool TMinuitMinimizer::ReleaseVariable ( unsigned int ivar )

overridevirtual

release an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 395 of file TMinuitMinimizer.cxx.

◆ RetrieveErrorMatrix()

void TMinuitMinimizer::RetrieveErrorMatrix ( )

protected

retrieve error matrix from TMinuit

Definition at line 600 of file TMinuitMinimizer.cxx.

◆ RetrieveParams()

void TMinuitMinimizer::RetrieveParams ( )

protected

retrieve minimum parameters and errors from TMinuit

Definition at line 586 of file TMinuitMinimizer.cxx.

◆ Scan()

bool TMinuitMinimizer::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 941 of file TMinuitMinimizer.cxx.

◆ SetCovariance()

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

virtualinherited

Set initial covariance matrix.

Set initial values for covariance/error matrix.

The covariance matrix must be provided in compressed form (row-major ordered upper traingular part)

Reimplemented in ROOT::Minuit2::Minuit2Minimizer.

Definition at line 26 of file Minimizer.cxx.

◆ SetCovarianceDiag()

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

virtualinherited

Set initial second derivatives.

set initial second derivatives

Reimplemented in ROOT::Minuit2::Minuit2Minimizer.

Definition at line 15 of file Minimizer.cxx.

◆ SetDebug()

bool TMinuitMinimizer::SetDebug ( bool on = true )

set debug mode. Return true if setting was successful

Definition at line 1058 of file TMinuitMinimizer.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.

◆ SetFixedVariable()

bool TMinuitMinimizer::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 308 of file TMinuitMinimizer.cxx.

◆ SetFunction()

void TMinuitMinimizer::SetFunction ( const ROOT::Math::IMultiGenFunction & func )

overridevirtual

set the function to minimize

Implements ROOT::Math::Minimizer.

Definition at line 191 of file TMinuitMinimizer.cxx.

◆ SetHessianFunction()

virtual void ROOT::Math::Minimizer::SetHessianFunction ( std::function< bool(std::span< const double >, double *)> )

inlinevirtualinherited

Set the function implementing Hessian computation (re-implemented by Minimizer using it).

Reimplemented in ROOT::Minuit2::Minuit2Minimizer.

Definition at line 147 of file Minimizer.h.

◆ SetLimitedVariable()

bool TMinuitMinimizer::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 258 of file TMinuitMinimizer.cxx.

◆ SetLowerLimitedVariable()

bool TMinuitMinimizer::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 274 of file TMinuitMinimizer.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.

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

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

◆ SetUpperLimitedVariable()

bool TMinuitMinimizer::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 281 of file TMinuitMinimizer.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 TMinuitMinimizer::SetVariable	(	unsigned int	ivar,
		const std::string &	name,
		double	val,
		double	step )

overridevirtual

set free variable

Implements ROOT::Math::Minimizer.

Definition at line 242 of file TMinuitMinimizer.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 TMinuitMinimizer::SetVariableLimits	(	unsigned int	ivar,
		double	lower,
		double	upper )

overridevirtual

set the limits of an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 370 of file TMinuitMinimizer.cxx.

◆ SetVariableLowerLimit()

bool TMinuitMinimizer::SetVariableLowerLimit	(	unsigned int	ivar,
		double	lower )

overridevirtual

set the lower-limit of an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 357 of file TMinuitMinimizer.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 TMinuitMinimizer::SetVariableStepSize	(	unsigned int	ivar,
		double	step )

overridevirtual

set the step size of an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 341 of file TMinuitMinimizer.cxx.

◆ SetVariableUpperLimit()

bool TMinuitMinimizer::SetVariableUpperLimit	(	unsigned int	ivar,
		double	upper )

overridevirtual

set the upper-limit of an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 363 of file TMinuitMinimizer.cxx.

◆ SetVariableValue()

bool TMinuitMinimizer::SetVariableValue	(	unsigned int	ivar,
		double	val )

overridevirtual

set the value of an existing variable

Reimplemented from ROOT::Math::Minimizer.

Definition at line 327 of file TMinuitMinimizer.cxx.

◆ SetVariableValues()

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

inlinevirtualinherited

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

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

Definition at line 204 of file Minimizer.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.

◆ Streamer()

virtual void TMinuitMinimizer::Streamer ( TBuffer & )

virtual

◆ StreamerNVirtual()

void TMinuitMinimizer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 272 of file TMinuitMinimizer.h.

◆ SuppressMinuitWarnings()

void TMinuitMinimizer::SuppressMinuitWarnings ( bool nowarn = true )

suppress the minuit warnings (if called with false will enable them) By default they are suppressed only when the printlevel is <= 0

Definition at line 882 of file TMinuitMinimizer.cxx.

◆ Tolerance()

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

inlineinherited

Absolute tolerance.

Definition at line 317 of file Minimizer.h.

◆ UseStaticMinuit()

bool TMinuitMinimizer::UseStaticMinuit ( bool on = true )

static

static function to switch on/off usage of static global TMinuit instance (gMinuit) By default it is used (i.e.

is on). Method returns the previous state

Definition at line 109 of file TMinuitMinimizer.cxx.

◆ VariableIndex()

int TMinuitMinimizer::VariableIndex ( const std::string & name ) const

overridevirtual

get index of variable given a variable given a name return always -1 .

(It is Not implemented)

Reimplemented from ROOT::Math::Minimizer.

Definition at line 433 of file TMinuitMinimizer.cxx.

◆ VariableName()

std::string TMinuitMinimizer::VariableName ( unsigned int ivar ) const

overridevirtual

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

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

Reimplemented from ROOT::Math::Minimizer.

Definition at line 426 of file TMinuitMinimizer.cxx.

◆ X()

const double * TMinuitMinimizer::X ( ) const

inlineoverridevirtual

return pointer to X values at the minimum

Implements ROOT::Math::Minimizer.

Definition at line 120 of file TMinuitMinimizer.h.

Member Data Documentation

◆ fCovar

std::vector<double> TMinuitMinimizer::fCovar

private

Definition at line 262 of file TMinuitMinimizer.h.

◆ fDim

unsigned int TMinuitMinimizer::fDim

private

Definition at line 258 of file TMinuitMinimizer.h.

◆ fErrors

std::vector<double> TMinuitMinimizer::fErrors

private

Definition at line 261 of file TMinuitMinimizer.h.

◆ fgMinuit

TMinuit * TMinuitMinimizer::fgMinuit = nullptr

staticprivate

Definition at line 267 of file TMinuitMinimizer.h.

◆ fgUsed

bool TMinuitMinimizer::fgUsed = false

staticprivate

Definition at line 269 of file TMinuitMinimizer.h.

◆ fgUseStaticMinuit

bool TMinuitMinimizer::fgUseStaticMinuit = true

staticprivate

Definition at line 270 of file TMinuitMinimizer.h.

◆ fMinosRun

bool TMinuitMinimizer::fMinosRun

private

Definition at line 257 of file TMinuitMinimizer.h.

◆ fMinosStatus

int TMinuitMinimizer::fMinosStatus = -1

private

Definition at line 259 of file TMinuitMinimizer.h.

◆ fMinuit

TMinuit* TMinuitMinimizer::fMinuit

private

Definition at line 265 of file TMinuitMinimizer.h.

◆ fOptions

MinimizerOptions ROOT::Math::Minimizer::fOptions

protectedinherited

minimizer options

Definition at line 387 of file Minimizer.h.

◆ fParams

std::vector<double> TMinuitMinimizer::fParams

private

Definition at line 260 of file TMinuitMinimizer.h.

◆ fStatus

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

protectedinherited

status of minimizer

Definition at line 388 of file Minimizer.h.

◆ fType

ROOT::Minuit::EMinimizerType TMinuitMinimizer::fType

private

Definition at line 264 of file TMinuitMinimizer.h.

◆ fUsed

bool TMinuitMinimizer::fUsed

private

Definition at line 256 of file TMinuitMinimizer.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.

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

math/minuit/inc/TMinuitMinimizer.h
math/minuit/src/TMinuitMinimizer.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ TMinuitMinimizer() [1/2]

◆ TMinuitMinimizer() [2/2]

◆ ~TMinuitMinimizer()

Member Function Documentation

◆ CheckMinuitInstance()

◆ CheckVarIndex()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clear()

◆ Contour()

◆ Correlation()

◆ CovMatrix()

◆ CovMatrixStatus()

◆ DeclFileName()

◆ DoClear()

◆ DoReleaseFixParameter()

◆ Edm()

◆ ErrorDef()

◆ Errors()

◆ Fcn()

◆ FcnGrad()

◆ FixVariable()

◆ GetCovMatrix()

◆ GetHessianMatrix()

◆ GetMinosError()

◆ GetVariableSettings()

◆ GlobalCC()

◆ Hesse()

◆ InitTMinuit()

◆ IsA()

◆ IsFixedVariable()

◆ IsValidError()

◆ MaxFunctionCalls()

◆ MaxIterations()

◆ MinGradient()

◆ Minimize()

◆ MinosStatus()

◆ MinValue()

◆ NCalls()

◆ NDim()

◆ NFree()

◆ NIterations()

◆ Options()

◆ Precision()

◆ PrintLevel()

◆ PrintResults()

◆ ProvidesError()

◆ ReleaseVariable()

◆ RetrieveErrorMatrix()

◆ RetrieveParams()

◆ Scan()

◆ SetCovariance()

◆ SetCovarianceDiag()

◆ SetDebug()

◆ SetDefaultOptions()

◆ SetErrorDef()

◆ SetExtraOptions()

◆ SetFixedVariable()

◆ SetFunction()

◆ SetHessianFunction()

◆ SetLimitedVariable()

◆ SetLowerLimitedVariable()

◆ SetMaxFunctionCalls()

◆ SetMaxIterations()

◆ SetOptions()

◆ SetPrecision()

◆ SetPrintLevel()

◆ SetStrategy()

◆ SetTolerance()

◆ SetUpperLimitedVariable()

◆ SetValidError()