Java


JAVA.ARITH.FPEQUAL : Floating Point Equality (Java)

要旨

A comparison between non-integral values might be unreliable.

Floating point operations are by nature approximated. This can introduce bugs when precise, mathematical properties are expected from inherently imprecise floating point computations. Moreover, computations that might lose precision or overflow, whose result is stored in a larger type, are suspicious since, by computing on the larger type from the beginning, one could avoid approximations and overflows.

プロパティ

クラス名 Floating Point Equality (Java)
日本語クラス名 Floating Point Equality (Java)
クラス分類 信頼性 (reliability)
ニーモニック JAVA.ARITH.FPEQUAL
カテゴリー
CWE CWE:1077 Floating Point Comparison with Incorrect Operator
CERT-Java CERT-Java:NUM12-J Ensure conversions of numeric types to narrower types do not result in lost or misinterpreted data
対応言語 Java で利用可能です。
有効/無効設定 このワーニングクラスのチェックはデフォルトで有効になっています。チェックを無効にするにはプロジェクト設定ファイル (configuration file)に以下の WARNING_FILTER ルールを追加してください。
WARNING_FILTER += discard class="Floating Point Equality (Java)"

public class Approximation {

  public static void main(String[] args) {
    for (double d = 0.0; d != 5.0; d += 0.001) // "Floating Point Equality (Java)" warning issued here

      System.out.println(d);
  }
}

The comparison between d != 5.0 will always yield true, because of approximations in the computation d += 0.001. The while loop will thus never terminate.

In this example, the programmer should replace d != 5.0 with d < 5.0 or replace floating point computations with (stable and more efficient) integral computations.

for (int d = 0; d != 5000; d++)
  System.out.println(d / 1000.0);

解決法

Use approximated comparisons (up to some epsilon) rather than exact comparisons. Use integral numbers instead of floating point values, whenever possible. Compute over integral numbers and translate into floating points only at the end, whenever possible. If a large type for the result of a computation is desired, compute from the beginning on that type instead of applying a type conversion at the end of the computation.

関連のある設定ファイルパラメータ

設定ファイルの以下のパラメータがこのワーニングクラスのチェックに影響します。