BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
IMinimizer Class Referenceabstract

Description

Abstract base class for all kind minimizers.

Public Member Functions

 IMinimizer ()
 
 IMinimizer (const IMinimizer &other)=delete
 
virtual ~IMinimizer ()
 
virtual std::string algorithmName () const =0
 Return name of the minimization algorithm. More...
 
virtual void clear ()
 Clears resources (parameters) for consecutives minimizations. More...
 
virtual mumufit::MinimizerResult minimize_residual (fcn_residual_t, mumufit::Parameters)
 Runs minimization. More...
 
virtual mumufit::MinimizerResult minimize_scalar (fcn_scalar_t, mumufit::Parameters)
 Runs minimization. More...
 
virtual std::string minimizerName () const =0
 Returns name of the minimizer. More...
 
virtual double minValue () const
 Returns minimum function value. More...
 
IMinimizeroperator= (const IMinimizer &other)=delete
 
virtual void setOptions (const std::string &options)
 Sets option string to the minimizer. More...
 

Constructor & Destructor Documentation

◆ IMinimizer() [1/2]

IMinimizer::IMinimizer ( )

◆ ~IMinimizer()

virtual IMinimizer::~IMinimizer ( )
virtual

◆ IMinimizer() [2/2]

IMinimizer::IMinimizer ( const IMinimizer other)
delete

Member Function Documentation

◆ algorithmName()

virtual std::string IMinimizer::algorithmName ( ) const
pure virtual

Return name of the minimization algorithm.

◆ clear()

virtual void IMinimizer::clear ( )
virtual

Clears resources (parameters) for consecutives minimizations.

◆ minimize_residual()

virtual mumufit::MinimizerResult IMinimizer::minimize_residual ( fcn_residual_t  ,
mumufit::Parameters   
)
virtual

Runs minimization.

◆ minimize_scalar()

virtual mumufit::MinimizerResult IMinimizer::minimize_scalar ( fcn_scalar_t  ,
mumufit::Parameters   
)
virtual

Runs minimization.

◆ minimizerName()

virtual std::string IMinimizer::minimizerName ( ) const
pure virtual

Returns name of the minimizer.

◆ minValue()

virtual double IMinimizer::minValue ( ) const
virtual

Returns minimum function value.

◆ operator=()

IMinimizer& IMinimizer::operator= ( const IMinimizer other)
delete

◆ setOptions()

virtual void IMinimizer::setOptions ( const std::string &  options)
virtual

Sets option string to the minimizer.