ROOT::Minuit2::VariableMetricBuilder Class Reference

Description

Build (find) function minimum using the Variable Metric method (MIGRAD) Two possible error updators can be choosen

• Davidon : this is the standard formula used in Migrad
• BFGS this is the new formula based on BFGS algorithm (see Broyden–Fletcher–Goldfarb–Shanno algorithm
  https://en.wikipedia.org/wiki/Broyden–Fletcher–Goldfarb–Shanno_algorithm )

Definition at line 34 of file VariableMetricBuilder.h.

Inheritance diagram for ROOT::Minuit2::VariableMetricBuilder:

Collaboration diagram for ROOT::Minuit2::VariableMetricBuilder:

Public Types
enum	ErrorUpdatorType { kDavidon , kBFGS }

Public Member Functions
	VariableMetricBuilder (ErrorUpdatorType type=kDavidon)
	~VariableMetricBuilder ()
void	AddResult (std::vector< MinimumState > &result, const MinimumState &state) const
const MinimumErrorUpdator &	ErrorUpdator () const
const VariableMetricEDMEstimator &	Estimator () const
virtual FunctionMinimum	Minimum (const MnFcn &, const GradientCalculator &, const MinimumSeed &, const MnStrategy &, unsigned int, double) const
FunctionMinimum	Minimum (const MnFcn &, const GradientCalculator &, const MinimumSeed &, std::vector< MinimumState > &, unsigned int, double) const
int	PrintLevel () const
virtual void	SetPrintLevel (int level)
virtual void	SetStorageLevel (int level)
virtual void	SetTraceObject (MnTraceObject &obj)
int	StorageLevel () const
bool	TraceIter () const
void	TraceIteration (int iter, const MinimumState &state) const
MnTraceObject *	TraceObject () const

Private Attributes
std::shared_ptr< MinimumErrorUpdator >	fErrorUpdator
VariableMetricEDMEstimator	fEstimator
int	fPrintLevel
int	fStorageLevel
MnTraceObject *	fTracer

Member Enumeration Documentation

ErrorUpdatorType

enum ROOT::Minuit2::VariableMetricBuilder::ErrorUpdatorType

Enumerator
kDavidon
kBFGS

Definition at line 38 of file VariableMetricBuilder.h.

{ kDavidon, kBFGS }; 

Constructor & Destructor Documentation

VariableMetricBuilder()

ROOT::Minuit2::VariableMetricBuilder::VariableMetricBuilder ( ErrorUpdatorType  type = kDavidon )

inline

Definition at line 40 of file VariableMetricBuilder.h.

                                                           :
      fEstimator(VariableMetricEDMEstimator())
   {
      if (type == kBFGS) fErrorUpdator = std::unique_ptr<MinimumErrorUpdator>(new BFGSErrorUpdator());
      else fErrorUpdator = std::unique_ptr<MinimumErrorUpdator>(new DavidonErrorUpdator());
   }

References fErrorUpdator, and kBFGS.

~VariableMetricBuilder()

ROOT::Minuit2::VariableMetricBuilder::~VariableMetricBuilder ( )

inline

Definition at line 47 of file VariableMetricBuilder.h.

{}

Member Function Documentation

AddResult()

void ROOT::Minuit2::VariableMetricBuilder::AddResult	(	std::vector< MinimumState > &	result,
		const MinimumState &	state
	)		const

ErrorUpdator()

const MinimumErrorUpdator& ROOT::Minuit2::VariableMetricBuilder::ErrorUpdator ( ) const

inline

Definition at line 54 of file VariableMetricBuilder.h.

{return *fErrorUpdator;}

References fErrorUpdator.

Estimator()

const VariableMetricEDMEstimator& ROOT::Minuit2::VariableMetricBuilder::Estimator ( ) const

inline

Definition at line 53 of file VariableMetricBuilder.h.

{return fEstimator;}

References fEstimator.

Minimum() [1/2]

virtual FunctionMinimum ROOT::Minuit2::VariableMetricBuilder::Minimum ( const MnFcn &  , const GradientCalculator &  , const MinimumSeed &  , const MnStrategy &  , unsigned int  , double    ) const

virtual

Implements ROOT::Minuit2::MinimumBuilder.

Minimum() [2/2]

FunctionMinimum ROOT::Minuit2::VariableMetricBuilder::Minimum	(	const MnFcn &	,
		const GradientCalculator &	,
		const MinimumSeed &	,
		std::vector< MinimumState > &	,
		unsigned int	,
		double
	)		const

PrintLevel()

int ROOT::Minuit2::MinimumBuilder::PrintLevel ( ) const

inlineinherited

Definition at line 38 of file MinimumBuilder.h.

{ return fPrintLevel; }

References ROOT::Minuit2::MinimumBuilder::fPrintLevel.

SetPrintLevel()

virtual void ROOT::Minuit2::MinimumBuilder::SetPrintLevel ( int  level )

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 43 of file MinimumBuilder.h.

{ fPrintLevel = level;}

References ROOT::Minuit2::MinimumBuilder::fPrintLevel.

Referenced by ROOT::Minuit2::CombinedMinimumBuilder::SetPrintLevel().

SetStorageLevel()

virtual void ROOT::Minuit2::MinimumBuilder::SetStorageLevel ( int  level )

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 44 of file MinimumBuilder.h.

{ fStorageLevel = level;}

References ROOT::Minuit2::MinimumBuilder::fStorageLevel.

Referenced by ROOT::Minuit2::CombinedMinimumBuilder::SetStorageLevel().

SetTraceObject()

virtual void ROOT::Minuit2::MinimumBuilder::SetTraceObject ( MnTraceObject &  obj )

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 47 of file MinimumBuilder.h.

                                                    {
      fTracer = &obj;
   }

References ROOT::Minuit2::MinimumBuilder::fTracer.

Referenced by ROOT::Minuit2::CombinedMinimumBuilder::SetTraceObject().

StorageLevel()

int ROOT::Minuit2::MinimumBuilder::StorageLevel ( ) const

inlineinherited

Definition at line 37 of file MinimumBuilder.h.

{  return fStorageLevel; }

References ROOT::Minuit2::MinimumBuilder::fStorageLevel.

TraceIter()

bool ROOT::Minuit2::MinimumBuilder::TraceIter ( ) const

inlineinherited

Definition at line 40 of file MinimumBuilder.h.

{ return (fTracer); }

References ROOT::Minuit2::MinimumBuilder::fTracer.

TraceIteration()

void ROOT::Minuit2::MinimumBuilder::TraceIteration ( int  iter, const MinimumState &  state  ) const

inlineinherited

Definition at line 51 of file MinimumBuilder.h.

                                                                   {
      if (fTracer) (*fTracer)(iter, state);
   }

References ROOT::Minuit2::MinimumBuilder::fTracer.

TraceObject()

MnTraceObject* ROOT::Minuit2::MinimumBuilder::TraceObject ( ) const

inlineinherited

Definition at line 41 of file MinimumBuilder.h.

{ return (fTracer); }

References ROOT::Minuit2::MinimumBuilder::fTracer.

Member Data Documentation

fErrorUpdator

std::shared_ptr<MinimumErrorUpdator> ROOT::Minuit2::VariableMetricBuilder::fErrorUpdator

private

Definition at line 61 of file VariableMetricBuilder.h.

Referenced by VariableMetricBuilder(), and ErrorUpdator().

fEstimator

VariableMetricEDMEstimator ROOT::Minuit2::VariableMetricBuilder::fEstimator

private

Definition at line 60 of file VariableMetricBuilder.h.

Referenced by Estimator().

fPrintLevel

int ROOT::Minuit2::MinimumBuilder::fPrintLevel

privateinherited

Definition at line 57 of file MinimumBuilder.h.

Referenced by ROOT::Minuit2::MinimumBuilder::PrintLevel(), and ROOT::Minuit2::MinimumBuilder::SetPrintLevel().

fStorageLevel

int ROOT::Minuit2::MinimumBuilder::fStorageLevel

privateinherited

Definition at line 58 of file MinimumBuilder.h.

Referenced by ROOT::Minuit2::MinimumBuilder::SetStorageLevel(), and ROOT::Minuit2::MinimumBuilder::StorageLevel().

fTracer

MnTraceObject* ROOT::Minuit2::MinimumBuilder::fTracer

privateinherited

Definition at line 60 of file MinimumBuilder.h.

Referenced by ROOT::Minuit2::MinimumBuilder::SetTraceObject(), ROOT::Minuit2::MinimumBuilder::TraceIter(), ROOT::Minuit2::MinimumBuilder::TraceIteration(), and ROOT::Minuit2::MinimumBuilder::TraceObject().

---

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

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