Abstract base class that adapts the CERN ROOT minimizer to our IMinimizer. More...

Inheritance diagram for MinimizerAdapter:

Collaboration diagram for MinimizerAdapter:

Public Types
typedef ROOT::Math::Minimizer	root_minimizer_t

Public Member Functions
virtual	~MinimizerAdapter () override

std::string	algorithmName () const final
	Returns name of the minimization algorithm. More...

virtual void	clear ()
	clear resources (parameters) for consecutives minimizations More...

mumufit::MinimizerResult	minimize_residual (fcn_residual_t fcn, mumufit::Parameters parameters) override

mumufit::MinimizerResult	minimize_scalar (fcn_scalar_t fcn, mumufit::Parameters parameters) override
	run minimization More...

std::string	minimizerName () const final
	Returns name of the minimizer. More...

double	minValue () const final
	Returns minimum function value. More...

MinimizerOptions &	options ()

const MinimizerOptions &	options () const

bool	providesError () const
	Returns true if minimizer provides error and error matrix. More...

virtual bool	requiresResiduals ()
	Returns true if minimizer computations are residual-based, false otherwise. More...

void	setOptions (const std::string &optionString) final
	Sets option string to the minimizer. More...

void	setParameters (const mumufit::Parameters &parameters)

virtual std::map< std::string, std::string >	statusMap () const
	Returns map of string representing different minimizer statuses. More...

virtual std::string	statusToString () const
	Returns string representation of current minimizer status. More...

Protected Member Functions
	MinimizerAdapter (const MinimizerInfo &minimizerInfo)

template<class T >
OptionContainer::option_t	addOption (const std::string &optionName, T value, const std::string &description="")

size_t	fitDimension () const
	Returns number of fit parameters defined (i.e. dimension of the function to be minimized). More...

mumufit::MinimizerResult	minimize (mumufit::Parameters parameters)

template<class T >
T	optionValue (const std::string &optionName) const

std::vector< double >	parErrorsAtMinimum () const
	Returns errors of the variables at minimum. More...

std::vector< double >	parValuesAtMinimum () const
	Returns value of the variables at minimum. More...

virtual void	propagateOptions ()=0

void	propagateResults (mumufit::Parameters &parameters)
	Propagates results of minimization to fit parameter set. More...

root_minimizer_t *	rootMinimizer ()

virtual const root_minimizer_t *	rootMinimizer () const =0

template<class T >
void	setOptionValue (const std::string &optionName, T value)

virtual void	setParameter (unsigned int index, const mumufit::Parameter &par)

Private Attributes
std::unique_ptr< mumufit::ObjectiveFunctionAdapter >	m_adapter

MinimizerInfo	m_minimizerInfo

MinimizerOptions	m_options

bool	m_status

Detailed Description

Abstract base class that adapts the CERN ROOT minimizer to our IMinimizer.

Definition at line 43 of file MinimizerAdapter.h.

Member Typedef Documentation

◆ root_minimizer_t

typedef ROOT::Math::Minimizer MinimizerAdapter::root_minimizer_t

Definition at line 45 of file MinimizerAdapter.h.

Constructor & Destructor Documentation

◆ ~MinimizerAdapter()

MinimizerAdapter::~MinimizerAdapter ( )

overridevirtualdefault

◆ MinimizerAdapter()

MinimizerAdapter::MinimizerAdapter ( const MinimizerInfo & minimizerInfo )

protected

Definition at line 25 of file MinimizerAdapter.cpp.

     : m_minimizerInfo(minimizerInfo)
     , m_adapter(new mumufit::ObjectiveFunctionAdapter)
     , m_status(false)
 {
 }

Member Function Documentation

◆ addOption()

template<class T >

OptionContainer::option_t MinimizerAdapter::addOption	(	const std::string &	optionName,
		T	value,
		const std::string &	description = `""`
	)

protected

Definition at line 111 of file MinimizerAdapter.h.

 {
     return m_options.addOption(optionName, value, description);
 }

References OptionContainer::addOption(), and m_options.

Referenced by GeneticMinimizer::GeneticMinimizer(), GSLLevenbergMarquardtMinimizer::GSLLevenbergMarquardtMinimizer(), GSLMultiMinimizer::GSLMultiMinimizer(), Minuit2Minimizer::Minuit2Minimizer(), and SimAnMinimizer::SimAnMinimizer().

