GSLMultiMinimizer Class Reference

Description

Wrapper for the CERN ROOT facade of the GSL multi minimizer family (gradient descent based).

Definition at line 32 of file GSLMultiMinimizer.h.

Inheritance diagram for GSLMultiMinimizer:

Collaboration diagram for GSLMultiMinimizer:

Public Types
using	root_minimizer_t = ROOT::Math::Minimizer

Public Member Functions
	GSLMultiMinimizer (const std::string &algorithmName="ConjugateFR")
	~GSLMultiMinimizer () override
std::string	algorithmName () const override
	Returns name of the minimization algorithm. More...
virtual void	clear ()
	Clears resources (parameters) for consecutives minimizations. More...
int	maxIterations () const
mumufit::MinimizerResult	minimize_residual (fcn_residual_t fcn, mumufit::Parameters parameters) override
	Runs minimization. More...
mumufit::MinimizerResult	minimize_scalar (fcn_scalar_t fcn, mumufit::Parameters parameters) override
	Runs minimization. More...
std::string	minimizerName () const override
	Returns name of the minimizer. More...
double	minValue () const override
	Returns minimum function value. More...
MinimizerOptions &	options ()
const MinimizerOptions &	options () const
int	printLevel () 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	setMaxIterations (int value)
	Sets maximum number of iterations. This is an internal minimizer setting which has no direct relation to the number of objective function calls (e.g. numberOfIteraction=5 might correspond to ~100 objective function calls). More...
void	setOptions (const std::string &optionString) override
	Sets option string to the minimizer. More...
void	setParameters (const mumufit::Parameters &parameters)
void	setPrintLevel (int value)
	Sets minimizer internal print level. More...
virtual std::map< std::string, std::string >	statusMap () const
	Returns map of string representing different minimizer statuses. More...
std::string	statusToString () const override
	Returns string representation of current minimizer status. More...

Protected Member Functions
template<class T >
OptionContainer::option_t	addOption (const std::string &optionName, T value, const std::string &description="")
size_t	fitRank () 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...
void	propagateOptions () override
void	propagateResults (mumufit::Parameters &parameters)
	Propagates results of minimization to fit parameter set. More...
root_minimizer_t *	rootMinimizer ()
const root_minimizer_t *	rootMinimizer () const override
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
std::unique_ptr< ROOT::Math::GSLMinimizer >	m_gsl_minimizer
MinimizerInfo	m_minimizerInfo
MinimizerOptions	m_options
bool	m_status

Member Typedef Documentation

root_minimizer_t

using MinimizerAdapter::root_minimizer_t = ROOT::Math::Minimizer

inherited

Definition at line 47 of file MinimizerAdapter.h.

Constructor & Destructor Documentation

GSLMultiMinimizer()

GSLMultiMinimizer::GSLMultiMinimizer ( const std::string &  algorithmName = "ConjugateFR" )

explicit

Definition at line 31 of file GSLMultiMinimizer.cpp.

    : MinimizerAdapter(MinimizerInfo::buildGSLMultiMinInfo(algorithmName))
    , m_gsl_minimizer(new ROOT::Math::GSLMinimizer(algorithmName.c_str()))
{
    addOption("PrintLevel", 0, "Minimizer internal print level");
    addOption("MaxIterations", 0, "Maximum number of iterations");
}

References MinimizerAdapter::addOption().

Here is the call graph for this function:

~GSLMultiMinimizer()

GSLMultiMinimizer::~GSLMultiMinimizer ( )

overridedefault

Member Function Documentation

addOption()

template<class T >

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

protectedinherited

Definition at line 115 of file MinimizerAdapter.h.

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

References OptionContainer::addOption(), and MinimizerAdapter::m_options.

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

Here is the call graph for this function:

algorithmName()

std::string MinimizerAdapter::algorithmName ( ) const

overridevirtualinherited

Returns name of the minimization algorithm.

Implements IMinimizer.

Definition at line 73 of file MinimizerAdapter.cpp.

{
    return m_minimizerInfo.algorithmName();
}

References MinimizerInfo::algorithmName(), and MinimizerAdapter::m_minimizerInfo.

Referenced by Minuit2Minimizer::requiresResiduals().

Here is the call graph for this function:

clear()

virtual void IMinimizer::clear ( )

inlinevirtualinherited

Clears resources (parameters) for consecutives minimizations.

Definition at line 50 of file IMinimizer.h.

{}

fitRank()

size_t MinimizerAdapter::fitRank ( ) const

protectedinherited

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

Definition at line 180 of file MinimizerAdapter.cpp.

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

References ROOT::Math::Minimizer::NDim(), and MinimizerAdapter::rootMinimizer().

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

Here is the call graph for this function:

maxIterations()

int GSLMultiMinimizer::maxIterations

(

)

const

Definition at line 56 of file GSLMultiMinimizer.cpp.

{
    return optionValue<int>("MaxIterations");
}

Referenced by propagateOptions().

minimize()

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

