Wrapper for the CERN ROOT facade of the GSL simmulated annealing minimizer. More...

Inheritance diagram for SimAnMinimizer:

Collaboration diagram for SimAnMinimizer:

Public Types
typedef ROOT::Math::Minimizer	root_minimizer_t

Public Member Functions
	SimAnMinimizer ()

	~SimAnMinimizer () override

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

double	boltzmannInitialTemp () const

double	boltzmannK () const

double	boltzmannMinTemp () const

double	boltzmannMu () const

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

int	iterationsAtEachTemp () const

int	maxIterations () const

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

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	setBoltzmannInitialTemp (double value)
	Sets Boltzmann distribution parameter: initial temperature. More...

void	setBoltzmannK (double value)
	Sets Boltzmann distribution parameter: k. More...

void	setBoltzmannMinTemp (double value)
	Sets Boltzmann distribution parameter: minimal temperature. More...

void	setBoltzmannMu (double value)
	Sets Boltzmann distribution parameter: mu. More...

void	setIterationsAtEachTemp (int value)
	Sets number of iterations at each temperature. More...

void	setMaxIterations (int value)
	Sets maximum number of iterations to try at each step. More...

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

void	setParameters (const mumufit::Parameters &parameters)

void	setPrintLevel (int value)
	Sets minimizer internal print level. More...

void	setStepSize (double value)
	Sets max step size used in random walk. More...

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

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

double	stepSize () const

Protected Member Functions
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...

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

MinimizerInfo	m_minimizerInfo

MinimizerOptions	m_options

std::unique_ptr< ROOT::Math::GSLSimAnMinimizer >	m_siman_minimizer

bool	m_status

Detailed Description

Wrapper for the CERN ROOT facade of the GSL simmulated annealing minimizer.

Definition at line 32 of file SimAnMinimizer.h.

Member Typedef Documentation

◆ root_minimizer_t

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

inherited

Definition at line 45 of file MinimizerAdapter.h.

Constructor & Destructor Documentation

◆ SimAnMinimizer()

SimAnMinimizer::SimAnMinimizer ( )

Definition at line 30 of file SimAnMinimizer.cpp.

     : MinimizerAdapter(MinimizerInfo::buildGSLSimAnInfo())
     , m_siman_minimizer(new ROOT::Math::GSLSimAnMinimizer())
 {
     addOption("PrintLevel", 0, "Minimizer internal print level");
     addOption("MaxIterations", 100, "Number of points to try for each step");
     addOption("IterationsAtTemp", 10, "Number of iterations at each temperature");
     addOption("StepSize", 1.0, "Max step size used in random walk");
     addOption("k", 1.0, "Boltzmann k");
     addOption("t_init", 50.0, "Boltzmann initial temperature");
     addOption("mu", 1.05, "Boltzmann mu");
     addOption("t_min", 0.1, "Boltzmann minimal temperature");
 }

References MinimizerAdapter::addOption().

Here is the call graph for this function:

◆ ~SimAnMinimizer()

SimAnMinimizer::~SimAnMinimizer ( )

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 111 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::GSLMultiMinimizer(), Minuit2Minimizer::Minuit2Minimizer(), and SimAnMinimizer().

Here is the call graph for this function:

◆ algorithmName()

std::string MinimizerAdapter::algorithmName ( ) const

finalvirtualinherited

Returns name of the minimization algorithm.

Implements IMinimizer.

Definition at line 71 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:

◆ boltzmannInitialTemp()

double SimAnMinimizer::boltzmannInitialTemp ( ) const

Definition at line 101 of file SimAnMinimizer.cpp.

 {
     return optionValue<double>("t_init");
 }

Referenced by propagateOptions().

◆ boltzmannK()

double SimAnMinimizer::boltzmannK ( ) const

Definition at line 91 of file SimAnMinimizer.cpp.

 {
     return optionValue<double>("k");
 }

Referenced by propagateOptions().

◆ boltzmannMinTemp()

double SimAnMinimizer::boltzmannMinTemp ( ) const

Definition at line 121 of file SimAnMinimizer.cpp.

 {
     return optionValue<double>("t_min");
 }

Referenced by propagateOptions().

◆ boltzmannMu()

double SimAnMinimizer::boltzmannMu ( ) const

Definition at line 111 of file SimAnMinimizer.cpp.

 {
     return optionValue<double>("mu");
 }

Referenced by propagateOptions().

◆ 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

protectedinherited

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 MinimizerAdapter::rootMinimizer().

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

Here is the call graph for this function:

◆ iterationsAtEachTemp()

int SimAnMinimizer::iterationsAtEachTemp ( ) const

Definition at line 71 of file SimAnMinimizer.cpp.

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

Referenced by propagateOptions().

◆ maxIterations()

int SimAnMinimizer::maxIterations ( ) const

