1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Fit/TestEngine/MinimizerTestPlan.h
//! @brief Defines 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)
//
// ************************************************************************************************
#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_FIT_TESTENGINE_MINIMIZERTESTPLAN_H
#define BORNAGAIN_FIT_TESTENGINE_MINIMIZERTESTPLAN_H
#include "Fit/Param/Parameter.h"
#include <utility>
#include <vector>
//! Defines initial settings of single fit parameter and the final value which has to be found
//! in the course of the fit.
struct ParameterReference {
const mumufit::Parameter parameter; //!< initial parameter settings
const double expected_value; //!< expected value to find in the fit
const double tolerance{0.01}; //!< tolerance on found value wrt expected value
};
namespace mumufit {
class Minimizer;
class Parameter;
class Parameters;
} // namespace mumufit
//! Defines objective function to fit, expected minimum, initial fit parameters and
//! expected values of fit parameters at minimum.
class MinimizerTestPlan {
public:
MinimizerTestPlan() = default;
explicit MinimizerTestPlan(const std::vector<ParameterReference>& parameter_references)
: m_parameter_references(parameter_references)
{
}
virtual ~MinimizerTestPlan();
void addParameter(const mumufit::Parameter& param, double expected_value,
double tolerance = 0.01);
//! Runs minimization and check minimization result.
virtual bool checkMinimizer(mumufit::Minimizer& minimizer) const = 0;
protected:
mumufit::Parameters parameters() const;
std::vector<double> expectedValues() const;
bool valuesAsExpected(const std::vector<double>& values) const;
std::vector<ParameterReference> m_parameter_references; //! initial/expected parameter values
};
#endif // BORNAGAIN_FIT_TESTENGINE_MINIMIZERTESTPLAN_H
|