protectedinherited

Definition at line 50 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 MinimizerAdapter::m_adapter, MinimizerAdapter::m_status, ROOT::Math::Minimizer::Minimize(), MinimizerAdapter::minValue(), MinimizerAdapter::propagateOptions(), MinimizerAdapter::propagateResults(), mumufit::internal::reportToString(), MinimizerAdapter::rootMinimizer(), mumufit::MinimizerResult::setMinValue(), mumufit::MinimizerResult::setNumberOfCalls(), mumufit::MinimizerResult::setNumberOfGradientCalls(), MinimizerAdapter::setParameters(), mumufit::MinimizerResult::setParameters(), and mumufit::MinimizerResult::setReport().

Referenced by MinimizerAdapter::minimize_residual(), and MinimizerAdapter::minimize_scalar().

Here is the call graph for this function:

minimize_residual()

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

overridevirtualinherited

Runs minimization.

Reimplemented from IMinimizer.

Definition at line 43 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 MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), MinimizerAdapter::rootMinimizer(), and ROOT::Math::Minimizer::SetFunction().

Here is the call graph for this function:

minimize_scalar()

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

overridevirtualinherited

Runs minimization.

Reimplemented from IMinimizer.

Definition at line 36 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 MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), MinimizerAdapter::rootMinimizer(), and ROOT::Math::Minimizer::SetFunction().

Here is the call graph for this function:

minimizerName()

std::string MinimizerAdapter::minimizerName ( ) const

overridevirtualinherited

Returns name of the minimizer.

Implements IMinimizer.

Definition at line 68 of file MinimizerAdapter.cpp.

{
    return m_minimizerInfo.name();
}

References MinimizerAdapter::m_minimizerInfo, and MinimizerInfo::name().

Here is the call graph for this function:

minValue()

double MinimizerAdapter::minValue ( ) const

overridevirtualinherited

Returns minimum function value.

Reimplemented from IMinimizer.

Definition at line 85 of file MinimizerAdapter.cpp.

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

References ROOT::Math::Minimizer::MinValue(), and MinimizerAdapter::rootMinimizer().

Referenced by MinimizerAdapter::minimize(), and MinimizerAdapter::statusMap().

Here is the call graph for this function:

options() [1/2]

MinimizerOptions& MinimizerAdapter::options ( )

inlineinherited

Definition at line 66 of file MinimizerAdapter.h.

{ return m_options; }

References MinimizerAdapter::m_options.

Referenced by MinimizerAdapter::setOptions().

options() [2/2]

const MinimizerOptions& MinimizerAdapter::options ( ) const

inlineinherited

Definition at line 67 of file MinimizerAdapter.h.

{ return m_options; }

References MinimizerAdapter::m_options.

optionValue()

template<class T >

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

protectedinherited

Definition at line 128 of file MinimizerAdapter.h.

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

References MinimizerAdapter::m_options, and OptionContainer::optionValue().

Here is the call graph for this function:

parErrorsAtMinimum()

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

protectedinherited

Returns errors of the variables at minimum.

Definition at line 197 of file MinimizerAdapter.cpp.

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

References MinimizerAdapter::fitRank(), and MinimizerAdapter::rootMinimizer().

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

parValuesAtMinimum()

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

protectedinherited

Returns value of the variables at minimum.

Definition at line 187 of file MinimizerAdapter.cpp.

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

References MinimizerAdapter::fitRank(), and MinimizerAdapter::rootMinimizer().

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

printLevel()

int GSLMultiMinimizer::printLevel

(

)

const

Definition at line 46 of file GSLMultiMinimizer.cpp.

{
    return optionValue<int>("PrintLevel");
}

Referenced by propagateOptions().

propagateOptions()

void GSLMultiMinimizer::propagateOptions ( )

overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 66 of file GSLMultiMinimizer.cpp.

{
    m_gsl_minimizer->SetPrintLevel(printLevel());
    m_gsl_minimizer->SetMaxIterations(static_cast<unsigned int>(maxIterations()));
}

References m_gsl_minimizer, maxIterations(), and printLevel().

Here is the call graph for this function:

propagateResults()

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

protectedinherited

Propagates results of minimization to fit parameter set.

Definition at line 122 of file MinimizerAdapter.cpp.

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

References ROOT::Math::Minimizer::Correlation(), MinimizerAdapter::fitRank(), MinimizerAdapter::parErrorsAtMinimum(), MinimizerAdapter::parValuesAtMinimum(), MinimizerAdapter::providesError(), MinimizerAdapter::rootMinimizer(), mumufit::Parameters::setCorrelationMatrix(), mumufit::Parameters::setErrors(), and mumufit::Parameters::setValues().

Referenced by MinimizerAdapter::minimize().

Here is the call graph for this function:

providesError()

bool MinimizerAdapter::providesError ( ) const

inherited

Returns true if minimizer provides error and error matrix.

Definition at line 95 of file MinimizerAdapter.cpp.

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

