TLinearMinimizer class: minimizer implementation based on TMinuit.

Note: See ROOT::Minuit2 for a newer version of this class.

TLinearMinimizer, simple class implementing the ROOT::Math::Minimizer interface usingTLinearFitter. This class uses TLinearFitter to find directly (by solving a system of linear equations) the minimum of a least-square function which has a linear dependence in the fit parameters. This class is not used directly, but via the ROOT::Fitter class, when calling the LinearFit method. It is instantiates using the plug-in manager (plug-in name is "Linear").

Definition at line 31 of file TLinearMinimizer.h.

Public Member Functions
	TLinearMinimizer (const char *type)
	Constructor from a char * (used by PM).
	TLinearMinimizer (int type=0)
	Default constructor.
	~TLinearMinimizer () override
	Destructor (no operations).
virtual void	Clear ()
	Reset for consecutive minimization - implement if needed.
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.
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 covariance matrix status
double	Edm () const override
	return expected distance reached from the minimum
double	ErrorDef () const
const double *	Errors () const override
	return errors at the minimum
virtual bool	FixVariable (unsigned int ivar)
	Fix an existing variable.
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.
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.
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.
virtual bool	GetVariableSettings (unsigned int ivar, ROOT::Fit::ParameterSettings &pars) const
	Get variable settings in a variable object (like ROOT::Fit::ParamsSettings).
virtual std::vector< double >	GlobalCC () const
virtual bool	Hesse ()
	Perform a full calculation of the Hessian matrix for error calculation.
virtual TClass *	IsA () const
virtual bool	IsFixedVariable (unsigned int ivar) const
	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
virtual int	MinosStatus () const
	Status code of Minos (to be re-implemented by the minimizers supporting 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.
virtual void	PrintResults ()
	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
virtual bool	ReleaseVariable (unsigned int ivar)
	Release an existing variable.
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.
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.
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 fit model function
virtual void	SetHessianFunction (std::function< bool(std::span< const double >, double *)>)
	Set the function implementing Hessian computation (re-implemented by Minimizer using it).
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 (i.e.
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), leave upper bound unlimited.
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.
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), leave lower bound unlimited.
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, const std::string &, double, double) override
	set free variable (dummy impl. since there is no need to set variables in the Linear Fitter)
virtual bool	SetVariableInitialRange (unsigned int, double, double)
	Set the initial range of an existing variable.
virtual bool	SetVariableLimits (unsigned int ivar, double lower, double upper)
	Set the limits of an already existing variable.
virtual bool	SetVariableLowerLimit (unsigned int ivar, double lower)
	Set the lower-limit of an already existing variable.
template<class VariableIterator>
int	SetVariables (const VariableIterator &begin, const VariableIterator &end)
	Add variables.
virtual bool	SetVariableStepSize (unsigned int ivar, double value)
	Set the step size of an already existing variable.
virtual bool	SetVariableUpperLimit (unsigned int ivar, double upper)
	Set the upper-limit of an already existing variable.
virtual bool	SetVariableValue (unsigned int ivar, double value)
	Set the value of an already 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)
double	Tolerance () const
	Absolute tolerance.
virtual int	VariableIndex (const std::string &name) const
	Get index of variable given a variable given a name.
virtual std::string	VariableName (unsigned int ivar) const
	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

Static Public Member Functions
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()

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
TLinearFitter *	fFitter
double	fMinVal
unsigned int	fNFree
const ROOT::Math::IMultiGradFunction *	fObjFunc
std::vector< double >	fParams
bool	fRobust
	return reference to the objective function virtual const ROOT::Math::IGenFunction & Function() const;

#include <TLinearMinimizer.h>

Inheritance diagram for TLinearMinimizer:

Constructor & Destructor Documentation

◆ TLinearMinimizer() [1/2]

TLinearMinimizer::TLinearMinimizer ( int type = 0 )

Default constructor.

Definition at line 69 of file TLinearMinimizer.cxx.

◆ TLinearMinimizer() [2/2]

TLinearMinimizer::TLinearMinimizer ( const char * type )

Constructor from a char * (used by PM).

Definition at line 81 of file TLinearMinimizer.cxx.

◆ ~TLinearMinimizer()

TLinearMinimizer::~TLinearMinimizer ( )

override

Destructor (no operations).

Definition at line 99 of file TLinearMinimizer.cxx.

