MinimizerTestPlan Class Reference

Description

Defines objective function to fit, expected minimum, initial fit parameters and expected values of fit parameters at minimum.

Definition at line 47 of file MinimizerTestPlan.h.

Collaboration diagram for MinimizerTestPlan:

Public Member Functions
	MinimizerTestPlan ()=default
	MinimizerTestPlan (std::vector< ParameterReference > parameter_references)
virtual	~MinimizerTestPlan ()
void	addParameter (const mumufit::Parameter &param, double expected_value, double tolerance=0.01)
virtual bool	checkMinimizer (mumufit::Minimizer &minimizer) const =0
	Runs minimization and check minimization result. More...

Protected Member Functions
std::vector< double >	expectedValues () const
	Return vector of expected parameter values. More...
mumufit::Parameters	parameters () const
	Returns fit parameters which will be used as initial one for the minimization. More...
bool	valuesAsExpected (const std::vector< double > &values) const
	Returns true if given values coincide with expected fit parameter values. More...

Protected Attributes
std::vector< ParameterReference >	m_parameter_references

Constructor & Destructor Documentation

MinimizerTestPlan() [1/2]

MinimizerTestPlan::MinimizerTestPlan ( )

default

MinimizerTestPlan() [2/2]

MinimizerTestPlan::MinimizerTestPlan ( std::vector< ParameterReference >  parameter_references )

inlineexplicit

Definition at line 50 of file MinimizerTestPlan.h.

        : m_parameter_references(std::move(parameter_references))
    {
    }

~MinimizerTestPlan()

MinimizerTestPlan::~MinimizerTestPlan ( )

virtualdefault

Member Function Documentation

addParameter()

void MinimizerTestPlan::addParameter	(	const mumufit::Parameter &	param,
		double	expected_value,
		double	tolerance = 0.01
	)

Definition at line 40 of file MinimizerTestPlan.cpp.

{
    m_parameter_references.push_back({param, expected_value, tolerance});
}

checkMinimizer()

virtual bool MinimizerTestPlan::checkMinimizer ( mumufit::Minimizer &  minimizer ) const

pure virtual

Runs minimization and check minimization result.

expectedValues()

std::vector< double > MinimizerTestPlan::expectedValues ( ) const

protected

Return vector of expected parameter values.

Definition at line 59 of file MinimizerTestPlan.cpp.

{
    std::vector<double> result;
    for (const ParameterReference& ref : m_parameter_references)
        result.push_back(ref.expected_value);
 
    return result;
}

parameters()

Parameters MinimizerTestPlan::parameters ( ) const

protected

Returns fit parameters which will be used as initial one for the minimization.

Definition at line 48 of file MinimizerTestPlan.cpp.

{
    Parameters result;
    for (const auto& ref : m_parameter_references)
        result.add(ref.parameter);
 
    return result;
}

References mumufit::Parameters::add().

Here is the call graph for this function:

valuesAsExpected()

bool MinimizerTestPlan::valuesAsExpected ( const std::vector< double > &  values ) const

protected

Returns true if given values coincide with expected fit parameter values.

Definition at line 70 of file MinimizerTestPlan.cpp.

{
    bool success = true;
 
    if (m_parameter_references.size() != values.size())
        throw std::runtime_error("FunctionTestPlan::valuesAsExpected() -> Error. Sizes differ.");
 
    for (size_t i = 0; i < values.size(); ++i) {
        const ParameterReference& ref = m_parameter_references[i];
        double diff = relativeDifference(values[i], ref.expected_value);
 
        bool ok = diff <= ref.tolerance;
 
        std::cout << ref.parameter.name() << " found:" << values[i]
                  << " expected:" << ref.expected_value << " diff:" << diff << " "
                  << (ok ? "OK" : "FAILED") << std::endl;
 
        success &= ok;
    }
 
    return success;
}

References ParameterReference::expected_value, mumufit::Parameter::name(), ParameterReference::parameter, Numeric::relativeDifference(), and ParameterReference::tolerance.

Here is the call graph for this function:

Member Data Documentation

m_parameter_references

std::vector<ParameterReference> MinimizerTestPlan::m_parameter_references

protected

Definition at line 68 of file MinimizerTestPlan.h.

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/TestEngine/MinimizerTestPlan.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/TestEngine/MinimizerTestPlan.cpp