References ROOT::Math::Minimizer::ProvidesError(), and MinimizerAdapter::rootMinimizer().

Referenced by MinimizerAdapter::propagateResults(), and MinimizerAdapter::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 60 of file IMinimizer.h.

{ return false; }

rootMinimizer() [1/2]

MinimizerAdapter::root_minimizer_t * MinimizerAdapter::rootMinimizer ( )

protectedinherited

Definition at line 207 of file MinimizerAdapter.cpp.

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

References MinimizerAdapter::rootMinimizer().

Here is the call graph for this function:

rootMinimizer() [2/2]

const MinimizerAdapter::root_minimizer_t * GSLMultiMinimizer::rootMinimizer ( ) const

overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 72 of file GSLMultiMinimizer.cpp.

{
    return m_gsl_minimizer.get();
}

References m_gsl_minimizer.

Referenced by statusToString().

setMaxIterations()

void GSLMultiMinimizer::setMaxIterations

(

int

value

)

Sets maximum number of iterations. This is an internal minimizer setting which has no direct relation to the number of objective function calls (e.g. numberOfIteraction=5 might correspond to ~100 objective function calls).

Definition at line 51 of file GSLMultiMinimizer.cpp.

{
    setOptionValue("MaxIterations", value);
}

References MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

setOptions()

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

overridevirtualinherited

Sets option string to the minimizer.

Reimplemented from IMinimizer.

Definition at line 115 of file MinimizerAdapter.cpp.

{
    options().setOptionString(optionString);
}

References MinimizerAdapter::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  )

protectedinherited

Definition at line 122 of file MinimizerAdapter.h.

{
    m_options.setOptionValue(optionName, value);
}

References MinimizerAdapter::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(), setMaxIterations(), SimAnMinimizer::setMaxIterations(), GeneticMinimizer::setPopulationSize(), Minuit2Minimizer::setPrecision(), GeneticMinimizer::setPrintLevel(), GSLLevenbergMarquardtMinimizer::setPrintLevel(), 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  )

protectedvirtualinherited

Reimplemented in GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Definition at line 141 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(), MinimizerAdapter::rootMinimizer(), ROOT::Math::Minimizer::SetFixedVariable(), ROOT::Math::Minimizer::SetLimitedVariable(), ROOT::Math::Minimizer::SetLowerLimitedVariable(), ROOT::Math::Minimizer::SetUpperLimitedVariable(), ROOT::Math::Minimizer::SetVariable(), mumufit::Parameter::step(), AttLimits::upperLimit(), and mumufit::Parameter::value().

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

Here is the call graph for this function:

setParameters()

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

inherited

Definition at line 78 of file MinimizerAdapter.cpp.

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

References MinimizerAdapter::setParameter().

Referenced by MinimizerAdapter::minimize().

Here is the call graph for this function:

setPrintLevel()

void GSLMultiMinimizer::setPrintLevel

(

int

value

)

Sets minimizer internal print level.

Definition at line 41 of file GSLMultiMinimizer.cpp.

{
    setOptionValue("PrintLevel", value);
}

References MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

statusMap()

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

virtualinherited

Returns map of string representing different minimizer statuses.

Reimplemented in SimAnMinimizer, Minuit2Minimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.

Definition at line 100 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 MinimizerAdapter::minValue(), MinimizerAdapter::providesError(), mumufit::stringUtils::scientific(), and MinimizerAdapter::statusToString().

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

Here is the call graph for this function:

statusToString()

std::string GSLMultiMinimizer::statusToString ( ) const

overridevirtual

Returns string representation of current minimizer status.

Reimplemented from MinimizerAdapter.

Definition at line 61 of file GSLMultiMinimizer.cpp.

{
    return mumufit::utils::gslErrorDescription(rootMinimizer()->Status());
}

References mumufit::utils::gslErrorDescription(), and rootMinimizer().

Here is the call graph for this function:

Member Data Documentation

m_adapter

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

privateinherited

Definition at line 110 of file MinimizerAdapter.h.

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

m_gsl_minimizer

std::unique_ptr<ROOT::Math::GSLMinimizer> GSLMultiMinimizer::m_gsl_minimizer

private

Definition at line 54 of file GSLMultiMinimizer.h.

Referenced by propagateOptions(), and rootMinimizer().

m_minimizerInfo

MinimizerInfo MinimizerAdapter::m_minimizerInfo

privateinherited

Definition at line 109 of file MinimizerAdapter.h.

Referenced by MinimizerAdapter::algorithmName(), and MinimizerAdapter::minimizerName().

m_options

MinimizerOptions MinimizerAdapter::m_options

privateinherited

Definition at line 108 of file MinimizerAdapter.h.

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

m_status

bool MinimizerAdapter::m_status

privateinherited

Definition at line 111 of file MinimizerAdapter.h.

Referenced by MinimizerAdapter::minimize(), and MinimizerAdapter::statusToString().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Adapter/GSLMultiMinimizer.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Adapter/GSLMultiMinimizer.cpp