Definition at line 61 of file SimAnMinimizer.cpp.

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

Referenced by propagateOptions().

◆ minimize()

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

protectedinherited

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 MinimizerAdapter::m_adapter, MinimizerAdapter::m_status, 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	fcn,
		mumufit::Parameters	parameters
	)

overridevirtualinherited

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 MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), and MinimizerAdapter::rootMinimizer().

Here is the call graph for this function:

◆ minimize_scalar()

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

overridevirtualinherited

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 MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), and MinimizerAdapter::rootMinimizer().

Here is the call graph for this function:

◆ minimizerName()

std::string MinimizerAdapter::minimizerName ( ) const

finalvirtualinherited

Returns name of the minimizer.

Implements IMinimizer.

Definition at line 66 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

finalvirtualinherited

Returns minimum function value.

Reimplemented from IMinimizer.

Definition at line 83 of file MinimizerAdapter.cpp.

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

References 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 64 of file MinimizerAdapter.h.

64 { return m_options; }

References MinimizerAdapter::m_options.

Referenced by MinimizerAdapter::setOptions().

◆ options() [2/2]

const MinimizerOptions& MinimizerAdapter::options ( ) const

inlineinherited

Definition at line 65 of file MinimizerAdapter.h.

65 { return m_options; }

References MinimizerAdapter::m_options.

◆ optionValue()

template<class T >

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

protectedinherited

Definition at line 122 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 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 MinimizerAdapter::fitDimension(), 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 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 MinimizerAdapter::fitDimension(), and MinimizerAdapter::rootMinimizer().

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

◆ printLevel()

int SimAnMinimizer::printLevel ( ) const

Definition at line 51 of file SimAnMinimizer.cpp.

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

◆ propagateOptions()

void SimAnMinimizer::propagateOptions ( )

overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 133 of file SimAnMinimizer.cpp.

 {
     ROOT::Math::GSLSimAnParams& pars = m_siman_minimizer->getSolver().Params();
     pars.n_tries = maxIterations();
     pars.iters_fixed_T = iterationsAtEachTemp();
     pars.step_size = stepSize();
     pars.k = boltzmannK();
     pars.t_initial = boltzmannInitialTemp();
     pars.mu_t = boltzmannMu();
     pars.t_min = boltzmannMinTemp();
 }

References boltzmannInitialTemp(), boltzmannK(), boltzmannMinTemp(), boltzmannMu(), iterationsAtEachTemp(), m_siman_minimizer, maxIterations(), and stepSize().

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 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 MinimizerAdapter::fitDimension(), 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 93 of file MinimizerAdapter.cpp.

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

References 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 59 of file IMinimizer.h.

59 { return false; }

◆ rootMinimizer() [1/2]

MinimizerAdapter::root_minimizer_t * MinimizerAdapter::rootMinimizer ( )

protectedinherited

Definition at line 209 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 * SimAnMinimizer::rootMinimizer ( ) const

overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 145 of file SimAnMinimizer.cpp.

 {
     return m_siman_minimizer.get();
 }

References m_siman_minimizer.

Referenced by statusMap().

◆ setBoltzmannInitialTemp()

void SimAnMinimizer::setBoltzmannInitialTemp ( double value )

Sets Boltzmann distribution parameter: initial temperature.