Member Function Documentation

◆ Class()

TClass * TLinearMinimizer::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

const char * TLinearMinimizer::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

constexpr Version_t TLinearMinimizer::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 126 of file TLinearMinimizer.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 ROOT::Math::Minimizer::Contour	(	unsigned int	ivar,
		unsigned int	jvar,
		unsigned int &	npoints,
		double *	xi,
		double *	xj )

virtualinherited

Find the contour points (xi, xj) of the function for parameter ivar and jvar around the minimum.

The contour will be find for value of the function = Min + ErrorUp();

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

Definition at line 219 of file Minimizer.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 TLinearMinimizer::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 95 of file TLinearMinimizer.h.

◆ CovMatrixStatus()

int TLinearMinimizer::CovMatrixStatus ( ) const

inlineoverridevirtual

return covariance matrix status

Reimplemented from ROOT::Math::Minimizer.

Definition at line 100 of file TLinearMinimizer.h.

◆ DeclFileName()

const char * TLinearMinimizer::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 126 of file TLinearMinimizer.h.

◆ Edm()

double TLinearMinimizer::Edm ( ) const

inlineoverridevirtual

return expected distance reached from the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 66 of file TLinearMinimizer.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 * TLinearMinimizer::Errors ( ) const

inlineoverridevirtual

return errors at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 89 of file TLinearMinimizer.h.

◆ FixVariable()

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

virtualinherited

Fix an existing variable.

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

Definition at line 95 of file Minimizer.cxx.

◆ GetCovMatrix()

bool ROOT::Math::Minimizer::GetCovMatrix ( double * covMat ) const

virtualinherited

Fill the passed array with the covariance matrix elements if the variable is fixed or const the value is zero.

The array will be filled as cov[i *ndim + j] The ordering of the variables is the same as in errors and parameter value. This is different from the direct interface of Minuit2 or TMinuit where the values were obtained only to variable parameters

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

Definition at line 144 of file Minimizer.cxx.

◆ GetHessianMatrix()

bool ROOT::Math::Minimizer::GetHessianMatrix ( double * hMat ) const

virtualinherited

Fill the passed array with the Hessian matrix elements The Hessian matrix is the matrix of the second derivatives and is the inverse of the covariance matrix If the variable is fixed or const the values for that variables are zero.

The array will be filled as h[i *ndim + j]

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

Definition at line 157 of file Minimizer.cxx.

◆ GetMinosError()

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

virtualinherited

Minos error for variable i, return false if Minos failed or not supported and the lower and upper errors are returned in errLow and errUp An extra flag specifies if only the lower (option=-1) or the upper (option=+1) error calculation is run.

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

Definition at line 180 of file Minimizer.cxx.

◆ GetVariableSettings()

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

virtualinherited

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

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

Definition at line 117 of file Minimizer.cxx.

◆ GlobalCC()

std::vector< double > ROOT::Math::Minimizer::GlobalCC ( ) const

virtualinherited

Returns: global correlation coefficient for variable i. This is a number between zero and one which gives the correlation between the i-th parameter and that linear combination of all other parameters which is most strongly correlated with i. Minimizer must overload method if implemented

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

Definition at line 170 of file Minimizer.cxx.

◆ Hesse()

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

virtualinherited

Perform a full calculation of the Hessian matrix for error calculation.

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

Definition at line 193 of file Minimizer.cxx.

◆ IsA()

virtual TClass * TLinearMinimizer::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Definition at line 126 of file TLinearMinimizer.h.

◆ IsFixedVariable()

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

virtualinherited

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

considered constant in the minimization).

Note: By default all variables are not fixed.

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

Definition at line 110 of file Minimizer.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 * TLinearMinimizer::MinGradient ( ) const

inlineoverridevirtual

return pointer to gradient values at the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 72 of file TLinearMinimizer.h.

◆ Minimize()

bool TLinearMinimizer::Minimize ( )

overridevirtual

method to perform the minimization

Implements ROOT::Math::Minimizer.

Definition at line 196 of file TLinearMinimizer.cxx.

◆ MinosStatus()

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

inlinevirtualinherited

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

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

Definition at line 330 of file Minimizer.h.

◆ MinValue()

double TLinearMinimizer::MinValue ( ) const

inlineoverridevirtual

return minimum function value

Implements ROOT::Math::Minimizer.