Here is the call graph for this function:

◆ algorithmName()

std::string MinimizerAdapter::algorithmName ( ) const

finalvirtual

Returns name of the minimization algorithm.

Implements IMinimizer.

Definition at line 71 of file MinimizerAdapter.cpp.

 {
     return m_minimizerInfo.algorithmName();
 }

References MinimizerInfo::algorithmName(), and m_minimizerInfo.

Referenced by Minuit2Minimizer::requiresResiduals().

Here is the call graph for this function:

◆ clear()

virtual void IMinimizer::clear ( )

inlinevirtualinherited

clear resources (parameters) for consecutives minimizations

Definition at line 49 of file IMinimizer.h.

49 {}

◆ fitDimension()

size_t MinimizerAdapter::fitDimension ( ) const

protected

Returns number of fit parameters defined (i.e. dimension of the function to be minimized).

Definition at line 181 of file MinimizerAdapter.cpp.

 {
     return rootMinimizer()->NDim();
 }

References rootMinimizer().

Referenced by parErrorsAtMinimum(), parValuesAtMinimum(), and propagateResults().

Here is the call graph for this function:

◆ minimize()

MinimizerResult MinimizerAdapter::minimize ( mumufit::Parameters parameters )

protected

Definition at line 48 of file MinimizerAdapter.cpp.

 {
     setParameters(parameters);
     propagateOptions();
  
     m_status = rootMinimizer()->Minimize();
     propagateResults(parameters);
  
     MinimizerResult result;
     result.setParameters(parameters);
     result.setMinValue(minValue());
     result.setReport(internal::reportToString(*this));
     result.setNumberOfCalls(m_adapter->numberOfCalls());
     result.setNumberOfGradientCalls(m_adapter->numberOfGradientCalls());
  
     return result;
 }

References m_adapter, m_status, minValue(), propagateOptions(), propagateResults(), mumufit::internal::reportToString(), rootMinimizer(), mumufit::MinimizerResult::setMinValue(), mumufit::MinimizerResult::setNumberOfCalls(), mumufit::MinimizerResult::setNumberOfGradientCalls(), setParameters(), mumufit::MinimizerResult::setParameters(), and mumufit::MinimizerResult::setReport().

Referenced by minimize_residual(), and minimize_scalar().

Here is the call graph for this function:

◆ minimize_residual()

MinimizerResult MinimizerAdapter::minimize_residual	(	fcn_residual_t	fcn,
		mumufit::Parameters	parameters
	)

overridevirtual

Reimplemented from IMinimizer.

Definition at line 41 of file MinimizerAdapter.cpp.

 {
     // Genetic minimizer requires SetFunction before setParameters, others don't care
     rootMinimizer()->SetFunction(*m_adapter->rootResidualFunction(fcn, parameters));
     return minimize(parameters);
 }

References m_adapter, minimize(), and rootMinimizer().

Here is the call graph for this function:

◆ minimize_scalar()

MinimizerResult MinimizerAdapter::minimize_scalar	(	fcn_scalar_t	,
		mumufit::Parameters
	)

overridevirtual

run minimization

Reimplemented from IMinimizer.

Definition at line 34 of file MinimizerAdapter.cpp.

 {
     // Genetic minimizer requires SetFunction before setParameters, others don't care
     rootMinimizer()->SetFunction(*m_adapter->rootObjectiveFunction(fcn, parameters));
     return minimize(parameters);
 }

References m_adapter, minimize(), and rootMinimizer().

Here is the call graph for this function:

◆ minimizerName()

std::string MinimizerAdapter::minimizerName ( ) const

finalvirtual

Returns name of the minimizer.

Implements IMinimizer.

Definition at line 66 of file MinimizerAdapter.cpp.

 {
     return m_minimizerInfo.name();
 }

References m_minimizerInfo, and MinimizerInfo::name().

Here is the call graph for this function:

◆ minValue()

double MinimizerAdapter::minValue ( ) const

finalvirtual

Returns minimum function value.

Reimplemented from IMinimizer.

Definition at line 83 of file MinimizerAdapter.cpp.

 {
     return rootMinimizer()->MinValue();
 }

References rootMinimizer().

Referenced by minimize(), and statusMap().

Here is the call graph for this function:

◆ options() [1/2]

MinimizerOptions& MinimizerAdapter::options ( )

inline

Definition at line 64 of file MinimizerAdapter.h.

64 { return m_options; }

References m_options.

Referenced by setOptions().

◆ options() [2/2]

const MinimizerOptions& MinimizerAdapter::options ( ) const

inline

Definition at line 65 of file MinimizerAdapter.h.

65 { return m_options; }

References m_options.

◆ optionValue()

template<class T >

T MinimizerAdapter::optionValue ( const std::string & optionName ) const

protected

Definition at line 122 of file MinimizerAdapter.h.

 {
     return m_options.optionValue<T>(optionName);
 }

References m_options, and OptionContainer::optionValue().

Here is the call graph for this function:

◆ parErrorsAtMinimum()

std::vector< double > MinimizerAdapter::parErrorsAtMinimum ( ) const

protected

Returns errors of the variables at minimum.

Definition at line 198 of file MinimizerAdapter.cpp.

 {
     std::vector<double> result;
     result.resize(fitDimension(), 0.0);
     if (rootMinimizer()->Errors() != 0) {
         std::copy(rootMinimizer()->Errors(), rootMinimizer()->Errors() + fitDimension(),
                   result.begin());
     }
     return result;
 }

References fitDimension(), and rootMinimizer().

Referenced by propagateResults().

Here is the call graph for this function:

◆ parValuesAtMinimum()

std::vector< double > MinimizerAdapter::parValuesAtMinimum ( ) const

protected

Returns value of the variables at minimum.

Definition at line 188 of file MinimizerAdapter.cpp.

 {
     std::vector<double> result;
     result.resize(fitDimension(), 0.0);
     std::copy(rootMinimizer()->X(), rootMinimizer()->X() + fitDimension(), result.begin());
     return result;
 }

References fitDimension(), and rootMinimizer().

Referenced by propagateResults().

Here is the call graph for this function:

◆ propagateOptions()

virtual void MinimizerAdapter::propagateOptions ( )

protectedpure virtual

Implemented in SimAnMinimizer, Minuit2Minimizer, GSLMultiMinimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Referenced by minimize().

◆ propagateResults()

void MinimizerAdapter::propagateResults ( mumufit::Parameters & parameters )

protected

Propagates results of minimization to fit parameter set.

Definition at line 120 of file MinimizerAdapter.cpp.

 {
     parameters.setValues(parValuesAtMinimum());
     parameters.setErrors(parErrorsAtMinimum());
     // sets correlation matrix
     if (providesError()) {
         mumufit::Parameters::corr_matrix_t matrix;
         matrix.resize(fitDimension());
  
         for (size_t i = 0; i < fitDimension(); ++i) {
             matrix[i].resize(fitDimension(), 0.0);
             for (size_t j = 0; j < fitDimension(); ++j)
                 matrix[i][j] = rootMinimizer()->Correlation(static_cast<unsigned int>(i),
                                                             static_cast<unsigned int>(j));
         }
         parameters.setCorrelationMatrix(matrix);
     }
 }

References fitDimension(), parErrorsAtMinimum(), parValuesAtMinimum(), providesError(), rootMinimizer(), mumufit::Parameters::setCorrelationMatrix(), mumufit::Parameters::setErrors(), and mumufit::Parameters::setValues().

Referenced by minimize().

Here is the call graph for this function:

◆ providesError()

bool MinimizerAdapter::providesError ( ) const

Returns true if minimizer provides error and error matrix.

Definition at line 93 of file MinimizerAdapter.cpp.

 {
     return rootMinimizer()->ProvidesError();
 }

References rootMinimizer().

Referenced by propagateResults(), and statusMap().

Here is the call graph for this function:

◆ requiresResiduals()

virtual bool IMinimizer::requiresResiduals ( )

inlinevirtualinherited

Returns true if minimizer computations are residual-based, false otherwise.

Reimplemented in Minuit2Minimizer, and GSLLevenbergMarquardtMinimizer.

Definition at line 59 of file IMinimizer.h.

59 { return false; }

◆ rootMinimizer() [1/2]

MinimizerAdapter::root_minimizer_t * MinimizerAdapter::rootMinimizer ( )

protected

