MinimizerResultUtils.cpp

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Fit/RootAdapter/MinimizerResultUtils.cpp
//! @brief     Implements MinimizerResultUtils namespace.
//!
//! @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/RootAdapter/MinimizerResultUtils.h"
#include "Fit/RootAdapter/RootMinimizerAdapter.h"
#include "Fit/Tools/MinimizerUtils.h"
#include <boost/format.hpp>
#include <iomanip>
#include <sstream>
 
using namespace Fit;
 
namespace
{
 
const int column_width = 18;
 
template <typename T> std::string reportValue(const std::string& name, T value)
{
    std::ostringstream result;
    result << std::setw(column_width) << std::left << name << ": " << value << std::endl;
    return result.str();
}
 
std::string reportDescription(const RootMinimizerAdapter& minimizer);
std::string reportOption(const RootMinimizerAdapter& minimizer);
std::string reportStatus(const RootMinimizerAdapter& minimizer);
 
} // namespace
 
std::string MinimizerResultUtils::reportToString(const RootMinimizerAdapter& minimizer)
{
    std::ostringstream result;
 
    result << MinimizerUtils::sectionString();
    result << reportDescription(minimizer);
    result << reportOption(minimizer);
    result << reportStatus(minimizer);
 
    return result.str();
}
 
std::string MinimizerResultUtils::reportParameters(const Fit::Parameters& parameters)
{
    std::ostringstream result;
 
    result << MinimizerUtils::sectionString("FitParameters");
 
    result << "Name                       StartValue  Limits                        FitValue"
           << "     Error" << std::endl;
 
    for (const auto& par : parameters) {
        result << boost::format("%-26.26s %-8.3e   %-28s  %-8.3e    %8.3e \n") % par.name()
                      % par.startValue() % par.limits().toString() % par.value() % par.error();
    }
 
    Fit::Parameters::corr_matrix_t matrix = parameters.correlationMatrix();
    if (!matrix.empty()) {
        result << MinimizerUtils::sectionString("Correlations");
        for (size_t i = 0; i < matrix.size(); ++i) {
            result << boost::format("#%-2d       ") % i;
            for (size_t j = 0; j < matrix[i].size(); ++j)
                result << boost::format("%_7.4f    ") % matrix[i][j];
            result << std::endl;
        }
    }
 
    return result.str();
}
 
namespace
{
 
std::string reportDescription(const RootMinimizerAdapter& minimizer)
{
    std::ostringstream result;
    result << reportValue("MinimizerType", minimizer.minimizerName());
    result << reportValue("AlgorithmName", minimizer.algorithmName());
    return result.str();
}
 
std::string reportOption(const RootMinimizerAdapter& minimizer)
{
    if (minimizer.options().empty())
        return "";
 
    std::ostringstream result;
    result << MinimizerUtils::sectionString("Options");
    for (auto option : minimizer.options()) {
        std::ostringstream opt;
        opt << std::setw(5) << std::left << option->value() << option->description();
        result << reportValue(option->name(), opt.str());
    }
    result << MinimizerUtils::sectionString("OptionString");
    result << minimizer.options().toOptionString() << std::endl;
 
    return result.str();
}
 
std::string reportStatus(const RootMinimizerAdapter& minimizer)
{
    std::ostringstream result;
    result << MinimizerUtils::sectionString("Status");
 
    auto status = minimizer.statusMap();
    for (auto it : status)
        result << reportValue(it.first, it.second);
 
    return result.str();
}
 
} // namespace