Definition at line 63 of file TLinearMinimizer.h.

◆ NCalls()

unsigned int TLinearMinimizer::NCalls ( ) const

inlineoverridevirtual

number of function calls to reach the minimum

Reimplemented from ROOT::Math::Minimizer.

Definition at line 75 of file TLinearMinimizer.h.

◆ NDim()

unsigned int TLinearMinimizer::NDim ( ) const

inlineoverridevirtual

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

Implements ROOT::Math::Minimizer.

Definition at line 79 of file TLinearMinimizer.h.

◆ NFree()

unsigned int TLinearMinimizer::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 83 of file TLinearMinimizer.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()

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

inlinevirtualinherited

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

Definition at line 299 of file Minimizer.h.

◆ ProvidesError()

bool TLinearMinimizer::ProvidesError ( ) const

inlineoverridevirtual

minimizer provides error and error matrix

Reimplemented from ROOT::Math::Minimizer.

Definition at line 86 of file TLinearMinimizer.h.

◆ ReleaseVariable()

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

virtualinherited

Release an existing variable.

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

Definition at line 102 of file Minimizer.cxx.

◆ Scan()

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

virtualinherited

Scan function minimum for variable i.

Variable and function must be set before using Scan.

Returns: false if an error or if minimizer does not support this functionality

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

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

◆ 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 TLinearMinimizer::SetFixedVariable	(	unsigned int	ivar,
		const std::string &	,
		double	val )

overridevirtual

set fixed variable (override if minimizer supports them )

Reimplemented from ROOT::Math::Minimizer.

Definition at line 189 of file TLinearMinimizer.cxx.

◆ SetFunction()

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

overridevirtual

set the fit model function

Implements ROOT::Math::Minimizer.

Definition at line 105 of file TLinearMinimizer.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 ROOT::Math::Minimizer::SetLimitedVariable	(	unsigned int	ivar,
		const std::string &	name,
		double	val,
		double	step,
		double	lower,
		double	upper )

virtualinherited

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

the lower and upper bounds will be ignored).

See also: Minimizer::SetVariable

Parameters

ivar	the index of this variable in the array
name	the variable name
val	the value
step	the step size
lower	the lower bound
upper	this upper bound

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

Definition at line 42 of file Minimizer.cxx.

◆ SetLowerLimitedVariable()

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

inlinevirtualinherited

Set a new lower limit variable (override if minimizer supports them), leave upper bound unlimited.

See also: Minimizer::SetLimitedVariable

Parameters

ivar	the index of this variable in the array
name	the variable name
val	the value
step	the step size
lower	the lower bound

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

Definition at line 186 of file Minimizer.h.

◆ 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()

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

inlinevirtualinherited

Set a new upper limit variable (override if minimizer supports them), leave lower bound unlimited.

See also: Minimizer::SetLimitedVariable

Parameters

ivar	the index of this variable in the array
name	the variable name
val	the value
step	the step size
upper	the upper bound

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

Definition at line 196 of file Minimizer.h.

◆ 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 TLinearMinimizer::SetVariable	(	unsigned int	,
		const std::string &	,
		double	,
		double	)

inlineoverridevirtual

set free variable (dummy impl. since there is no need to set variables in the Linear Fitter)

Implements ROOT::Math::Minimizer.

Definition at line 54 of file TLinearMinimizer.h.

◆ 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()

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

inlinevirtualinherited

Set the limits of an already existing variable.

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

Definition at line 216 of file Minimizer.h.

◆ SetVariableLowerLimit()

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

virtualinherited

Set the lower-limit of an already existing variable.

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

Definition at line 78 of file Minimizer.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::Math::Minimizer::SetVariableStepSize	(	unsigned int	ivar,
		double	value )

virtualinherited

Set the step size of an already existing variable.

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

Definition at line 70 of file Minimizer.cxx.

◆ SetVariableUpperLimit()

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

virtualinherited

Set the upper-limit of an already existing variable.

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

Definition at line 86 of file Minimizer.cxx.

◆ SetVariableValue()

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

virtualinherited

Set the value of an already existing variable.

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

Definition at line 61 of file Minimizer.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 TLinearMinimizer::Streamer ( TBuffer & )

virtual

◆ StreamerNVirtual()

void TLinearMinimizer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 126 of file TLinearMinimizer.h.

◆ Tolerance()

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

