Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::Minuit2::FumiliBuilder Class Reference
Math » Minuit2 Minimization Library

Builds the FunctionMinimum using the Fumili method.

Author
Andras Zsenei, Creation date: 29 Sep 2004
See also
MINUIT Tutorial on function minimization, section 5

Definition at line 41 of file FumiliBuilder.h.

Public Types

enum  FumiliMethodType { kLineSearch = 0 , kTrustRegion = 1 , kTrustRegionScaled = 2 }

Public Member Functions

const FumiliErrorUpdator & ErrorUpdator () const
 Accessor to the Error updator of the builder.
const VariableMetricEDMEstimator & Estimator () const
 Accessor to the EDM (expected vertical distance to the Minimum) estimator.
FunctionMinimum Minimum (const MnFcn &fMnFcn, const GradientCalculator &fGradienCalculator, const MinimumSeed &fMinimumSeed, const MnStrategy &fMnStrategy, unsigned int maxfcn, double edmval) const override
 Class the member function calculating the Minimum and verifies the result depending on the strategy.
FunctionMinimum Minimum (const MnFcn &fMnFcn, const GradientCalculator &fGradienCalculator, const MinimumSeed &fMinimumSeed, std::vector< MinimumState > &states, unsigned int maxfcn, double edmval) const
 Calculates the Minimum based on the Fumili method.
int PrintLevel () const
void SetMethod (FumiliMethodType type)
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

FumiliErrorUpdator fErrorUpdator
VariableMetricEDMEstimator fEstimator
FumiliMethodType fMethodType = kTrustRegion
int fPrintLevel
int fStorageLevel
MnTraceObject * fTracer
 ! tracer object (it is managed by user)

#include <Minuit2/FumiliBuilder.h>

Inheritance diagram for ROOT::Minuit2::FumiliBuilder:
ROOT::Minuit2::MinimumBuilder

Member Enumeration Documentation

◆ FumiliMethodType

enum ROOT::Minuit2::FumiliBuilder::FumiliMethodType
Enumerator
kLineSearch 
kTrustRegion 
kTrustRegionScaled 

Definition at line 45 of file FumiliBuilder.h.

Member Function Documentation

◆ ErrorUpdator()

const FumiliErrorUpdator & ROOT::Minuit2::FumiliBuilder::ErrorUpdator ( ) const
inline

Accessor to the Error updator of the builder.

Returns
The FumiliErrorUpdator used by the FumiliBuilder.

Definition at line 131 of file FumiliBuilder.h.

◆ Estimator()

const VariableMetricEDMEstimator & ROOT::Minuit2::FumiliBuilder::Estimator ( ) const
inline

Accessor to the EDM (expected vertical distance to the Minimum) estimator.

Returns
The EDM estimator used in the builder.

Definition at line 121 of file FumiliBuilder.h.

◆ Minimum() [1/2]

FunctionMinimum ROOT::Minuit2::FumiliBuilder::Minimum ( const MnFcn & fMnFcn,
const GradientCalculator & fGradienCalculator,
const MinimumSeed & fMinimumSeed,
const MnStrategy & fMnStrategy,
unsigned int maxfcn,
double edmval ) const
overridevirtual

Class the member function calculating the Minimum and verifies the result depending on the strategy.

Parameters
fMnFcnthe function to be minimized.
fGradienCalculatornot used in Fumili.
fMinimumSeedthe seed generator.
fMnStrategythe strategy describing the number of function calls allowed for Gradient calculations.
maxfcnmaximum number of function calls after which the calculation will be stopped even if it has not yet converged.
edmvalexpected vertical distance to the Minimum.
Returns
Returns the function Minimum found.

Implements ROOT::Minuit2::MinimumBuilder.

Definition at line 30 of file FumiliBuilder.cxx.

◆ Minimum() [2/2]

FunctionMinimum ROOT::Minuit2::FumiliBuilder::Minimum ( const MnFcn & fMnFcn,
const GradientCalculator & fGradienCalculator,
const MinimumSeed & fMinimumSeed,
std::vector< MinimumState > & states,
unsigned int maxfcn,
double edmval ) const

Calculates the Minimum based on the Fumili method.

Parameters
fMnFcnthe function to be minimized.
fGradienCalculatornot used in Fumili
fMinimumSeedthe seed generator.
statesvector containing the state result of each iteration
maxfcnmaximum number of function calls after which the calculation will be stopped even if it has not yet converged.
edmvalexpected vertical distance to the Minimum
Returns
Returns the function Minimum found.
See also
MINUIT Tutorial on function minimization, section 5

Definition at line 159 of file FumiliBuilder.cxx.

◆ PrintLevel()

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

Definition at line 38 of file MinimumBuilder.h.

◆ SetMethod()

void ROOT::Minuit2::FumiliBuilder::SetMethod ( FumiliMethodType type)
inline

Definition at line 47 of file FumiliBuilder.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

FumiliErrorUpdator ROOT::Minuit2::FumiliBuilder::fErrorUpdator
private

Definition at line 135 of file FumiliBuilder.h.

◆ fEstimator

VariableMetricEDMEstimator ROOT::Minuit2::FumiliBuilder::fEstimator
private

Definition at line 134 of file FumiliBuilder.h.

◆ fMethodType

FumiliMethodType ROOT::Minuit2::FumiliBuilder::fMethodType = kTrustRegion
private

Definition at line 136 of file FumiliBuilder.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: