about summary refs log tree commit diff
path: root/src/docs/float_cmp.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 20:34:47 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:51:52 +0100
commit46c5a5d234f13dcf4bb4cf4241b2addedbf0be14 (patch)
tree56726625e55224ecb09ed11f509a964507b9c333 /src/docs/float_cmp.txt
parent3597ed5a099488aa77caf444106a0550b7e5d2e8 (diff)
downloadrust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.tar.gz
rust-46c5a5d234f13dcf4bb4cf4241b2addedbf0be14.zip
Merge commit 'f4850f7292efa33759b4f7f9b7621268979e9914' into clippyup
Diffstat (limited to 'src/docs/float_cmp.txt')
-rw-r--r--src/docs/float_cmp.txt28
1 files changed, 0 insertions, 28 deletions
diff --git a/src/docs/float_cmp.txt b/src/docs/float_cmp.txt
deleted file mode 100644
index c19907c903e..00000000000
--- a/src/docs/float_cmp.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-### What it does
-Checks for (in-)equality comparisons on floating-point
-values (apart from zero), except in functions called `*eq*` (which probably
-implement equality for a type involving floats).
-
-### Why is this bad?
-Floating point calculations are usually imprecise, so
-asking if two values are *exactly* equal is asking for trouble. For a good
-guide on what to do, see [the floating point
-guide](http://www.floating-point-gui.de/errors/comparison).
-
-### Example
-```
-let x = 1.2331f64;
-let y = 1.2332f64;
-
-if y == 1.23f64 { }
-if y != x {} // where both are floats
-```
-
-Use instead:
-```
-let error_margin = f64::EPSILON; // Use an epsilon for comparison
-// Or, if Rust <= 1.42, use `std::f64::EPSILON` constant instead.
-// let error_margin = std::f64::EPSILON;
-if (y - 1.23f64).abs() < error_margin { }
-if (y - x).abs() > error_margin { }
-```
\ No newline at end of file