Definition at line 96 of file SimAnMinimizer.cpp.

 {
     setOptionValue("t_init", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setBoltzmannK()

void SimAnMinimizer::setBoltzmannK ( double value )

Sets Boltzmann distribution parameter: k.

Definition at line 86 of file SimAnMinimizer.cpp.

 {
     setOptionValue("k", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setBoltzmannMinTemp()

void SimAnMinimizer::setBoltzmannMinTemp ( double value )

Sets Boltzmann distribution parameter: minimal temperature.

Definition at line 116 of file SimAnMinimizer.cpp.

 {
     setOptionValue("t_min", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setBoltzmannMu()

void SimAnMinimizer::setBoltzmannMu ( double value )

Sets Boltzmann distribution parameter: mu.

Definition at line 106 of file SimAnMinimizer.cpp.

 {
     setOptionValue("mu", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setIterationsAtEachTemp()

void SimAnMinimizer::setIterationsAtEachTemp ( int value )

Sets number of iterations at each temperature.

Definition at line 66 of file SimAnMinimizer.cpp.

 {
     setOptionValue("IterationsAtTemp", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setMaxIterations()

void SimAnMinimizer::setMaxIterations ( int value )

Sets maximum number of iterations to try at each step.

Definition at line 56 of file SimAnMinimizer.cpp.

 {
     setOptionValue("MaxIterations", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setOptions()

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

finalvirtualinherited

Sets option string to the minimizer.

Reimplemented from IMinimizer.

Definition at line 113 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 117 of file MinimizerAdapter.h.

 {
     m_options.setOptionValue(optionName, value);
 }

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

Referenced by setBoltzmannInitialTemp(), setBoltzmannK(), setBoltzmannMinTemp(), setBoltzmannMu(), Minuit2Minimizer::setErrorDefinition(), setIterationsAtEachTemp(), Minuit2Minimizer::setMaxFunctionCalls(), GeneticMinimizer::setMaxIterations(), GSLLevenbergMarquardtMinimizer::setMaxIterations(), GSLMultiMinimizer::setMaxIterations(), setMaxIterations(), GeneticMinimizer::setPopulationSize(), Minuit2Minimizer::setPrecision(), GeneticMinimizer::setPrintLevel(), GSLLevenbergMarquardtMinimizer::setPrintLevel(), GSLMultiMinimizer::setPrintLevel(), Minuit2Minimizer::setPrintLevel(), setPrintLevel(), GeneticMinimizer::setRandomSeed(), 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 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(), MinimizerAdapter::rootMinimizer(), 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 76 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 SimAnMinimizer::setPrintLevel ( int value )

Sets minimizer internal print level.

Default value is 0 (silent).

Definition at line 46 of file SimAnMinimizer.cpp.

 {
     setOptionValue("PrintLevel", value);
 }

References MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

◆ setStepSize()

void SimAnMinimizer::setStepSize ( double value )

Sets max step size used in random walk.

Definition at line 76 of file SimAnMinimizer.cpp.

 {
     setOptionValue("StepSize", value);
 }

References MinimizerAdapter::setOptionValue().

Referenced by SimAnMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ statusMap()

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

overridevirtual

Returns map of string representing different minimizer statuses.

Reimplemented from MinimizerAdapter.

Definition at line 126 of file SimAnMinimizer.cpp.

 {
     auto result = MinimizerAdapter::statusMap();
     result["functionCalls"] = std::to_string(rootMinimizer()->NCalls());
     return result;
 }

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

Here is the call graph for this function:

◆ statusToString()

std::string MinimizerAdapter::statusToString ( ) const

virtualinherited

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 MinimizerAdapter::m_status.

Referenced by MinimizerAdapter::statusMap().

◆ stepSize()

double SimAnMinimizer::stepSize ( ) const

Definition at line 81 of file SimAnMinimizer.cpp.

 {
     return optionValue<double>("StepSize");
 }

Referenced by propagateOptions().

Member Data Documentation

◆ m_adapter

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

privateinherited

Definition at line 106 of file MinimizerAdapter.h.

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

◆ m_minimizerInfo

MinimizerInfo MinimizerAdapter::m_minimizerInfo

privateinherited

Definition at line 105 of file MinimizerAdapter.h.

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

◆ m_options

MinimizerOptions MinimizerAdapter::m_options

privateinherited

Definition at line 104 of file MinimizerAdapter.h.

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

◆ m_siman_minimizer

std::unique_ptr<ROOT::Math::GSLSimAnMinimizer> SimAnMinimizer::m_siman_minimizer

private

Definition at line 77 of file SimAnMinimizer.h.

Referenced by propagateOptions(), and rootMinimizer().

◆ m_status

bool MinimizerAdapter::m_status

privateinherited

Definition at line 107 of file MinimizerAdapter.h.

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

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ root_minimizer_t

Constructor & Destructor Documentation

◆ SimAnMinimizer()

◆ ~SimAnMinimizer()

Member Function Documentation

◆ addOption()

◆ algorithmName()

◆ boltzmannInitialTemp()

◆ boltzmannK()

◆ boltzmannMinTemp()

◆ boltzmannMu()

◆ clear()

◆ fitDimension()

◆ iterationsAtEachTemp()

◆ maxIterations()

◆ minimize()

◆ minimize_residual()

◆ minimize_scalar()

◆ minimizerName()

◆ minValue()

◆ options() [1/2]

◆ options() [2/2]

◆ optionValue()

◆ parErrorsAtMinimum()

◆ parValuesAtMinimum()

◆ printLevel()

◆ propagateOptions()

◆ propagateResults()

◆ providesError()

◆ requiresResiduals()

◆ rootMinimizer() [1/2]

◆ rootMinimizer() [2/2]

◆ setBoltzmannInitialTemp()

◆ setBoltzmannK()

◆ setBoltzmannMinTemp()

◆ setBoltzmannMu()

◆ setIterationsAtEachTemp()

◆ setMaxIterations()

◆ setOptions()

◆ setOptionValue()

◆ setParameter()

◆ setParameters()

◆ setPrintLevel()

◆ setStepSize()

◆ statusMap()

◆ statusToString()

◆ stepSize()

Member Data Documentation

◆ m_adapter

◆ m_minimizerInfo

◆ m_options

◆ m_siman_minimizer

◆ m_status