BornAgain
1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
|
Public Types | |
typedef ROOT::Math::Minimizer | root_minimizer_t |
Public Member Functions | |
SimAnMinimizer () | |
~SimAnMinimizer () override | |
void | setPrintLevel (int value) |
int | printLevel () const |
void | setMaxIterations (int value) |
int | maxIterations () const |
void | setIterationsAtEachTemp (int value) |
int | iterationsAtEachTemp () const |
void | setStepSize (double value) |
double | stepSize () const |
void | setBoltzmannK (double value) |
double | boltzmannK () const |
void | setBoltzmannInitialTemp (double value) |
double | boltzmannInitialTemp () const |
void | setBoltzmannMu (double value) |
double | boltzmannMu () const |
void | setBoltzmannMinTemp (double value) |
double | boltzmannMinTemp () const |
std::map< std::string, std::string > | statusMap () const override |
Fit::MinimizerResult | minimize_scalar (fcn_scalar_t fcn, Fit::Parameters parameters) override |
Fit::MinimizerResult | minimize_residual (fcn_residual_t fcn, Fit::Parameters parameters) override |
std::string | minimizerName () const override final |
std::string | algorithmName () const override final |
void | setParameters (const Fit::Parameters ¶meters) |
double | minValue () const override final |
MinimizerOptions & | options () |
const MinimizerOptions & | options () const |
virtual std::string | statusToString () const |
bool | providesError () const |
void | setOptions (const std::string &optionString) override final |
virtual void | clear () |
virtual bool | requiresResiduals () |
Protected Member Functions | |
void | propagateOptions () override |
const root_minimizer_t * | rootMinimizer () const override |
Fit::MinimizerResult | minimize (Fit::Parameters parameters) |
void | propagateResults (Fit::Parameters ¶meters) |
virtual void | setParameter (unsigned int index, const Fit::Parameter &par) |
size_t | fitDimension () const |
std::vector< double > | parValuesAtMinimum () const |
std::vector< double > | parErrorsAtMinimum () const |
root_minimizer_t * | rootMinimizer () |
template<class T > | |
OptionContainer::option_t | addOption (const std::string &optionName, T value, const std::string &description="") |
template<class T > | |
void | setOptionValue (const std::string &optionName, T value) |
template<class T > | |
T | optionValue (const std::string &optionName) const |
Private Attributes | |
std::unique_ptr< ROOT::Math::GSLSimAnMinimizer > | m_siman_minimizer |
MinimizerOptions | m_options |
MinimizerInfo | m_minimizerInfo |
std::unique_ptr< Fit::ObjectiveFunctionAdapter > | m_adapter |
bool | m_status |
Wrapper for the CERN ROOT facade of the GSL simmulated annealing minimizer.
Definition at line 31 of file SimAnMinimizer.h.
|
inherited |
Definition at line 46 of file RootMinimizerAdapter.h.
SimAnMinimizer::SimAnMinimizer | ( | ) |
Definition at line 30 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::addOption().
|
overridedefault |
void SimAnMinimizer::setPrintLevel | ( | int | value | ) |
Sets minimizer internal print level.
Default value is 0 (silent).
Definition at line 46 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
int SimAnMinimizer::printLevel | ( | ) | const |
Definition at line 51 of file SimAnMinimizer.cpp.
void SimAnMinimizer::setMaxIterations | ( | int | value | ) |
Sets maximum number of iterations to try at each step.
Definition at line 56 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
int SimAnMinimizer::maxIterations | ( | ) | const |
Definition at line 61 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setIterationsAtEachTemp | ( | int | value | ) |
Sets number of iterations at each temperature.
Definition at line 66 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
int SimAnMinimizer::iterationsAtEachTemp | ( | ) | const |
Definition at line 71 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setStepSize | ( | double | value | ) |
Sets max step size used in random walk.
Definition at line 76 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
double SimAnMinimizer::stepSize | ( | ) | const |
Definition at line 81 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setBoltzmannK | ( | double | value | ) |
Sets Boltzmann distribution parameter: k.
Definition at line 86 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
double SimAnMinimizer::boltzmannK | ( | ) | const |
Definition at line 91 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setBoltzmannInitialTemp | ( | double | value | ) |
Sets Boltzmann distribution parameter: initial temperature.
Definition at line 96 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
double SimAnMinimizer::boltzmannInitialTemp | ( | ) | const |
Definition at line 101 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setBoltzmannMu | ( | double | value | ) |
Sets Boltzmann distribution parameter: mu.
Definition at line 106 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
double SimAnMinimizer::boltzmannMu | ( | ) | const |
Definition at line 111 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
void SimAnMinimizer::setBoltzmannMinTemp | ( | double | value | ) |
Sets Boltzmann distribution parameter: minimal temperature.
Definition at line 116 of file SimAnMinimizer.cpp.
References RootMinimizerAdapter::setOptionValue().
double SimAnMinimizer::boltzmannMinTemp | ( | ) | const |
Definition at line 121 of file SimAnMinimizer.cpp.
Referenced by propagateOptions().
|
overridevirtual |
Returns map of string representing different minimizer statuses.
Reimplemented from RootMinimizerAdapter.
Definition at line 126 of file SimAnMinimizer.cpp.
References rootMinimizer(), and RootMinimizerAdapter::statusMap().
|
overrideprotectedvirtual |
Implements RootMinimizerAdapter.
Definition at line 133 of file SimAnMinimizer.cpp.
References boltzmannInitialTemp(), boltzmannK(), boltzmannMinTemp(), boltzmannMu(), iterationsAtEachTemp(), m_siman_minimizer, maxIterations(), and stepSize().
|
overrideprotectedvirtual |
Implements RootMinimizerAdapter.
Definition at line 145 of file SimAnMinimizer.cpp.
References m_siman_minimizer.
Referenced by statusMap().
|
overridevirtualinherited |
run minimization
Reimplemented from IMinimizer.
Definition at line 32 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::m_adapter, RootMinimizerAdapter::minimize(), and RootMinimizerAdapter::rootMinimizer().
|
overridevirtualinherited |
Reimplemented from IMinimizer.
Definition at line 39 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::m_adapter, RootMinimizerAdapter::minimize(), and RootMinimizerAdapter::rootMinimizer().
|
finaloverridevirtualinherited |
Returns name of the minimizer.
Implements IMinimizer.
Definition at line 64 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::m_minimizerInfo, and MinimizerInfo::name().
Referenced by anonymous_namespace{MinimizerResultUtils.cpp}::reportDescription().
|
finaloverridevirtualinherited |
Returns name of the minimization algorithm.
Implements IMinimizer.
Definition at line 69 of file RootMinimizerAdapter.cpp.
References MinimizerInfo::algorithmName(), and RootMinimizerAdapter::m_minimizerInfo.
Referenced by anonymous_namespace{MinimizerResultUtils.cpp}::reportDescription(), and Minuit2Minimizer::requiresResiduals().
|
inherited |
Definition at line 74 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::setParameter().
Referenced by RootMinimizerAdapter::minimize().
|
finaloverridevirtualinherited |
Returns minimum function value.
Reimplemented from IMinimizer.
Definition at line 81 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::rootMinimizer().
Referenced by RootMinimizerAdapter::minimize(), and RootMinimizerAdapter::statusMap().
|
inlineinherited |
Definition at line 63 of file RootMinimizerAdapter.h.
References RootMinimizerAdapter::m_options.
Referenced by anonymous_namespace{MinimizerResultUtils.cpp}::reportOption(), and RootMinimizerAdapter::setOptions().
|
inlineinherited |
|
virtualinherited |
Returns string representation of current minimizer status.
Reimplemented in Minuit2Minimizer, GSLMultiMinimizer, GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.
Definition at line 86 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::m_status.
Referenced by RootMinimizerAdapter::statusMap().
|
inherited |
Returns true if minimizer provides error and error matrix.
Definition at line 91 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::rootMinimizer().
Referenced by RootMinimizerAdapter::propagateResults(), and RootMinimizerAdapter::statusMap().
|
finaloverridevirtualinherited |
Sets option string to the minimizer.
Reimplemented from IMinimizer.
Definition at line 111 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::options(), and MinimizerOptions::setOptionString().
|
protectedinherited |
Definition at line 46 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::m_adapter, RootMinimizerAdapter::m_status, RootMinimizerAdapter::minValue(), RootMinimizerAdapter::propagateOptions(), RootMinimizerAdapter::propagateResults(), MinimizerResultUtils::reportToString(), RootMinimizerAdapter::rootMinimizer(), Fit::MinimizerResult::setMinValue(), Fit::MinimizerResult::setNumberOfCalls(), Fit::MinimizerResult::setNumberOfGradientCalls(), RootMinimizerAdapter::setParameters(), Fit::MinimizerResult::setParameters(), and Fit::MinimizerResult::setReport().
Referenced by RootMinimizerAdapter::minimize_residual(), and RootMinimizerAdapter::minimize_scalar().
|
protectedinherited |
Propagates results of minimization to fit parameter set.
Definition at line 118 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::fitDimension(), RootMinimizerAdapter::parErrorsAtMinimum(), RootMinimizerAdapter::parValuesAtMinimum(), RootMinimizerAdapter::providesError(), RootMinimizerAdapter::rootMinimizer(), Fit::Parameters::setCorrelationMatrix(), Fit::Parameters::setErrors(), and Fit::Parameters::setValues().
Referenced by RootMinimizerAdapter::minimize().
|
protectedvirtualinherited |
Reimplemented in GSLLevenbergMarquardtMinimizer, and GeneticMinimizer.
Definition at line 137 of file RootMinimizerAdapter.cpp.
References AttLimits::isFixed(), AttLimits::isLimited(), AttLimits::isLimitless(), AttLimits::isLowerLimited(), AttLimits::isUpperLimited(), Fit::Parameter::limits(), AttLimits::lowerLimit(), Fit::Parameter::name(), RootMinimizerAdapter::rootMinimizer(), Fit::Parameter::step(), AttLimits::upperLimit(), and Fit::Parameter::value().
Referenced by GeneticMinimizer::setParameter(), GSLLevenbergMarquardtMinimizer::setParameter(), and RootMinimizerAdapter::setParameters().
|
protectedinherited |
Returns number of fit parameters defined (i.e. dimension of the function to be minimized).
Definition at line 179 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::rootMinimizer().
Referenced by RootMinimizerAdapter::parErrorsAtMinimum(), RootMinimizerAdapter::parValuesAtMinimum(), and RootMinimizerAdapter::propagateResults().
|
protectedinherited |
Returns value of the variables at minimum.
Definition at line 186 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::fitDimension(), and RootMinimizerAdapter::rootMinimizer().
Referenced by RootMinimizerAdapter::propagateResults().
|
protectedinherited |
Returns errors of the variables at minimum.
Definition at line 196 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::fitDimension(), and RootMinimizerAdapter::rootMinimizer().
Referenced by RootMinimizerAdapter::propagateResults().
|
protectedinherited |
Definition at line 207 of file RootMinimizerAdapter.cpp.
References RootMinimizerAdapter::rootMinimizer().
|
protectedinherited |
Definition at line 110 of file RootMinimizerAdapter.h.
References OptionContainer::addOption(), and RootMinimizerAdapter::m_options.
Referenced by GeneticMinimizer::GeneticMinimizer(), GSLLevenbergMarquardtMinimizer::GSLLevenbergMarquardtMinimizer(), GSLMultiMinimizer::GSLMultiMinimizer(), Minuit2Minimizer::Minuit2Minimizer(), and SimAnMinimizer().
|
protectedinherited |
Definition at line 116 of file RootMinimizerAdapter.h.
References RootMinimizerAdapter::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().
|
protectedinherited |
Definition at line 121 of file RootMinimizerAdapter.h.
References RootMinimizerAdapter::m_options, and OptionContainer::optionValue().
|
inlinevirtualinherited |
clear resources (parameters) for consecutives minimizations
Definition at line 50 of file IMinimizer.h.
|
inlinevirtualinherited |
Returns true if minimizer computations are residual-based, false otherwise.
Reimplemented in Minuit2Minimizer, and GSLLevenbergMarquardtMinimizer.
Definition at line 60 of file IMinimizer.h.
|
private |
Definition at line 77 of file SimAnMinimizer.h.
Referenced by propagateOptions(), and rootMinimizer().
|
privateinherited |
Definition at line 103 of file RootMinimizerAdapter.h.
Referenced by RootMinimizerAdapter::addOption(), RootMinimizerAdapter::options(), RootMinimizerAdapter::optionValue(), and RootMinimizerAdapter::setOptionValue().
|
privateinherited |
Definition at line 104 of file RootMinimizerAdapter.h.
Referenced by RootMinimizerAdapter::algorithmName(), and RootMinimizerAdapter::minimizerName().
|
privateinherited |
Definition at line 105 of file RootMinimizerAdapter.h.
Referenced by RootMinimizerAdapter::minimize(), RootMinimizerAdapter::minimize_residual(), and RootMinimizerAdapter::minimize_scalar().
|
privateinherited |
Definition at line 106 of file RootMinimizerAdapter.h.
Referenced by RootMinimizerAdapter::minimize(), and RootMinimizerAdapter::statusToString().