BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
GSLLevenbergMarquardtMinimizer Class Reference

It's a facade to ROOT::Math::GSLNLSMinimizer which, in turn, is a facade to the actual GSL's gsl_multifit_fdfsolver_type (http://www.gnu.org/software/gsl/manual/html_node/Nonlinear-Least_002dSquares-Fitting.html). More...

+ Inheritance diagram for GSLLevenbergMarquardtMinimizer:

Public Member Functions

void setTolerance (double value)
 Sets tolerance on the function value at the minimum.
 
double tolerance () const
 
void setPrintLevel (int value)
 Sets minimizer internal print level.
 
int printLevel () const
 
void setMaxIterations (int value)
 Sets maximum number of iterations. More...
 
int maxIterations () const
 
std::string statusToString () const override
 Returns string representation of current minimizer status.
 
std::map< std::string, std::string > statusMap () const override
 Returns map of string representing different minimizer statuses.
 
bool requiresResiduals () override
 Returns true if minimizer computations are residual-based, false otherwise.
 
- Public Member Functions inherited from RootMinimizerAdapter
Fit::MinimizerResult minimize_scalar (fcn_scalar_t fcn, Fit::Parameters parameters) override
 run minimization
 
Fit::MinimizerResult minimize_residual (fcn_residual_t fcn, Fit::Parameters parameters) override
 
std::string minimizerName () const override final
 Returns name of the minimizer.
 
std::string algorithmName () const override final
 Returns name of the minimization algorithm.
 
void setParameters (const Fit::Parameters &parameters)
 
double minValue () const override final
 Returns minimum function value.
 
MinimizerOptionsoptions ()
 
const MinimizerOptionsoptions () const
 
bool providesError () const
 Returns true if minimizer provides error and error matrix.
 
void setOptions (const std::string &optionString) override final
 Sets option string to the minimizer.
 
- Public Member Functions inherited from IMinimizer
 IMinimizer (const IMinimizer &other)=delete
 
IMinimizeroperator= (const IMinimizer &other)=delete
 
virtual void clear ()
 clear resources (parameters) for consecutives minimizations
 

Protected Member Functions

void propagateOptions () override
 
const root_minimizer_t * rootMinimizer () const override
 
void setParameter (unsigned int index, const Fit::Parameter &par) override
 
- Protected Member Functions inherited from RootMinimizerAdapter
 RootMinimizerAdapter (const MinimizerInfo &minimizerInfo)
 
Fit::MinimizerResult minimize (Fit::Parameters parameters)
 
void propagateResults (Fit::Parameters &parameters)
 Propagates results of minimization to fit parameter set.
 
size_t fitDimension () const
 Returns number of fit parameters defined (i.e. dimension of the function to be minimized).
 
std::vector< double > parValuesAtMinimum () const
 Returns value of the variables at minimum.
 
std::vector< double > parErrorsAtMinimum () const
 Returns errors of the variables at minimum.
 
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 >
optionValue (const std::string &optionName) const
 

Additional Inherited Members

- Public Types inherited from RootMinimizerAdapter
typedef ROOT::Math::Minimizer root_minimizer_t
 

Detailed Description

It's a facade to ROOT::Math::GSLNLSMinimizer which, in turn, is a facade to the actual GSL's gsl_multifit_fdfsolver_type (http://www.gnu.org/software/gsl/manual/html_node/Nonlinear-Least_002dSquares-Fitting.html).

Definition at line 33 of file GSLLevenbergMarquardtMinimizer.h.

Member Function Documentation

◆ setMaxIterations()

void GSLLevenbergMarquardtMinimizer::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 78 of file GSLLevenbergMarquardtMinimizer.cpp.


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