BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
GeneticMinimizer Class Reference

Wrapper for the CERN ROOT Genetic minimizer. More...

Inheritance diagram for GeneticMinimizer:
[legend]
Collaboration diagram for GeneticMinimizer:
[legend]

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...
 
MinimizerOptionsoptions ()
 
const MinimizerOptionsoptions () 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 &parameters)
 
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 >
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_trootMinimizer ()
 
const root_minimizer_trootMinimizer () 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::ObjectiveFunctionAdapterm_adapter
 
std::unique_ptr< ROOT::Math::GeneticMinimizer > m_genetic_minimizer
 
MinimizerInfo m_minimizerInfo
 
MinimizerOptions m_options
 
bool m_status
 

Detailed Description

Wrapper for the CERN ROOT Genetic minimizer.

Definition at line 32 of file GeneticMinimizer.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

◆ GeneticMinimizer()

GeneticMinimizer::GeneticMinimizer ( )

Definition at line 29 of file GeneticMinimizer.cpp.

31  , m_genetic_minimizer(new ROOT::Math::GeneticMinimizer())
32 {
33  addOption("Tolerance", 0.01, "Tolerance on the function value at the minimum");
34  addOption("PrintLevel", 0, "Minimizer internal print level");
35  addOption("MaxIterations", 3, "Maximum number of iterations");
36  addOption("PopSize", 300, "Population size");
37  addOption("RandomSeed", 0, "Random seed");
38 
39  // Seems it is not used inside Root, no need to expose
40  // addOption("Cycles", 3, "Number of cycles");
41 
42  // It's hard to understand (without going to much into genetics details), what parameters below
43  // are doing. So better to not to expose and rely on their internal ROOT's default values.
44 
45  // addOption("sc_steps", 10, "Spread control steps");
46  // addOption("sc_rate", 5, "Spread control rate");
47  // addOption("sc_factor", 0.95, "Spread control factor");
48 }
std::unique_ptr< ROOT::Math::GeneticMinimizer > m_genetic_minimizer
OptionContainer::option_t addOption(const std::string &optionName, T value, const std::string &description="")
MinimizerAdapter(const MinimizerInfo &minimizerInfo)
static MinimizerInfo buildGeneticInfo()
Creates information for TMVA genetic minimizer.

References MinimizerAdapter::addOption().

Here is the call graph for this function:

◆ ~GeneticMinimizer()

GeneticMinimizer::~GeneticMinimizer ( )
default

Member Function Documentation

◆ addOption()

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

Definition at line 111 of file MinimizerAdapter.h.

113 {
114  return m_options.addOption(optionName, value, description);
115 }
MinimizerOptions m_options
option_t addOption(const std::string &optionName, T value, const std::string &description="")

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

Referenced by GeneticMinimizer(), GSLLevenbergMarquardtMinimizer::GSLLevenbergMarquardtMinimizer(), GSLMultiMinimizer::GSLMultiMinimizer(), Minuit2Minimizer::Minuit2Minimizer(), and SimAnMinimizer::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.

72 {
74 }
MinimizerInfo m_minimizerInfo
std::string algorithmName() const
Definition: MinimizerInfo.h:62

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

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.

182 {
183  return rootMinimizer()->NDim();
184 }
virtual const root_minimizer_t * rootMinimizer() const =0

References MinimizerAdapter::rootMinimizer().

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

Here is the call graph for this function:

◆ maxIterations()

int GeneticMinimizer::maxIterations ( ) const

Definition at line 77 of file GeneticMinimizer.cpp.

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

Referenced by propagateOptions().

◆ minimize()

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

Definition at line 48 of file MinimizerAdapter.cpp.

