Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

According to The Java Language Specification (JLS), §4.2.3, "Floating-Point Types, Formats, and Values" [JLS 20052015]:

NaN (not-a-number) is unordered, so the numerical comparison operators <, <=, >, and >= return false if either or both operands are NaN. The equality operator == returns false if either operand is NaN, and the inequality operator != returns true if either operand is NaN.

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.

...

This compliant solution uses the method Double.isNaN() to check whether the expression corresponds to a NaN value.:

Code Block
bgColor#ccccff
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

Automated detection of comparison with NaN 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.

ToolVersionCheckerDescription
Parasoft Jtest
Include Page
Parasoft_V
Parasoft_V
CERT.NUM07.NANAvoid comparisons to Double.NaN or Float.NaN
PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V6038

Bibliography

...


...

Image Modified