MinimizerTestPlan.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/TestEngine/MinimizerTestPlan.cpp
//! @brief     Implements class MinimizerTestPlan
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "Fit/TestEngine/MinimizerTestPlan.h"
#include "Fit/Param/Parameters.h"
#include <cmath>
#include <iostream>
#include <sstream>
 
namespace {
 
//! Returns the safe relative difference, which is 2(|a-b|)/(|a|+|b|) except in special cases.
double relativeDifference(double a, double b)
{
    constexpr double eps = std::numeric_limits<double>::epsilon();
    const double avg_abs = (std::abs(a) + std::abs(b)) / 2.0;
    // return 0.0 if relative error smaller than epsilon
    if (std::abs(a - b) <= eps * avg_abs)
        return 0.0;
    return std::abs(a - b) / avg_abs;
}
 
} // namespace
 
using namespace mumufit;
 
MinimizerTestPlan::MinimizerTestPlan(const std::string& name) : m_name(name) {}
 
MinimizerTestPlan::~MinimizerTestPlan() = default;
 
void MinimizerTestPlan::addParameter(const Parameter& param, double expected_value,
                                     double tolerance)
{
    m_parameter_plan.push_back(ParameterPlan(param, expected_value, tolerance));
}
 
//! Returns fit parameters which will be used as initial one for the minimization.
 
Parameters MinimizerTestPlan::parameters() const
{
    Parameters result;
    for (const auto& plan : m_parameter_plan)
        result.add(plan.fitParameter());
 
    return result;
}
 
//! Return vector of expected parameter values.
 
std::vector<double> MinimizerTestPlan::expectedValues() const
{
    std::vector<double> result;
    for (const auto& plan : m_parameter_plan)
        result.push_back(plan.expectedValue());
 
    return result;
}
 
//! Returns true if given values coincide with expected fit parameter values.
 
bool MinimizerTestPlan::valuesAsExpected(const std::vector<double>& values) const
{
    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;
}