From 8b1f36d69a444c3283c002cf36bb7045c0c6de92 Mon Sep 17 00:00:00 2001 From: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Date: Thu, 8 Jun 2023 16:09:33 +0000 Subject: [PATCH] Documentation for c876e50a7b6cb5b29b6d0f88f55f56ca9c6e0e3c --- d0/d6f/namespaceothers.html | 100 ++++- d0/d6f/namespaceothers.js | 5 + d2/df0/kelvin__to__celsius_8cpp__incl.map | 6 + d2/df0/kelvin__to__celsius_8cpp__incl.md5 | 1 + d2/df0/kelvin__to__celsius_8cpp__incl.svg | 66 +++ d5/d88/md__d_i_r_e_c_t_o_r_y.html | 1 + db/d6b/kelvin__to__celsius_8cpp.html | 241 ++++++++++ db/d6b/kelvin__to__celsius_8cpp.js | 7 + ...83bb8ccf42aaf7375a83e91490eda1e_cgraph.map | 5 + ...83bb8ccf42aaf7375a83e91490eda1e_cgraph.md5 | 1 + ...83bb8ccf42aaf7375a83e91490eda1e_cgraph.svg | 52 +++ ...66f6b31b5ad750f1fe042a706a4e3d4_cgraph.map | 6 + ...66f6b31b5ad750f1fe042a706a4e3d4_cgraph.md5 | 1 + ...66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg | 67 +++ dir_9510827d0b234b3cc54b29892f217477.html | 3 + dir_9510827d0b234b3cc54b29892f217477.js | 1 + files.html | 29 +- globals_func_m.html | 2 +- globals_func_s.html | 2 +- globals_func_t.html | 2 +- globals_m.html | 2 +- globals_p.html | 2 +- globals_s.html | 2 +- globals_t.html | 2 +- namespacemembers.html | 2 + namespacemembers_func.html | 2 + namespaces_dup.js | 2 +- navtreedata.js | 23 +- navtreeindex0.js | 52 +-- navtreeindex1.js | 26 +- navtreeindex10.js | 40 +- navtreeindex11.js | 64 +-- navtreeindex12.js | 28 +- navtreeindex13.js | 22 +- navtreeindex14.js | 6 + navtreeindex2.js | 44 +- navtreeindex3.js | 12 +- navtreeindex4.js | 32 +- navtreeindex5.js | 24 +- navtreeindex6.js | 36 +- navtreeindex7.js | 68 +-- navtreeindex8.js | 26 +- navtreeindex9.js | 22 +- search/all_11.js | 4 +- search/all_14.js | 4 +- search/all_15.js | 6 +- search/all_2.js | 139 +++--- search/all_a.js | 424 +++++++++--------- search/all_c.js | 38 +- search/all_e.js | 265 +++++------ search/files_b.js | 9 +- search/functions_1.js | 103 ++--- search/functions_13.js | 4 +- search/functions_14.js | 8 +- search/functions_9.js | 4 +- search/functions_b.js | 19 +- search/functions_d.js | 2 +- 57 files changed, 1374 insertions(+), 792 deletions(-) create mode 100644 d0/d6f/namespaceothers.js create mode 100644 d2/df0/kelvin__to__celsius_8cpp__incl.map create mode 100644 d2/df0/kelvin__to__celsius_8cpp__incl.md5 create mode 100644 d2/df0/kelvin__to__celsius_8cpp__incl.svg create mode 100644 db/d6b/kelvin__to__celsius_8cpp.html create mode 100644 db/d6b/kelvin__to__celsius_8cpp.js create mode 100644 db/d6b/kelvin__to__celsius_8cpp_a483bb8ccf42aaf7375a83e91490eda1e_cgraph.map create mode 100644 db/d6b/kelvin__to__celsius_8cpp_a483bb8ccf42aaf7375a83e91490eda1e_cgraph.md5 create mode 100644 db/d6b/kelvin__to__celsius_8cpp_a483bb8ccf42aaf7375a83e91490eda1e_cgraph.svg create mode 100644 db/d6b/kelvin__to__celsius_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.map create mode 100644 db/d6b/kelvin__to__celsius_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.md5 create mode 100644 db/d6b/kelvin__to__celsius_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg create mode 100644 navtreeindex14.js diff --git a/d0/d6f/namespaceothers.html b/d0/d6f/namespaceothers.html index 1b0bc61d0..e92e95aae 100644 --- a/d0/d6f/namespaceothers.html +++ b/d0/d6f/namespaceothers.html @@ -97,12 +97,24 @@ $(document).ready(function(){initNavTree('d0/d6f/namespaceothers.html','../../')
+
+Functions
others Namespace Reference

for vector More...

+ + + + + + + + +

+Functions

bool are_almost_equal (double a, double b, double absolute_tolerance=0.0001)
 Compare two floating point numbers with a certain tolerance. This is needed as with some values, the result (e.g.: -196.15) might be a bit lower (in this case, -196.499999...).
 
double kelvin_to_celsius (double temperature_in_k)
 Conversion from Kelvin to Celsius algorithm.
 

Detailed Description

for vector

for vector

@@ -114,7 +126,93 @@ $(document).ready(function(){initNavTree('d0/d6f/namespaceothers.html','../../')

Other algorithms

for assert for I/O operations

Other algorithms

-
+

Function Documentation

+ +

◆ are_almost_equal()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool others::are_almost_equal (double a,
double b,
double absolute_tolerance = 0.0001 
)
+
+ +

Compare two floating point numbers with a certain tolerance. This is needed as with some values, the result (e.g.: -196.15) might be a bit lower (in this case, -196.499999...).

+
Parameters
+ + + + +
athe first number to compare
bthe second number to compare
tolerancethe tolerance to use when comparing the numbers
+
+
+
Returns
true if the numbers ARE equal within the given tolerance
+
+false if the numbers are NOT equal within the given tolerance otherwise
+
40 {
+
41 return std::abs(a - b) < absolute_tolerance;
+
42}
+
+
+
+ +

◆ kelvin_to_celsius()

+ +
+
+ + + + + + + + +
double others::kelvin_to_celsius (double temperature_in_k)
+
+ +

Conversion from Kelvin to Celsius algorithm.

+
Parameters
+ + +
numberthe Celsius number that will be used to convert
+
+
+
Returns
the Kelvin number converted to Celsius
+
49 {
+
50 const double absolute_zero_in_c = -273.15;
+
51 if (temperature_in_k < absolute_zero_in_c) {
+
52 throw std::invalid_argument("input temperature below absolute zero");
+
53 }
+
54 return temperature_in_k + absolute_zero_in_c;
+
55}
+ +
+
+
+