inlineinherited

Absolute tolerance.

Definition at line 317 of file Minimizer.h.

◆ VariableIndex()

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

virtualinherited

Get index of variable given a variable given a name.

Returns: -1 if variable is not found

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

Definition at line 240 of file Minimizer.cxx.

◆ VariableName()

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

virtualinherited

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

Returns: an empty string if variable is not found

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

Definition at line 232 of file Minimizer.cxx.

◆ X()

const double * TLinearMinimizer::X ( ) const

inlineoverridevirtual

return pointer to X values at the minimum

Implements ROOT::Math::Minimizer.

Definition at line 69 of file TLinearMinimizer.h.

Member Data Documentation

◆ fCovar

std::vector<double> TLinearMinimizer::fCovar

private

Definition at line 121 of file TLinearMinimizer.h.

◆ fDim

unsigned int TLinearMinimizer::fDim

private

Definition at line 116 of file TLinearMinimizer.h.

◆ fErrors

std::vector<double> TLinearMinimizer::fErrors

private

Definition at line 120 of file TLinearMinimizer.h.

◆ fFitter

TLinearFitter* TLinearMinimizer::fFitter

private

Definition at line 124 of file TLinearMinimizer.h.

◆ fMinVal

double TLinearMinimizer::fMinVal

private

Definition at line 118 of file TLinearMinimizer.h.

◆ fNFree

unsigned int TLinearMinimizer::fNFree

private

Definition at line 117 of file TLinearMinimizer.h.

◆ fObjFunc

const ROOT::Math::IMultiGradFunction* TLinearMinimizer::fObjFunc

private

Definition at line 123 of file TLinearMinimizer.h.

◆ fOptions

MinimizerOptions ROOT::Math::Minimizer::fOptions

protectedinherited

minimizer options

Definition at line 387 of file Minimizer.h.

◆ fParams

std::vector<double> TLinearMinimizer::fParams

private

Definition at line 119 of file TLinearMinimizer.h.

◆ fRobust

bool TLinearMinimizer::fRobust

private

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

Definition at line 115 of file TLinearMinimizer.h.

◆ fStatus

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

protectedinherited

status of minimizer

Definition at line 388 of file Minimizer.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/TLinearMinimizer.h
math/minuit/src/TLinearMinimizer.cxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ TLinearMinimizer() [1/2]

◆ TLinearMinimizer() [2/2]

◆ ~TLinearMinimizer()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clear()

◆ Contour()

◆ Correlation()

◆ CovMatrix()

◆ CovMatrixStatus()

◆ DeclFileName()

◆ Edm()

◆ ErrorDef()

◆ Errors()

◆ FixVariable()

◆ GetCovMatrix()

◆ GetHessianMatrix()

◆ GetMinosError()

◆ GetVariableSettings()

◆ GlobalCC()

◆ Hesse()

◆ IsA()

◆ IsFixedVariable()

◆ IsValidError()

◆ MaxFunctionCalls()

◆ MaxIterations()

◆ MinGradient()

◆ Minimize()

◆ MinosStatus()

◆ MinValue()

◆ NCalls()

◆ NDim()

◆ NFree()

◆ NIterations()

◆ Options()

◆ Precision()

◆ PrintLevel()

◆ PrintResults()

◆ ProvidesError()

◆ ReleaseVariable()

◆ Scan()

◆ SetCovariance()

◆ SetCovarianceDiag()

◆ SetDefaultOptions()

◆ SetErrorDef()

◆ SetExtraOptions()

◆ SetFixedVariable()

◆ SetFunction()

◆ SetHessianFunction()

◆ SetLimitedVariable()

◆ SetLowerLimitedVariable()

◆ SetMaxFunctionCalls()

◆ SetMaxIterations()

◆ SetOptions()

◆ SetPrecision()

◆ SetPrintLevel()

◆ SetStrategy()

◆ SetTolerance()

◆ SetUpperLimitedVariable()

◆ SetValidError()

◆ SetVariable()

◆ SetVariableInitialRange()

◆ SetVariableLimits()

◆ SetVariableLowerLimit()

◆ SetVariables()

◆ SetVariableStepSize()

◆ SetVariableUpperLimit()

◆ SetVariableValue()

◆ SetVariableValues()

◆ Status()

◆ Strategy()

◆ Streamer()

◆ StreamerNVirtual()