Fit::Kernel Class Reference

Collaboration diagram for Fit::Kernel:

Public Member Functions
	Kernel ()
	~Kernel ()
void	setMinimizer (const std::string &minimizerName, const std::string &algorithmName="", const std::string &options="")
void	setMinimizer (IMinimizer *minimizer)
MinimizerResult	minimize (fcn_scalar_t fcn, const Parameters &parameters)
MinimizerResult	minimize (fcn_residual_t fcn, const Parameters &parameters)

Private Member Functions
void	setParameters (const Parameters &parameters)

Private Attributes
Parameters	m_parameters
std::unique_ptr< IMinimizer >	m_minimizer
WallclockTimer	m_timer

Detailed Description

A main class to run fitting.

Definition at line 33 of file Kernel.h.

Constructor & Destructor Documentation

Kernel()

Kernel::Kernel

(

)

Definition at line 27 of file Kernel.cpp.

{
    setMinimizer(default_minimizer, default_algorithm);
}

References anonymous_namespace{Kernel.cpp}::default_algorithm, anonymous_namespace{Kernel.cpp}::default_minimizer, and setMinimizer().

Here is the call graph for this function:

~Kernel()

Kernel::~Kernel ( )

default

Member Function Documentation

setMinimizer() [1/2]

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

Definition at line 34 of file Kernel.cpp.

{
    m_minimizer.reset(MinimizerFactory::createMinimizer(minimizerName, algorithmName, options));
}

References MinimizerFactory::createMinimizer(), and m_minimizer.

Referenced by Kernel().

Here is the call graph for this function:

setMinimizer() [2/2]

void Kernel::setMinimizer

(

IMinimizer *

minimizer

)

Definition at line 40 of file Kernel.cpp.

{
    m_minimizer.reset(minimizer);
}

References m_minimizer.

minimize() [1/2]

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

Definition at line 45 of file Kernel.cpp.

{
    setParameters(parameters);
 
    m_timer.start();
    if (m_minimizer->requiresResiduals())
        throw std::runtime_error(
            "Error in Kernel::minimize: the chosen minimizer requires residuals computation. "
            "Please use FitObjective::evaluate_residuals with this minimizer.");
    auto result = m_minimizer->minimize_scalar(fcn, parameters);
    m_timer.stop();
 
    result.setDuration(m_timer.runTime());
    return result;
}

References m_minimizer, m_timer, WallclockTimer::runTime(), setParameters(), WallclockTimer::start(), and WallclockTimer::stop().

Here is the call graph for this function:

minimize() [2/2]

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

Definition at line 61 of file Kernel.cpp.

{
    setParameters(parameters);
 
    m_timer.start();
    auto result = m_minimizer->minimize_residual(fcn, parameters);
    m_timer.stop();
 
    result.setDuration(m_timer.runTime());
    return result;
}

References m_minimizer, m_timer, WallclockTimer::runTime(), setParameters(), WallclockTimer::start(), and WallclockTimer::stop().

Here is the call graph for this function:

setParameters()

void Kernel::setParameters ( const Parameters &  parameters )

private

Definition at line 73 of file Kernel.cpp.

{
    m_parameters = parameters;
}

References m_parameters.

Referenced by minimize().

Member Data Documentation

m_parameters

Parameters Fit::Kernel::m_parameters

private

Definition at line 50 of file Kernel.h.

Referenced by setParameters().

m_minimizer

std::unique_ptr<IMinimizer> Fit::Kernel::m_minimizer

private

Definition at line 51 of file Kernel.h.

Referenced by minimize(), and setMinimizer().

m_timer

WallclockTimer Fit::Kernel::m_timer

private

Definition at line 52 of file Kernel.h.

Referenced by minimize().

---

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

• /home/www/ba/Fit/Kernel/Kernel.h
• /home/www/ba/Fit/Kernel/Kernel.cpp