ROOT::Minuit2::VariableMetricBuilder Class Reference

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

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

Public Types
enum	ErrorUpdatorType { kDavidon , kBFGS }

Public Member Functions
	VariableMetricBuilder (ErrorUpdatorType type=kDavidon)
void	AddResult (std::vector< MinimumState > &result, const MinimumState &state) const
const MinimumErrorUpdator &	ErrorUpdator () const
const VariableMetricEDMEstimator &	Estimator () const
FunctionMinimum	Minimum (const MnFcn &, const GradientCalculator &, const MinimumSeed &, const MnStrategy &, unsigned int, double) const override
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
	! tracer object (it is managed by user)

#include <Minuit2/VariableMetricBuilder.h>

Inheritance diagram for ROOT::Minuit2::VariableMetricBuilder:

Member Enumeration Documentation

ErrorUpdatorType

enum ROOT::Minuit2::VariableMetricBuilder::ErrorUpdatorType

Enumerator
kDavidon
kBFGS

Definition at line 37 of file VariableMetricBuilder.h.

Constructor & Destructor Documentation

VariableMetricBuilder()

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

inline

Definition at line 39 of file VariableMetricBuilder.h.

Member Function Documentation

AddResult()

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

Definition at line 34 of file VariableMetricBuilder.cxx.

ErrorUpdator()

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

inline

Definition at line 54 of file VariableMetricBuilder.h.

Estimator()

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

inline

Definition at line 53 of file VariableMetricBuilder.h.

Minimum() [1/2]

FunctionMinimum ROOT::Minuit2::VariableMetricBuilder::Minimum ( const MnFcn & fcn, const GradientCalculator & gc, const MinimumSeed & seed, const MnStrategy & strategy, unsigned int maxfcn, double edmval ) const

overridevirtual

Implements ROOT::Minuit2::MinimumBuilder.

Definition at line 51 of file VariableMetricBuilder.cxx.

Minimum() [2/2]

FunctionMinimum ROOT::Minuit2::VariableMetricBuilder::Minimum	(	const MnFcn &	fcn,
		const GradientCalculator &	gc,
		const MinimumSeed &	seed,
		std::vector< MinimumState > &	result,
		unsigned int	maxfcn,
		double	edmval ) const

Definition at line 204 of file VariableMetricBuilder.cxx.

PrintLevel()

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

inlineinherited

Definition at line 38 of file MinimumBuilder.h.

SetPrintLevel()

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

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 43 of file MinimumBuilder.h.

SetStorageLevel()

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

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 44 of file MinimumBuilder.h.

SetTraceObject()

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

inlinevirtualinherited

Reimplemented in ROOT::Minuit2::CombinedMinimumBuilder.

Definition at line 47 of file MinimumBuilder.h.

StorageLevel()

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

inlineinherited

Definition at line 37 of file MinimumBuilder.h.

TraceIter()

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

inlineinherited

Definition at line 40 of file MinimumBuilder.h.

TraceIteration()

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

inlineinherited

Definition at line 49 of file MinimumBuilder.h.

TraceObject()

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

inlineinherited

Definition at line 41 of file MinimumBuilder.h.

Member Data Documentation

fErrorUpdator

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

private

Definition at line 60 of file VariableMetricBuilder.h.

fEstimator

VariableMetricEDMEstimator ROOT::Minuit2::VariableMetricBuilder::fEstimator

private

Definition at line 59 of file VariableMetricBuilder.h.

fPrintLevel

int ROOT::Minuit2::MinimumBuilder::fPrintLevel

privateinherited

Definition at line 56 of file MinimumBuilder.h.

fStorageLevel

int ROOT::Minuit2::MinimumBuilder::fStorageLevel

privateinherited

Definition at line 57 of file MinimumBuilder.h.

fTracer

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

privateinherited

! tracer object (it is managed by user)

Definition at line 59 of file MinimumBuilder.h.

---

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

• math/minuit2/inc/Minuit2/VariableMetricBuilder.h
• math/minuit2/src/VariableMetricBuilder.cxx