MinimizerTestPlan Class Reference

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

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

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::string	m_name
	plan name More...
std::vector< ParameterPlan >	m_parameter_plan

Detailed Description

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

Definition at line 35 of file MinimizerTestPlan.h.

Constructor & Destructor Documentation

MinimizerTestPlan()

MinimizerTestPlan::MinimizerTestPlan

(

const std::string &

name

)

Definition at line 38 of file MinimizerTestPlan.cpp.

: m_name(name) {}

~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 42 of file MinimizerTestPlan.cpp.

{
    m_parameter_plan.push_back(ParameterPlan(param, expected_value, tolerance));
}

References m_parameter_plan.

checkMinimizer()

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

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 61 of file MinimizerTestPlan.cpp.

{
    std::vector<double> result;
    for (const auto& plan : m_parameter_plan)
        result.push_back(plan.expectedValue());
 
    return result;
}

References m_parameter_plan.

name()

std::string MinimizerTestPlan::name ( ) const

inline

Definition at line 44 of file MinimizerTestPlan.h.

{ return m_name; }

References m_name.

parameters()

Parameters MinimizerTestPlan::parameters ( ) const

protected

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

Definition at line 50 of file MinimizerTestPlan.cpp.

{
    Parameters result;
    for (const auto& plan : m_parameter_plan)
        result.add(plan.fitParameter());
 
    return result;
}

References mumufit::Parameters::add(), and m_parameter_plan.

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 72 of file MinimizerTestPlan.cpp.

{
    bool success(true);
 
    if (m_parameter_plan.size() != values.size())
        throw std::runtime_error("FunctionTestPlan::valuesAsExpected() -> Error. Sizes differ.");
 
    size_t index(0);
    std::ostringstream text;
    for (const auto& plan : m_parameter_plan) {
        double diff = relativeDifference(values[index], plan.expectedValue());
 
        bool diff_ok(true);
        if (diff > plan.tolerance())
            diff_ok = false;
 
        text << plan.fitParameter().name() << " found:" << values[index]
             << " expected:" << plan.expectedValue() << " diff:" << diff << " "
             << (diff_ok ? "OK" : "FAILED") << "\n";
 
        success &= diff_ok;
 
        ++index;
    }
 
    std::cout << text.str();
 
    return success;
}

References m_parameter_plan.

Member Data Documentation

m_name

std::string MinimizerTestPlan::m_name

protected

plan name

Definition at line 54 of file MinimizerTestPlan.h.

Referenced by name().

m_parameter_plan

std::vector<ParameterPlan> MinimizerTestPlan::m_parameter_plan

protected

Definition at line 55 of file MinimizerTestPlan.h.

Referenced by addParameter(), expectedValues(), parameters(), and valuesAsExpected().

---

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

• /home/www/ba/Fit/TestEngine/MinimizerTestPlan.h
• /home/www/ba/Fit/TestEngine/MinimizerTestPlan.cpp