BornAgain
1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
|
Wrapper for the CERN ROOT Genetic minimizer. More...
Public Types | |
typedef ROOT::Math::Minimizer | root_minimizer_t |
Public Member Functions | |
GeneticMinimizer () | |
~GeneticMinimizer () | |
std::string | algorithmName () const final |
Returns name of the minimization algorithm. More... | |
virtual void | clear () |
clear resources (parameters) for consecutives minimizations More... | |
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 | populationSize () const |
int | printLevel () const |
bool | providesError () const |
Returns true if minimizer provides error and error matrix. More... | |
int | randomSeed () const |
virtual bool | requiresResiduals () |
Returns true if minimizer computations are residual-based, false otherwise. 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 ¶meters) |
void | setPopulationSize (int value) |
Sets population size. More... | |
void | setPrintLevel (int value) |
Sets minimizer internal print level. More... | |
void | setRandomSeed (int value) |
Sets random seed. More... | |
void | setTolerance (double value) |
Sets tolerance on the function value at the minimum. More... | |
std::map< std::string, std::string > | statusMap () const override |
Returns map of string representing different minimizer statuses. More... | |
std::string | statusToString () const override |
Returns string representation of current minimizer status. More... | |
double | tolerance () 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 ¶meters) |
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) |
void | setParameter (unsigned int index, const mumufit::Parameter &par) override |
Private Attributes | |
std::unique_ptr< mumufit::ObjectiveFunctionAdapter > | m_adapter |
std::unique_ptr< ROOT::Math::GeneticMinimizer > | m_genetic_minimizer |
MinimizerInfo | m_minimizerInfo |
MinimizerOptions | m_options |
bool | m_status |
Wrapper for the CERN ROOT Genetic minimizer.
Definition at line 32 of file GeneticMinimizer.h.
|
inherited |
Definition at line 45 of file MinimizerAdapter.h.
GeneticMinimizer::GeneticMinimizer | ( | ) |
Definition at line 29 of file GeneticMinimizer.cpp.
References MinimizerAdapter::addOption().
|
default |
|
protectedinherited |
Definition at line 111 of file MinimizerAdapter.h.
References OptionContainer::addOption(), and MinimizerAdapter::m_options.
Referenced by GeneticMinimizer(), GSLLevenbergMarquardtMinimizer::GSLLevenbergMarquardtMinimizer(), GSLMultiMinimizer::GSLMultiMinimizer(), Minuit2Minimizer::Minuit2Minimizer(), and SimAnMinimizer::SimAnMinimizer().
|
finalvirtualinherited |
Returns name of the minimization algorithm.
Implements IMinimizer.
Definition at line 71 of file MinimizerAdapter.cpp.
References MinimizerInfo::algorithmName(), and MinimizerAdapter::m_minimizerInfo.
Referenced by Minuit2Minimizer::requiresResiduals().
|
inlinevirtualinherited |
clear resources (parameters) for consecutives minimizations
Definition at line 49 of file IMinimizer.h.
|
protectedinherited |
Returns number of fit parameters defined (i.e. dimension of the function to be minimized).
Definition at line 181 of file MinimizerAdapter.cpp.
References MinimizerAdapter::rootMinimizer().
Referenced by MinimizerAdapter::parErrorsAtMinimum(), MinimizerAdapter::parValuesAtMinimum(), and MinimizerAdapter::propagateResults().
int GeneticMinimizer::maxIterations | ( | ) | const |
Definition at line 77 of file GeneticMinimizer.cpp.
Referenced by propagateOptions().
|
protectedinherited |
Definition at line 48 of file MinimizerAdapter.cpp.
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().
|
overridevirtualinherited |
Reimplemented from IMinimizer.
Definition at line 41 of file MinimizerAdapter.cpp.
References MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), and MinimizerAdapter::rootMinimizer().
|
overridevirtualinherited |
run minimization
Reimplemented from IMinimizer.
Definition at line 34 of file MinimizerAdapter.cpp.
References MinimizerAdapter::m_adapter, MinimizerAdapter::minimize(), and MinimizerAdapter::rootMinimizer().
|
finalvirtualinherited |
Returns name of the minimizer.
Implements IMinimizer.
Definition at line 66 of file MinimizerAdapter.cpp.
References MinimizerAdapter::m_minimizerInfo, and MinimizerInfo::name().
|
finalvirtualinherited |
Returns minimum function value.
Reimplemented from IMinimizer.
Definition at line 83 of file MinimizerAdapter.cpp.
References MinimizerAdapter::rootMinimizer().
Referenced by MinimizerAdapter::minimize(), and MinimizerAdapter::statusMap().
|
inlineinherited |
Definition at line 64 of file MinimizerAdapter.h.
References MinimizerAdapter::m_options.
Referenced by MinimizerAdapter::setOptions().
|
inlineinherited |
|
protectedinherited |
Definition at line 122 of file MinimizerAdapter.h.
References MinimizerAdapter::m_options, and OptionContainer::optionValue().
|
protectedinherited |
Returns errors of the variables at minimum.
Definition at line 198 of file MinimizerAdapter.cpp.
References MinimizerAdapter::fitDimension(), and MinimizerAdapter::rootMinimizer().
Referenced by MinimizerAdapter::propagateResults().
|
protectedinherited |
Returns value of the variables at minimum.
Definition at line 188 of file MinimizerAdapter.cpp.
References MinimizerAdapter::fitDimension(), and MinimizerAdapter::rootMinimizer().
Referenced by MinimizerAdapter::propagateResults().
int GeneticMinimizer::populationSize | ( | ) | const |
Definition at line 87 of file GeneticMinimizer.cpp.
Referenced by propagateOptions().
int GeneticMinimizer::printLevel | ( | ) | const |
Definition at line 67 of file GeneticMinimizer.cpp.
|
overrideprotectedvirtual |
Implements MinimizerAdapter.
Definition at line 127 of file GeneticMinimizer.cpp.
References m_genetic_minimizer, maxIterations(), populationSize(), randomSeed(), and tolerance().
|
protectedinherited |
Propagates results of minimization to fit parameter set.
Definition at line 120 of file MinimizerAdapter.cpp.
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().
|
inherited |
Returns true if minimizer provides error and error matrix.
Definition at line 93 of file MinimizerAdapter.cpp.
References MinimizerAdapter::rootMinimizer().
Referenced by MinimizerAdapter::propagateResults(), and MinimizerAdapter::statusMap().
int GeneticMinimizer::randomSeed | ( | ) | const |
Definition at line 97 of file GeneticMinimizer.cpp.
Referenced by propagateOptions().
|
inlinevirtualinherited |
Returns true if minimizer computations are residual-based, false otherwise.
Reimplemented in Minuit2Minimizer, and GSLLevenbergMarquardtMinimizer.
Definition at line 59 of file IMinimizer.h.
|
protectedinherited |
Definition at line 209 of file MinimizerAdapter.cpp.
References MinimizerAdapter::rootMinimizer().
|
overrideprotectedvirtual |
Implements MinimizerAdapter.
Definition at line 142 of file GeneticMinimizer.cpp.
References m_genetic_minimizer.
Referenced by statusMap(), and statusToString().
void GeneticMinimizer::setMaxIterations | ( | int | value | ) |
Sets maximum number of iterations to try at each step.
Definition at line 72 of file GeneticMinimizer.cpp.
References MinimizerAdapter::setOptionValue().
Referenced by GeneticMinimizerItem::createMinimizer().
|
finalvirtualinherited |
Sets option string to the minimizer.
Reimplemented from IMinimizer.
Definition at line 113 of file MinimizerAdapter.cpp.
References MinimizerAdapter::options(), and MinimizerOptions::setOptionString().
|
protectedinherited |
Definition at line 117 of file MinimizerAdapter.h.
References MinimizerAdapter::m_options, and OptionContainer::setOptionValue().
Referenced by SimAnMinimizer::setBoltzmannInitialTemp(), SimAnMinimizer::setBoltzmannK(), SimAnMinimizer::setBoltzmannMinTemp(), SimAnMinimizer::setBoltzmannMu(), Minuit2Minimizer::setErrorDefinition(), SimAnMinimizer::setIterationsAtEachTemp(), Minuit2Minimizer::setMaxFunctionCalls(), setMaxIterations(), GSLLevenbergMarquardtMinimizer::setMaxIterations(), GSLMultiMinimizer::setMaxIterations(), SimAnMinimizer::setMaxIterations(), setPopulationSize(), Minuit2Minimizer::setPrecision(), setPrintLevel(), GSLLevenbergMarquardtMinimizer::setPrintLevel(), GSLMultiMinimizer::setPrintLevel(), Minuit2Minimizer::setPrintLevel(), SimAnMinimizer::setPrintLevel(), setRandomSeed(), SimAnMinimizer::setStepSize(), Minuit2Minimizer::setStrategy(), setTolerance(), GSLLevenbergMarquardtMinimizer::setTolerance(), and Minuit2Minimizer::setTolerance().
|
protected |
Definition at line 86 of file MinimizerAdapter.cpp.
|
overrideprotectedvirtual |
Reimplemented from MinimizerAdapter.
Definition at line 102 of file GeneticMinimizer.cpp.
References AttLimits::isFixed(), AttLimits::isLimited(), mumufit::Parameter::limits(), mumufit::Parameter::name(), MinimizerAdapter::setParameter(), and AttLimits::toString().
|
inherited |
Definition at line 76 of file MinimizerAdapter.cpp.
References MinimizerAdapter::setParameter().
Referenced by MinimizerAdapter::minimize().
void GeneticMinimizer::setPopulationSize | ( | int | value | ) |
Sets population size.
Definition at line 82 of file GeneticMinimizer.cpp.
References MinimizerAdapter::setOptionValue().
Referenced by GeneticMinimizerItem::createMinimizer().
void GeneticMinimizer::setPrintLevel | ( | int | value | ) |
Sets minimizer internal print level.
Definition at line 62 of file GeneticMinimizer.cpp.
References MinimizerAdapter::setOptionValue().
void GeneticMinimizer::setRandomSeed | ( | int | value | ) |
Sets random seed.
Definition at line 92 of file GeneticMinimizer.cpp.
References MinimizerAdapter::setOptionValue().
Referenced by GeneticMinimizerItem::createMinimizer().
void GeneticMinimizer::setTolerance | ( | double | value | ) |
Sets tolerance on the function value at the minimum.
Minimization will stop when the estimated vertical distance to the minimum (EDM) is less than 0.001*tolerance*ErrorDef. Here ErrorDef=1.0 for chi squared fit and ErrorDef=0.5 for negative log likelihood fit.
Definition at line 52 of file GeneticMinimizer.cpp.
References MinimizerAdapter::setOptionValue().
Referenced by GeneticMinimizerItem::createMinimizer().
|
overridevirtual |
Returns map of string representing different minimizer statuses.
Reimplemented from MinimizerAdapter.
Definition at line 120 of file GeneticMinimizer.cpp.
References rootMinimizer(), and MinimizerAdapter::statusMap().
|
overridevirtual |
Returns string representation of current minimizer status.
Reimplemented from MinimizerAdapter.
Definition at line 115 of file GeneticMinimizer.cpp.
References rootMinimizer().
double GeneticMinimizer::tolerance | ( | ) | const |
Definition at line 57 of file GeneticMinimizer.cpp.
Referenced by propagateOptions().
|
privateinherited |
Definition at line 106 of file MinimizerAdapter.h.
Referenced by MinimizerAdapter::minimize(), MinimizerAdapter::minimize_residual(), and MinimizerAdapter::minimize_scalar().
|
private |
Definition at line 71 of file GeneticMinimizer.h.
Referenced by propagateOptions(), and rootMinimizer().
|
privateinherited |
Definition at line 105 of file MinimizerAdapter.h.
Referenced by MinimizerAdapter::algorithmName(), and MinimizerAdapter::minimizerName().
|
privateinherited |
Definition at line 104 of file MinimizerAdapter.h.
Referenced by MinimizerAdapter::addOption(), MinimizerAdapter::options(), MinimizerAdapter::optionValue(), and MinimizerAdapter::setOptionValue().
|
privateinherited |
Definition at line 107 of file MinimizerAdapter.h.
Referenced by MinimizerAdapter::minimize(), and MinimizerAdapter::statusToString().