According to the JLS, [§4.2.3, "Floating-Point Types, Formats, and Values"|http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3] \[[JLS 2005|AA. References#JLS 05]\]: |
NaN(not-a-number) is unordered, so the numerical comparison operators<,<=,>, and>=returnfalseif either or both operands areNaN. The equality operator==returnsfalseif either operand isNaN, and the inequality operator!=returnstrueif either operand isNaN.
Because this unordered property is often unexpected, direct comparisons with NaN must not be performed. Problems can arise when programmers write code that compares floating-point values without considering the semantics of NaN. For example, input validation checks that fail to consider the possibility of a NaN value as input can produce unexpected results. See rule NUM08-J. Check floating-point inputs for exceptional values for additional information.
This noncompliant code example attempts a direct comparison with NaN. In accordance with the semantics of NaN, all comparisons with NaN yield false (with the exception of the != operator, which returns true). Consequently, this comparison always return false, and the "result is NaN" message is never printed.
public class NaNComparison {
public static void main(String[] args) {
double x = 0.0;
double result = Math.cos(1/x); // returns NaN if input is infinity
if (result == Double.NaN) { // comparison is always false!
System.out.println("result is NaN");
}
}
}
|
This compliant solution uses the method Double.isNaN() to check whether the expression corresponds to a NaN value.
public class NaNComparison {
public static void main(String[] args) {
double x = 0.0;
double result = Math.cos(1/x); // returns NaN when input is infinity
if (Double.isNaN(result)) {
System.out.println("result is NaN");
}
}
}
|
Comparisons with NaN values can lead to unexpected results.
Rule |
Severity |
Likelihood |
Remediation Cost |
Priority |
Level |
|---|---|---|---|---|---|
NUM07-J |
low |
probable |
medium |
P4 |
L3 |
Automated detection of floating-point comparison operators is straightforward. Sound determination of whether the possibility of an unordered result has been correctly handled is not feasible in the general case. Heuristic checks could be useful.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1e329e68-d480-481e-9d6a-dfdca433afe6"><ac:plain-text-body><![CDATA[ |
[[FindBugs 2008 |
AA. References#FindBugs 08]] |
FE: Doomed test for equality to NaN |
]]></ac:plain-text-body></ac:structured-macro> |
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8afe987b-e564-4eda-87a2-b3e1bdc4b484"><ac:plain-text-body><![CDATA[ |
[[JLS 2005 |
AA. References#JLS 05]] |
[§4.2.3, Floating-Point Types, Formats, and Values |
http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3] |
]]></ac:plain-text-body></ac:structured-macro> |
NUM06-J. Use the strictfp modifier for floating-point calculation consistency across platforms 03. Numeric Types and Operations (NUM)