49 {
50  setParameters(parameters);
52 
53  m_status = rootMinimizer()->Minimize();
54  propagateResults(parameters);
55 
56  MinimizerResult result;
57  result.setParameters(parameters);
58  result.setMinValue(minValue());
59  result.setReport(internal::reportToString(*this));
60  result.setNumberOfCalls(m_adapter->numberOfCalls());
61  result.setNumberOfGradientCalls(m_adapter->numberOfGradientCalls());
62 
63  return result;
64 }
double minValue() const final
Returns minimum function value.
void propagateResults(mumufit::Parameters &parameters)
Propagates results of minimization to fit parameter set.
void setParameters(const mumufit::Parameters &parameters)
virtual void propagateOptions()=0
std::unique_ptr< mumufit::ObjectiveFunctionAdapter > m_adapter
Result of minimization round.
void setReport(const std::string &value)
void setMinValue(double value)
void setNumberOfGradientCalls(int value)
void setNumberOfCalls(int value)
void setParameters(const Parameters &parameters)
std::string reportToString(const MinimizerAdapter &minimizer)
Reports results of minimization in the form of multi-line string.
Definition: Report.cpp:76

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.

42 {
43  // Genetic minimizer requires SetFunction before setParameters, others don't care
44  rootMinimizer()->SetFunction(*m_adapter->rootResidualFunction(fcn, parameters));
45  return minimize(parameters);
46 }
mumufit::MinimizerResult minimize(mumufit::Parameters 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.

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

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.

67 {
68  return m_minimizerInfo.name();
69 }
std::string name() const
Definition: MinimizerInfo.h:59

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.

84 {
85  return rootMinimizer()->MinValue();
86 }

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.

123 {
124  return m_options.optionValue<T>(optionName);
125 }
T optionValue(const std::string &optionName) const

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.

199 {
200  std::vector<double> result;
201  result.resize(fitDimension(), 0.0);
202  if (rootMinimizer()->Errors() != 0) {
203  std::copy(rootMinimizer()->Errors(), rootMinimizer()->Errors() + fitDimension(),
204  result.begin());
205  }
206  return result;
207 }
size_t fitDimension() const
Returns number of fit parameters defined (i.e. dimension of the function to be minimized).

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.

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

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

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

◆ populationSize()

int GeneticMinimizer::populationSize ( ) const

Definition at line 87 of file GeneticMinimizer.cpp.

88 {
89  return optionValue<int>("PopSize");
90 }

Referenced by propagateOptions().

◆ printLevel()

int GeneticMinimizer::printLevel ( ) const

Definition at line 67 of file GeneticMinimizer.cpp.

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

◆ propagateOptions()

void GeneticMinimizer::propagateOptions ( )
overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 127 of file GeneticMinimizer.cpp.

128 {
129  ROOT::Math::GeneticMinimizerParameters pars;
130  pars.fPopSize = populationSize();
131  pars.fNsteps = maxIterations();
132  // pars.fCycles = m_options.getIntValue("Cycles"); // seems it's not used inside ROOT
133  // pars.fSC_steps = m_options.getIntValue("SC_steps"); // no idea what it is doing
134  // pars.fSC_rate = m_options.getIntValue("SC_rate"); // no idea what it is doing
135  // pars.fSC_factor = m_options.getRealValue("SC_factor"); // no idea what it is doing
136  const double scale_as_in_root = 10.0;
137  pars.fConvCrit = scale_as_in_root * tolerance();
138  pars.fSeed = randomSeed();
139  m_genetic_minimizer->SetParameters(pars);
140 }
double tolerance() const
int randomSeed() const
int populationSize() const
int maxIterations() const

References m_genetic_minimizer, maxIterations(), populationSize(), randomSeed(), and tolerance().

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.

121 {
122  parameters.setValues(parValuesAtMinimum());
123  parameters.setErrors(parErrorsAtMinimum());
124  // sets correlation matrix
125  if (providesError()) {
127  matrix.resize(fitDimension());
128 
129  for (size_t i = 0; i < fitDimension(); ++i) {
130  matrix[i].resize(fitDimension(), 0.0);
131  for (size_t j = 0; j < fitDimension(); ++j)
132  matrix[i][j] = rootMinimizer()->Correlation(static_cast<unsigned int>(i),
133  static_cast<unsigned int>(j));
134  }
135  parameters.setCorrelationMatrix(matrix);
136  }
137 }
std::vector< double > parValuesAtMinimum() const
Returns value of the variables at minimum.
bool providesError() const
Returns true if minimizer provides error and error matrix.
std::vector< double > parErrorsAtMinimum() const
Returns errors of the variables at minimum.
void setValues(const std::vector< double > &values)
Definition: Parameters.cpp:64
void setCorrelationMatrix(const corr_matrix_t &matrix)
Definition: Parameters.cpp:122
void setErrors(const std::vector< double > &errors)
Definition: Parameters.cpp:90
std::vector< std::vector< double > > corr_matrix_t
Definition: Parameters.h:31

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.

94 {
95  return rootMinimizer()->ProvidesError();
96 }

References MinimizerAdapter::rootMinimizer().

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

Here is the call graph for this function:

◆ randomSeed()

int GeneticMinimizer::randomSeed ( ) const

Definition at line 97 of file GeneticMinimizer.cpp.

98 {
99  return optionValue<int>("RandomSeed");
100 }

Referenced by propagateOptions().

◆ 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.

210 {
211  return const_cast<root_minimizer_t*>(
212  static_cast<const MinimizerAdapter*>(this)->rootMinimizer());
213 }
Abstract base class that adapts the CERN ROOT minimizer to our IMinimizer.
ROOT::Math::Minimizer root_minimizer_t

References MinimizerAdapter::rootMinimizer().

Here is the call graph for this function:

◆ rootMinimizer() [2/2]

const MinimizerAdapter::root_minimizer_t * GeneticMinimizer::rootMinimizer ( ) const
overrideprotectedvirtual

Implements MinimizerAdapter.

Definition at line 142 of file GeneticMinimizer.cpp.

143 {
144  return m_genetic_minimizer.get();
145 }

References m_genetic_minimizer.

Referenced by statusMap(), and statusToString().

◆ setMaxIterations()

void GeneticMinimizer::setMaxIterations ( int  value)

Sets maximum number of iterations to try at each step.

Definition at line 72 of file GeneticMinimizer.cpp.

73 {
74  setOptionValue("MaxIterations", value);
75 }
void setOptionValue(const std::string &optionName, T value)

References MinimizerAdapter::setOptionValue().

Referenced by GeneticMinimizerItem::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.

114 {
115  options().setOptionString(optionString);
116 }
MinimizerOptions & options()
void setOptionString(const std::string &options)
Set options from their string representation.

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

Here is the call graph for this function:

◆ setOptionValue()

◆ setParameter() [1/2]

void MinimizerAdapter::setParameter
protected

Definition at line 86 of file MinimizerAdapter.cpp.

140 {
141  bool success;
142  if (par.limits().isFixed()) {
143  success = rootMinimizer()->SetFixedVariable(index, par.name().c_str(), par.value());
144 
145  }
146 
147  else if (par.limits().isLimited()) {
148  success = rootMinimizer()->SetLimitedVariable(index, par.name().c_str(), par.value(),
149  par.step(), par.limits().lowerLimit(),
150  par.limits().upperLimit());
151  }
152 
153  else if (par.limits().isLowerLimited()) {
154  success = rootMinimizer()->SetLowerLimitedVariable(index, par.name().c_str(), par.value(),
155  par.step(), par.limits().lowerLimit());
156  }
157 
158  else if (par.limits().isUpperLimited()) {
159  success = rootMinimizer()->SetUpperLimitedVariable(index, par.name().c_str(), par.value(),
160  par.step(), par.limits().upperLimit());
161  }
162 
163  else if (par.limits().isLimitless()) {
164  success = rootMinimizer()->SetVariable(index, par.name().c_str(), par.value(), par.step());
165  }
166 
167  else {
168  throw std::runtime_error("BasicMinimizer::setParameter() -> Error! Unexpected parameter.");
169  }
170 
171  if (!success) {
172  std::ostringstream ostr;
173  ostr << "BasicMinimizer::setParameter() -> Error! Can't set minimizer's fit parameter";
174  ostr << "Index:" << index << " name '" << par.name() << "'";
175  throw std::runtime_error(ostr.str());
176  }
177 }
const root_minimizer_t * rootMinimizer() const override

◆ setParameter() [2/2]

void GeneticMinimizer::setParameter ( unsigned int  index,
const mumufit::Parameter par 
)
overrideprotectedvirtual

Reimplemented from MinimizerAdapter.

Definition at line 102 of file GeneticMinimizer.cpp.

103 {
104  if (!par.limits().isFixed() && !par.limits().isLimited()) {
105  std::ostringstream ostr;
106  ostr << "GeneticMinimizer::setParameter() -> Error! "
107  << "Genetic minimizer requires either fixed or "
108  << "limited AttLimits::limited(left,right) parameter. "
109  << " Parameter name '" << par.name() << "', limits:" << par.limits().toString();
110  throw std::runtime_error(ostr.str());
111  }
112  MinimizerAdapter::setParameter(index, par);
113 }
std::string toString() const
Definition: AttLimits.cpp:112
bool isFixed() const
Definition: AttLimits.cpp:61
bool isLimited() const
Definition: AttLimits.cpp:66
virtual void setParameter(unsigned int index, const mumufit::Parameter &par)
std::string name() const
Definition: Parameter.cpp:44
AttLimits limits() const
Definition: Parameter.cpp:54

References AttLimits::isFixed(), AttLimits::isLimited(), mumufit::Parameter::limits(), mumufit::Parameter::name(), MinimizerAdapter::setParameter(), and AttLimits::toString().

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.

77 {
78  unsigned int index(0);
79  for (const auto& par : parameters)
80  setParameter(index++, par);
81 }

References MinimizerAdapter::setParameter().

Referenced by MinimizerAdapter::minimize().

Here is the call graph for this function:

◆ setPopulationSize()

void GeneticMinimizer::setPopulationSize ( int  value)

Sets population size.

Definition at line 82 of file GeneticMinimizer.cpp.

83 {
84  setOptionValue("PopSize", value);
85 }

References MinimizerAdapter::setOptionValue().

Referenced by GeneticMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setPrintLevel()

void GeneticMinimizer::setPrintLevel ( int  value)

Sets minimizer internal print level.

Definition at line 62 of file GeneticMinimizer.cpp.

63 {
64  setOptionValue("PrintLevel", value);
65 }

References MinimizerAdapter::setOptionValue().

Here is the call graph for this function:

◆ setRandomSeed()

void GeneticMinimizer::setRandomSeed ( int  value)

Sets random seed.

Definition at line 92 of file GeneticMinimizer.cpp.

93 {
94  setOptionValue("RandomSeed", value);
95 }

References MinimizerAdapter::setOptionValue().

Referenced by GeneticMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ setTolerance()

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.

53 {
54  setOptionValue("Tolerance", value);
55 }

References MinimizerAdapter::setOptionValue().

Referenced by GeneticMinimizerItem::createMinimizer().

Here is the call graph for this function:

◆ statusMap()

std::map< std::string, std::string > GeneticMinimizer::statusMap ( ) const
overridevirtual

Returns map of string representing different minimizer statuses.

Reimplemented from MinimizerAdapter.

Definition at line 120 of file GeneticMinimizer.cpp.

121 {
122  auto result = MinimizerAdapter::statusMap();
123  result["functionCalls"] = std::to_string(rootMinimizer()->NCalls());
124  return result;
125 }
virtual std::map< std::string, std::string > statusMap() const
Returns map of string representing different minimizer statuses.

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

Here is the call graph for this function:

◆ statusToString()

std::string GeneticMinimizer::statusToString ( ) const
overridevirtual

Returns string representation of current minimizer status.

Reimplemented from MinimizerAdapter.

Definition at line 115 of file GeneticMinimizer.cpp.

116 {
117  return statusDescription()[rootMinimizer()->Status()];
118 }

References rootMinimizer().

Here is the call graph for this function:

◆ tolerance()

double GeneticMinimizer::tolerance ( ) const

Definition at line 57 of file GeneticMinimizer.cpp.

58 {
59  return optionValue<double>("Tolerance");
60 }

Referenced by propagateOptions().

Member Data Documentation

◆ m_adapter

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

◆ m_genetic_minimizer

std::unique_ptr<ROOT::Math::GeneticMinimizer> GeneticMinimizer::m_genetic_minimizer
private

Definition at line 71 of file GeneticMinimizer.h.

Referenced by propagateOptions(), and rootMinimizer().

◆ m_minimizerInfo

MinimizerInfo MinimizerAdapter::m_minimizerInfo
privateinherited

◆ m_options

◆ m_status

bool MinimizerAdapter::m_status
privateinherited

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