BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
MinimizerResultUtils.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Fit/RootAdapter/MinimizerResultUtils.h
6 //! @brief Declares MinimizerResultUtils namespace.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************** //
14 
15 #ifndef BORNAGAIN_FIT_ROOTADAPTER_MINIMIZERRESULTUTILS_H
16 #define BORNAGAIN_FIT_ROOTADAPTER_MINIMIZERRESULTUTILS_H
17 
18 #include <string>
19 
21 namespace Fit
22 {
23 class Parameters;
24 }
25 
26 //! Utility functions to generate reports
27 
29 {
30 
31 //! Reports results of minimization in the form of multi-line string
32 std::string reportToString(const RootMinimizerAdapter& minimizer);
33 
34 //! Reports fit parameters settings and final results
35 std::string reportParameters(const Fit::Parameters& parameters);
36 
37 }; // namespace MinimizerResultUtils
38 
39 #endif // BORNAGAIN_FIT_ROOTADAPTER_MINIMIZERRESULTUTILS_H
A collection of fit parameters.
Definition: Parameters.h:28
Pure virtual interface that adapts the CERN ROOT minimizer to our IMinimizer.
Objective function types.
Utility functions to generate reports.
std::string reportToString(const RootMinimizerAdapter &minimizer)
Reports results of minimization in the form of multi-line string.
std::string reportParameters(const Fit::Parameters &parameters)
Reports fit parameters settings and final results.