Definition at line 209 of file MinimizerAdapter.cpp.

 {
     return const_cast<root_minimizer_t*>(
         static_cast<const MinimizerAdapter*>(this)->rootMinimizer());
 }

References rootMinimizer().

Here is the call graph for this function:

◆ rootMinimizer() [2/2]

virtual const root_minimizer_t* MinimizerAdapter::rootMinimizer ( ) const

protectedpure virtual

Implemented in SimAnMinimizer, Minuit2Minimizer, GSLMultiMinimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Referenced by fitDimension(), minimize(), minimize_residual(), minimize_scalar(), minValue(), parErrorsAtMinimum(), parValuesAtMinimum(), propagateResults(), providesError(), rootMinimizer(), and setParameter().

◆ setOptions()

void MinimizerAdapter::setOptions ( const std::string & optionString )

finalvirtual

Sets option string to the minimizer.

Reimplemented from IMinimizer.

Definition at line 113 of file MinimizerAdapter.cpp.

 {
     options().setOptionString(optionString);
 }

References options(), and MinimizerOptions::setOptionString().

Here is the call graph for this function:

◆ setOptionValue()

template<class T >

void MinimizerAdapter::setOptionValue	(	const std::string &	optionName,
		T	value
	)

protected

Definition at line 117 of file MinimizerAdapter.h.

 {
     m_options.setOptionValue(optionName, value);
 }

References m_options, and OptionContainer::setOptionValue().

Referenced by SimAnMinimizer::setBoltzmannInitialTemp(), SimAnMinimizer::setBoltzmannK(), SimAnMinimizer::setBoltzmannMinTemp(), SimAnMinimizer::setBoltzmannMu(), Minuit2Minimizer::setErrorDefinition(), SimAnMinimizer::setIterationsAtEachTemp(), Minuit2Minimizer::setMaxFunctionCalls(), GeneticMinimizer::setMaxIterations(), GSLLevenbergMarquardtMinimizer::setMaxIterations(), GSLMultiMinimizer::setMaxIterations(), SimAnMinimizer::setMaxIterations(), GeneticMinimizer::setPopulationSize(), Minuit2Minimizer::setPrecision(), GeneticMinimizer::setPrintLevel(), GSLLevenbergMarquardtMinimizer::setPrintLevel(), GSLMultiMinimizer::setPrintLevel(), Minuit2Minimizer::setPrintLevel(), SimAnMinimizer::setPrintLevel(), GeneticMinimizer::setRandomSeed(), SimAnMinimizer::setStepSize(), Minuit2Minimizer::setStrategy(), GeneticMinimizer::setTolerance(), GSLLevenbergMarquardtMinimizer::setTolerance(), and Minuit2Minimizer::setTolerance().

Here is the call graph for this function:

◆ setParameter()

void MinimizerAdapter::setParameter	(	unsigned int	index,
		const mumufit::Parameter &	par
	)

protectedvirtual

Reimplemented in GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Definition at line 139 of file MinimizerAdapter.cpp.

 {
     bool success;
     if (par.limits().isFixed()) {
         success = rootMinimizer()->SetFixedVariable(index, par.name().c_str(), par.value());
  
     }
  
     else if (par.limits().isLimited()) {
         success = rootMinimizer()->SetLimitedVariable(index, par.name().c_str(), par.value(),
                                                       par.step(), par.limits().lowerLimit(),
                                                       par.limits().upperLimit());
     }
  
     else if (par.limits().isLowerLimited()) {
         success = rootMinimizer()->SetLowerLimitedVariable(index, par.name().c_str(), par.value(),
                                                            par.step(), par.limits().lowerLimit());
     }
  
     else if (par.limits().isUpperLimited()) {
         success = rootMinimizer()->SetUpperLimitedVariable(index, par.name().c_str(), par.value(),
                                                            par.step(), par.limits().upperLimit());
     }
  
     else if (par.limits().isLimitless()) {
         success = rootMinimizer()->SetVariable(index, par.name().c_str(), par.value(), par.step());
     }
  
     else {
         throw std::runtime_error("BasicMinimizer::setParameter() -> Error! Unexpected parameter.");
     }
  
     if (!success) {
         std::ostringstream ostr;
         ostr << "BasicMinimizer::setParameter() -> Error! Can't set minimizer's fit parameter";
         ostr << "Index:" << index << " name '" << par.name() << "'";
         throw std::runtime_error(ostr.str());
     }
 }

