BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
VarianceFunctions.cpp
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Core/Residual/VarianceFunctions.cpp
6 //! @brief Implements IVarianceFunction classes
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 <algorithm>
17 
18 // ************************************************************************************************
19 // class VarianceConstantFunction
20 // ************************************************************************************************
21 
23 {
24  return new VarianceConstantFunction();
25 }
26 
27 double VarianceConstantFunction::variance(double, double) const
28 {
29  return 1.0;
30 }
31 
32 // ************************************************************************************************
33 // class VarianceSimFunction
34 // ************************************************************************************************
35 
36 VarianceSimFunction::VarianceSimFunction(double epsilon) : m_epsilon(epsilon) {}
37 
39 {
40  return new VarianceSimFunction(m_epsilon);
41 }
42 
43 double VarianceSimFunction::variance(double /*exp*/, double sim) const
44 {
45  return std::max(sim, m_epsilon);
46 }
Defines IVarianceFunction classes.
Returns 1.0 as variance value.
double variance(double, double) const override
VarianceConstantFunction * clone() const override
Returns max(sim, epsilon)
double variance(double exp, double sim) const override
VarianceSimFunction * clone() const override
VarianceSimFunction(double epsilon=1.0)