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
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Fit/Param/Parameter.h
//! @brief Defines class Parameter.
//!
//! @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)
//
// ************************************************************************************************
#ifndef BORNAGAIN_FIT_PARAM_PARAMETER_H
#define BORNAGAIN_FIT_PARAM_PARAMETER_H
#include "Fit/Param/AttLimits.h"
#include <string>
namespace mumufit {
//! A fittable parameter with value, error, step, and limits.
class Parameter {
public:
Parameter();
//! Fit parameter constructor.
//! @param name: unique name of fit parameters
//! @param value: starting value of fit parameter
//! @param limits: fit parameter limits
//! @param step: initial step of fit parameter during the minimization,
//! will be calculated automatically, if zero.
Parameter(const std::string& name, double value,
const AttLimits& limits = AttLimits::limitless(), double step = 0.0);
std::string name() const { return m_name; }
double startValue() const { return m_start_value; }
AttLimits limits() const { return m_limits; }
double value() const { return m_value; }
void setValue(double value);
double step() const { return m_step; }
double error() const { return m_error; }
void setError(double value);
private:
std::string m_name; //!< unique fit parameter name
double m_start_value; //!< starting value of fit parameters
double m_value; //!< current value of fit parameters
double m_step; //!< approximate initial step for the minimizer
double m_error; //!< error of fit parameter calculated by the minimizer
AttLimits m_limits;
};
} // namespace mumufit
#endif // BORNAGAIN_FIT_PARAM_PARAMETER_H
|
