...
Conversion from int
or long
to float
, or long
to double
can lead to loss of precision (loss of least significant bits). In this case, the resulting floating-point value is a rounded version of the integer value, using IEEE 754 round-to-nearest mode. Despite this loss of precision, the Java Language Specification requires that the conversion and rounding occur silently, that is, without any runtime exception. See the JLS, §5.1.2, "Widening Primitive Conversion" for more information. Consequently, any conversion Conversions from integral types smaller than int
to a floating-point type and conversions from int
to double
can never result in a loss of precision. Consequently, programs must ensure that conversions from an int
or long
to a floating-point type, or from long
to double
must be checked against the range that the flowting-point type can precisely represent do not result in a loss of required precision.
Note that conversions from float
to double
can also lose information about the overall magnitude of the converted value. See rule "NUM06-J. Use the strictfp modifier for floating-point calculation consistency across platforms" for additional information.
Noncompliant Code Example
In this noncompliant code example, two identical large integer literals are passed as arguments to the subFloatFromInt()
method. The second argument is coerced to float
, cast back to int
, and subtracted from a value of type int
. The result is returned as a value of type int
.
...
Note that conversions from long
to either float
or double
can lead to similar loss of precision.
Compliant Solution (ArithmeticException
)
This compliant solution range checks the argument of the integer argument (op1
) to ensure it can be represented as a value of type float
without a loss of precision.
...
In this example, the subFloatFromInt()
method throws java.lang.ArithmeticException
. This general approach, with appropriate range checks, should be used for conversions from long
to either float
or double
.
Compliant Solution (Wider Type)
This compliant solution accepts an argument of type double
instead of an argument of type float
. Values of type double
have 52 mantissa bits, a sign bit, and an 11 bit exponent. Integer values of type int
and narrower can be converted to double
without a loss of precision.
...
Note that this compliant solution cannot be used when the primitive integers are of type long
because Java lacks a primitive floating-point type whose mantissa can represent the full range of a long
.
Exceptions
NUM13-EX0: Conversions from integral types smaller than int
need no precision range check when being converted to floating-point. Conversions from int
to double
also need no precision range check.NUM13-EX1: Conversion from integral types to floating-point types need no range check if the subsequent value does not need to be precise. In such cases, it must be documented that the loss of the least significant bits of precision is acceptable.
Risk Assessment
Converting integer values to floating-point types whose mantissa has fewer bits than the original integer value can result in a rounding error.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
NUM13-J | low | unlikely | medium | P2 | L3 |
Automated Detection
Automatic detection of casts that can lose precision is straightforward. Sound determination of whether those casts correctly reflect the intent of the programmer is infeasible in the general case. Heuristic warnings could be useful.
Related Guidelines
FLP36-C. Beware of precision loss when converting integral types to floating point | |
FLP36-CPP. Beware of precision loss when converting integral types to floating point |
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c0b70ce0e9d04396-d1b71798-40cd48b9-99f4a0b3-a75c780ca383fea5755ab4a2"><ac:plain-text-body><![CDATA[ | [[JLS 2005 | AA. Bibliography#JLS 05]] | [§5.1.2, "Widening Primitive Conversion" | http://java.sun.com/docs/books/jls/third_edition/html/conversions.html#5.1.2] | ]]></ac:plain-text-body></ac:structured-macro> |
...