51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
51 lines
2.1 KiB
Plaintext
51 lines
2.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Floating point math is imprecise because of the challenges of storing such values in a binary representation. Even worse, floating point math is not associative; push a ``++float++`` or a ``++double++`` through a series of simple mathematical operations and the answer will be different based on the order of those operation because of the rounding that takes place at each step.
|
|
|
|
|
|
Even simple floating point assignments are not simple:
|
|
|
|
----
|
|
float f = 0.1; // 0.100000001490116119384765625
|
|
double d = 0.1; // 0.1000000000000000055511151231257827021181583404541015625
|
|
----
|
|
(Results will vary based on compiler and compiler settings.)
|
|
|
|
|
|
Therefore, the use of the equality (``++==++``) and inequality (``++!=++``) operators on ``++float++`` or ``++double++`` values is very often an error.
|
|
|
|
|
|
The accepted solution is to use or write a float comparison library:
|
|
|
|
* Either using a comparison taking into account the magnitude of the numbers being compared and an epsilon value (which may be based on the capability of the floating point epsilon (FLT_EPSILON)). This comparison will often be absolute for very small values, and relative for larger ones
|
|
* Or using the notion of https://en.wikipedia.org/wiki/Unit_in_the_last_place[units in the last place]
|
|
|
|
This rule checks for the use of equality/inequality tests on ``++float++``s, ``++double++``s and ``++long double++``s.
|
|
|
|
include::../noncompliant.adoc[]
|
|
|
|
== Resources
|
|
|
|
* MISRA C:2004, 13.3 - Floating-point expressions shall not be tested for equality or inequality.
|
|
* MISRA {cpp}:2008, 6-2-2 - Floating-point expressions shall not be directly or indirectly tested for equality or inequality
|
|
* https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/[Comparing Floating Point Numbers, 2012 Edition]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Replace this ("==" or "!=") with a more tolerant comparison operation
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|