ComPWA
Common Partial-Wave-Analysis Framework
Public Member Functions | Public Attributes | Private Member Functions | List of all members
ComPWA::Optimizer::Minuit2::MinuitIF Class Reference

Wrapper of the Minuit2 Optimizer library. More...

#include <MinuitIF.hpp>

Public Member Functions

 MinuitIF ()
 
MinuitResult optimize (ComPWA::Estimator::Estimator< double > &Estimator, ComPWA::FitParameterList InitialParameters)
 Finds the optimal value of the Estimator, by varying its parameters. More...
 
void setStrategy (std::string strategy)
 Minuit strategy (low, medium(default), high) See https://root.cern.ch/root/htmldoc/guides/minuit2/Minuit2.html#m-strategy Sets Minuit configuration variables to pre-defined values. More...
 
- Public Member Functions inherited from ComPWA::Optimizer::Optimizer< MinuitResult >
virtual ~Optimizer ()=default
 

Public Attributes

bool UseHesse = 1
 
bool UseMinos = 0
 
unsigned int GradientNCycles
 
double GradientStepTolerance
 
double GradientTolerance
 
unsigned int HessianNCycles
 
unsigned int HessianGradientNCycles
 
double HessianStepTolerance
 
double HessianG2Tolerance
 

Private Member Functions

std::string checkStrategy ()
 Check if a pre-defined strategy is set or if custom settings are used. More...
 

Detailed Description

Wrapper of the Minuit2 Optimizer library.

This class provides a wrapper around the Minuit2 library. It fulfills the Optimizer interface to be easily adapted to other modules. The data needs to be provided with the ControlParameter interface.

Definition at line 23 of file MinuitIF.hpp.

+ Inheritance diagram for ComPWA::Optimizer::Minuit2::MinuitIF:
+ Collaboration diagram for ComPWA::Optimizer::Minuit2::MinuitIF:

Constructor & Destructor Documentation

◆ MinuitIF()

ComPWA::Optimizer::Minuit2::MinuitIF::MinuitIF ( )
inline

Definition at line 25 of file MinuitIF.hpp.

Member Function Documentation

◆ checkStrategy()

std::string ComPWA::Optimizer::Minuit2::MinuitIF::checkStrategy ( )
private

Check if a pre-defined strategy is set or if custom settings are used.

Definition at line 103 of file MinuitIF.cpp.

◆ optimize()

MinuitResult ComPWA::Optimizer::Minuit2::MinuitIF::optimize ( ComPWA::Estimator::Estimator< double > &  Estimator,
ComPWA::FitParameterList  FitParameters 
)
virtual

Finds the optimal value of the Estimator, by varying its parameters.

Implements ComPWA::Optimizer::Optimizer< MinuitResult >.

Definition at line 139 of file MinuitIF.cpp.

◆ setStrategy()

void ComPWA::Optimizer::Minuit2::MinuitIF::setStrategy ( std::string  strategy)

Minuit strategy (low, medium(default), high) See https://root.cern.ch/root/htmldoc/guides/minuit2/Minuit2.html#m-strategy Sets Minuit configuration variables to pre-defined values.

Definition at line 82 of file MinuitIF.cpp.

Member Data Documentation

◆ GradientNCycles

unsigned int ComPWA::Optimizer::Minuit2::MinuitIF::GradientNCycles

Definition at line 39 of file MinuitIF.hpp.

◆ GradientStepTolerance

double ComPWA::Optimizer::Minuit2::MinuitIF::GradientStepTolerance

Definition at line 40 of file MinuitIF.hpp.

◆ GradientTolerance

double ComPWA::Optimizer::Minuit2::MinuitIF::GradientTolerance

Definition at line 41 of file MinuitIF.hpp.

◆ HessianG2Tolerance

double ComPWA::Optimizer::Minuit2::MinuitIF::HessianG2Tolerance

Definition at line 45 of file MinuitIF.hpp.

◆ HessianGradientNCycles

unsigned int ComPWA::Optimizer::Minuit2::MinuitIF::HessianGradientNCycles

Definition at line 43 of file MinuitIF.hpp.

◆ HessianNCycles

unsigned int ComPWA::Optimizer::Minuit2::MinuitIF::HessianNCycles

Definition at line 42 of file MinuitIF.hpp.

◆ HessianStepTolerance

double ComPWA::Optimizer::Minuit2::MinuitIF::HessianStepTolerance

Definition at line 44 of file MinuitIF.hpp.

◆ UseHesse

bool ComPWA::Optimizer::Minuit2::MinuitIF::UseHesse = 1

Definition at line 29 of file MinuitIF.hpp.

◆ UseMinos

bool ComPWA::Optimizer::Minuit2::MinuitIF::UseMinos = 0

Definition at line 30 of file MinuitIF.hpp.

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