BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
TestMinimizer.cpp
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Fit/Minimizer/TestMinimizer.cpp
6 //! @brief Implements class TrivialMinimizer.
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 
16 #include <sstream>
17 
18 using namespace Fit;
19 
21 
23 
24 std::string TestMinimizer::minimizerName() const
25 {
26  return "Test";
27 }
28 
30 {
31  // calling user function once
32  auto min_value = fcn(parameters);
33 
34  MinimizerResult result;
35  result.setParameters(parameters);
36  result.setMinValue(min_value);
37 
38  std::ostringstream report;
39  report << "TestMinimizer::printOutcome() -> Done. Objective function value = " << min_value
40  << std::endl;
41 
42  result.setReport(report.str());
43  result.setNumberOfCalls(1);
44 
45  return result;
46 }
std::function< double(const Fit::Parameters &)> fcn_scalar_t
Definition: KernelTypes.h:37
Defines class TestMinimizer.
Result of minimization round.
void setReport(const std::string &value)
void setMinValue(double value)
void setNumberOfCalls(int value)
void setParameters(const Parameters &parameters)
A collection of fit parameters.
Definition: Parameters.h:28
std::string minimizerName() const final
return name of the minimizer
~TestMinimizer() override
Fit::MinimizerResult minimize_scalar(fcn_scalar_t fcn, Fit::Parameters parameters) override
run minimization
Objective function types.
double min_value(const Iterator &begin, const Iterator &end, const Evaluator &evaluate)
Returns the minimum value of function evaluate as applied to the elements of an iterator range.
Definition: Algorithms.h:54