BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Numeric.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Fit/TestEngine/Numeric.h
6 //! @brief Defines constants and "almost equal" in namespace Numeric.
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_TESTENGINE_NUMERIC_H
16 #define BORNAGAIN_FIT_TESTENGINE_NUMERIC_H
17 
18 #include <limits>
19 
20 //! Floating-point epsilon, tolerances, almost-equal.
21 
22 namespace Numeric
23 {
24 
25 double GetAbsoluteDifference(double a, double b);
26 
27 double GetRelativeDifference(double a, double b);
28 
29 double GetLogDifference(double a, double b);
30 
31 } // namespace Numeric
32 
33 #endif // BORNAGAIN_FIT_TESTENGINE_NUMERIC_H
Floating-point epsilon, tolerances, almost-equal.
Definition: Numeric.cpp:23
double GetRelativeDifference(double a, double b)
Returns the safe relative difference, which is 2(|a-b|)/(|a|+|b|) except in special cases.
Definition: Numeric.cpp:32
double GetAbsoluteDifference(double a, double b)
Returns the absolute value of the difference between a and b.
Definition: Numeric.cpp:26
double GetLogDifference(double a, double b)
Returns the difference of the logarithm; input values are truncated at the minimum positive value.
Definition: Numeric.cpp:44