References AttLimits::isFixed(), AttLimits::isLimited(), AttLimits::isLimitless(), AttLimits::isLowerLimited(), AttLimits::isUpperLimited(), mumufit::Parameter::limits(), AttLimits::lowerLimit(), mumufit::Parameter::name(), rootMinimizer(), mumufit::Parameter::step(), AttLimits::upperLimit(), and mumufit::Parameter::value().

Referenced by GeneticMinimizer::setParameter(), GSLLevenbergMarquardtMinimizer::setParameter(), and setParameters().

Here is the call graph for this function:

◆ setParameters()

void MinimizerAdapter::setParameters ( const mumufit::Parameters & parameters )

Definition at line 76 of file MinimizerAdapter.cpp.

 {
     unsigned int index(0);
     for (const auto& par : parameters)
         setParameter(index++, par);
 }

References setParameter().

Referenced by minimize().

Here is the call graph for this function:

◆ statusMap()

std::map< std::string, std::string > MinimizerAdapter::statusMap ( ) const

virtual

Returns map of string representing different minimizer statuses.

Reimplemented in SimAnMinimizer, Minuit2Minimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Definition at line 98 of file MinimizerAdapter.cpp.

 {
     std::map<std::string, std::string> result;
     result["Status"] = statusToString();
  
     if (providesError())
         result["ProvidesError"] = "Provides parameters error and error matrix";
     else
         result["ProvidesError"] = "Doesn't provide error calculation";
  
     result["MinValue"] = mumufit::stringUtils::scientific(minValue());
  
     return result;
 }

References minValue(), providesError(), mumufit::stringUtils::scientific(), and statusToString().

Referenced by GeneticMinimizer::statusMap(), GSLLevenbergMarquardtMinimizer::statusMap(), Minuit2Minimizer::statusMap(), and SimAnMinimizer::statusMap().

Here is the call graph for this function:

◆ statusToString()

std::string MinimizerAdapter::statusToString ( ) const

virtual

Returns string representation of current minimizer status.

Reimplemented in Minuit2Minimizer, GSLMultiMinimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Definition at line 88 of file MinimizerAdapter.cpp.

 {
     return m_status ? "Minimum found" : "Error in solving";
 }

References m_status.

Referenced by statusMap().

Member Data Documentation

◆ m_adapter

std::unique_ptr<mumufit::ObjectiveFunctionAdapter> MinimizerAdapter::m_adapter

private

Definition at line 106 of file MinimizerAdapter.h.

Referenced by minimize(), minimize_residual(), and minimize_scalar().

◆ m_minimizerInfo

MinimizerInfo MinimizerAdapter::m_minimizerInfo

private

Definition at line 105 of file MinimizerAdapter.h.

Referenced by algorithmName(), and minimizerName().

◆ m_options

MinimizerOptions MinimizerAdapter::m_options

private

Definition at line 104 of file MinimizerAdapter.h.

Referenced by addOption(), options(), optionValue(), and setOptionValue().

◆ m_status

bool MinimizerAdapter::m_status

private

Definition at line 107 of file MinimizerAdapter.h.

Referenced by minimize(), and statusToString().

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

/home/www/ba/Fit/Adapter/MinimizerAdapter.h
/home/www/ba/Fit/Adapter/MinimizerAdapter.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ root_minimizer_t

Constructor & Destructor Documentation

◆ ~MinimizerAdapter()

◆ MinimizerAdapter()

Member Function Documentation

◆ addOption()

◆ algorithmName()

◆ clear()

◆ fitDimension()

◆ minimize()

◆ minimize_residual()

◆ minimize_scalar()

◆ minimizerName()

◆ minValue()

◆ options() [1/2]

◆ options() [2/2]

◆ optionValue()

◆ parErrorsAtMinimum()

◆ parValuesAtMinimum()

◆ propagateOptions()

◆ propagateResults()

◆ providesError()

◆ requiresResiduals()

◆ rootMinimizer() [1/2]

◆ rootMinimizer() [2/2]

◆ setOptions()

◆ setOptionValue()

◆ setParameter()

◆ setParameters()

◆ statusMap()

◆ statusToString()

Member Data Documentation

◆ m_adapter

◆ m_minimizerInfo

◆ m_options

◆ m_status