IMinimizer Class Reference

Description

Abstract base class for all kind minimizers.

Definition at line 30 of file IMinimizer.h.

Inheritance diagram for IMinimizer:

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...
IMinimizer &	operator= (const IMinimizer &other)=delete
virtual bool	requiresResiduals ()
	Returns true if minimizer computations are residual-based, false otherwise. More...
virtual void	setOptions (const std::string &options)
	Sets option string to the minimizer. More...

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

algorithmName()

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

pure virtual

Return name of the minimization algorithm.

Implemented in MinimizerAdapter.

clear()

virtual void IMinimizer::clear ( )

inlinevirtual

Clears resources (parameters) for consecutives minimizations.

Definition at line 50 of file IMinimizer.h.

{}

minimize_residual()

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

virtual

Runs minimization.

Reimplemented in MinimizerAdapter.

Definition at line 26 of file IMinimizer.cpp.

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

minimize_scalar()

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

virtual

Runs minimization.

Reimplemented in MinimizerAdapter.

Definition at line 21 of file IMinimizer.cpp.

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

minimizerName()

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

pure virtual

Returns name of the minimizer.

Implemented in MinimizerAdapter.

minValue()

double IMinimizer::minValue ( ) const

virtual

Returns minimum function value.

Reimplemented in MinimizerAdapter.

Definition at line 31 of file IMinimizer.cpp.

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

operator=()

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

delete

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.

{ return false; }

setOptions()

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

virtual

Sets option string to the minimizer.

Reimplemented in MinimizerAdapter.

Definition at line 36 of file IMinimizer.cpp.

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

Referenced by MinimizerFactory::createMinimizer().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Minimizer/IMinimizer.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Minimizer/IMinimizer.cpp