mumufit::Minimizer Class Reference

Description

A main class to run fitting.

Definition at line 37 of file Minimizer.h.

Collaboration diagram for mumufit::Minimizer:

Public Member Functions
	Minimizer ()
	~Minimizer ()
MinimizerResult	minimize (const PyCallback &callback, const Parameters &parameters) const
	Finds minimum of user objective function (to be called from Python). More...
MinimizerResult	minimize (fcn_residual_t fcn, const Parameters &parameters) const
MinimizerResult	minimize (fcn_scalar_t fcn, const Parameters &parameters) const
void	setMinimizer (const std::string &minimizerName, const std::string &algorithmName="", const std::string &options="")
void	setMinimizer (IMinimizer *minimizer)

Private Attributes
std::unique_ptr< Kernel >	m_kernel

Constructor & Destructor Documentation

Minimizer()

Minimizer::Minimizer

(

)

Definition at line 21 of file Minimizer.cpp.

    : m_kernel(new Kernel)
{
}

~Minimizer()

Minimizer::~Minimizer ( )

default

Member Function Documentation

minimize() [1/3]

MinimizerResult Minimizer::minimize	(	const PyCallback &	callback,
		const Parameters &	parameters
	)		const

Finds minimum of user objective function (to be called from Python).

Definition at line 49 of file Minimizer.cpp.

{
    if (callback.callback_type() == PyCallback::SCALAR) {
        fcn_scalar_t fcn = [&](const Parameters& pars) { return callback.call_scalar(pars); };
        return minimize(fcn, parameters);
    } else if (callback.callback_type() == PyCallback::RESIDUAL) {
        fcn_residual_t fcn = [&](const Parameters& pars) { return callback.call_residuals(pars); };
        return minimize(fcn, parameters);
    }
 
    throw std::runtime_error("Minimizer::minimize() -> Error. Unexpected user function");
}

References PyCallback::call_residuals(), PyCallback::call_scalar(), PyCallback::callback_type(), minimize(), PyCallback::RESIDUAL, and PyCallback::SCALAR.

Here is the call graph for this function:

minimize() [2/3]

MinimizerResult Minimizer::minimize	(	fcn_residual_t	fcn,
		const Parameters &	parameters
	)		const

Definition at line 44 of file Minimizer.cpp.

{
    return m_kernel->minimize(fcn, parameters);
}

References m_kernel.

minimize() [3/3]

MinimizerResult Minimizer::minimize	(	fcn_scalar_t	fcn,
		const Parameters &	parameters
	)		const

Definition at line 39 of file Minimizer.cpp.

{
    return m_kernel->minimize(fcn, parameters);
}

References m_kernel.

Referenced by minimize().

setMinimizer() [1/2]

void Minimizer::setMinimizer	(	const std::string &	minimizerName,
		const std::string &	algorithmName = "",
		const std::string &	options = ""
	)

Definition at line 26 of file Minimizer.cpp.

{
    m_kernel->setMinimizer(minimizerName, algorithmName, options);
}

References m_kernel.

setMinimizer() [2/2]

void Minimizer::setMinimizer

(

IMinimizer *

minimizer

)

Definition at line 32 of file Minimizer.cpp.

{
    m_kernel->setMinimizer(minimizer);
}

References m_kernel.

Member Data Documentation

m_kernel

std::unique_ptr<Kernel> mumufit::Minimizer::m_kernel

private

Definition at line 57 of file Minimizer.h.

Referenced by minimize(), and setMinimizer().

---

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

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