BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Protected Member Functions | List of all members
GSLMultiMinimizer Class Reference
Fitting internals

Wrapper for the CERN ROOT facade of the GSL multi minimizer family (gradient descent based). More...

+ Inheritance diagram for GSLMultiMinimizer:

Public Member Functions

 GSLMultiMinimizer (const std::string &algorithmName="ConjugateFR")
 
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.
 
- 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.
 
MinimizerOptions & options ()
 
const MinimizerOptions & options () const
 
bool providesError () const
 Returns true if minimizer provides error and error matrix.
 
virtual std::map< std::string, std::string > statusMap () const
 Returns map of string representing different minimizer statuses.
 
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
 
IMinimizer & operator= (const IMinimizer &other)=delete
 
virtual void clear ()
 clear resources (parameters) for consecutives minimizations
 
virtual bool requiresResiduals ()
 Returns true if minimizer computations are residual-based, false otherwise.
 

Protected Member Functions

void propagateOptions () override
 
const root_minimizer_t * rootMinimizer () const 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.
 
virtual void setParameter (unsigned int index, const Fit::Parameter &par)
 
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 >
T optionValue (const std::string &optionName) const
 

Additional Inherited Members

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

Detailed Description

Wrapper for the CERN ROOT facade of the GSL multi minimizer family (gradient descent based).

Definition at line 31 of file GSLMultiMinimizer.h.

Member Function Documentation

◆ setMaxIterations()

void GSLMultiMinimizer::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 51 of file GSLMultiMinimizer.cpp.

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