BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
IMinimizer Class Referenceabstract
Inheritance diagram for IMinimizer:
Collaboration diagram for IMinimizer:

Public Member Functions

 IMinimizer ()
 
virtual ~IMinimizer ()
 
 IMinimizer (const IMinimizer &other)=delete
 
IMinimizeroperator= (const IMinimizer &other)=delete
 
virtual std::string minimizerName () const =0
 
virtual std::string algorithmName () const =0
 
virtual Fit::MinimizerResult minimize_scalar (fcn_scalar_t, Fit::Parameters)
 
virtual Fit::MinimizerResult minimize_residual (fcn_residual_t, Fit::Parameters)
 
virtual void clear ()
 
virtual double minValue () const
 
virtual void setOptions (const std::string &options)
 
virtual bool requiresResiduals ()
 

Detailed Description

Pure virtual interface for all kind minimizers.

Definition at line 30 of file IMinimizer.h.

Constructor & Destructor Documentation

◆ IMinimizer() [1/2]

IMinimizer::IMinimizer ( )
default

◆ ~IMinimizer()

IMinimizer::~IMinimizer ( )
virtualdefault

◆ IMinimizer() [2/2]

IMinimizer::IMinimizer ( const IMinimizer other)
delete

Member Function Documentation

◆ operator=()

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

◆ minimizerName()

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

return name of the minimizer

Implemented in RootMinimizerAdapter, and TestMinimizer.

◆ algorithmName()

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

return name of the minimization algorithm

Implemented in RootMinimizerAdapter, and TestMinimizer.

◆ minimize_scalar()

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

run minimization

Reimplemented in RootMinimizerAdapter, and TestMinimizer.

Definition at line 21 of file IMinimizer.cpp.

22 {
23  throw std::runtime_error("IMinimizer::minimize_scalar() -> Not implemented.");
24 }

◆ minimize_residual()

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

Reimplemented in RootMinimizerAdapter.

Definition at line 26 of file IMinimizer.cpp.

27 {
28  throw std::runtime_error("IMinimizer::minimize_residual() -> Not implemented.");
29 }

◆ clear()

virtual void IMinimizer::clear ( )
inlinevirtual

clear resources (parameters) for consecutives minimizations

Definition at line 50 of file IMinimizer.h.

50 {}

◆ minValue()

double IMinimizer::minValue ( ) const
virtual

Returns minimum function value.

Reimplemented in RootMinimizerAdapter.

Definition at line 31 of file IMinimizer.cpp.

32 {
33  throw std::runtime_error("IMinimizer::minValue() -> Not implemented.");
34 }

◆ setOptions()

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

Sets option string to the minimizer.

Reimplemented in RootMinimizerAdapter.

Definition at line 36 of file IMinimizer.cpp.

37 {
38  throw std::runtime_error("IMinimizer::setOptions() -> Not implemented.");
39 }

Referenced by MinimizerFactory::createMinimizer().

◆ requiresResiduals()

virtual bool IMinimizer::requiresResiduals ( )
inlinevirtual

Returns true if minimizer computations are residual-based, false otherwise.

Reimplemented in Minuit2Minimizer, and GSLLevenbergMarquardtMinimizer.

Definition at line 60 of file IMinimizer.h.

60 { return false; }

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