Java Doc for Double.java in  » 6.0-JDK-Core » lang » java » lang » Java Source Code / Java DocumentationJava Source Code and Java Documentation

In addition, this class provides several methods for converting a double to a String and a String to a double , as well as other constants and methods useful when dealing with a double .
author:
   Lee Boynton
author:
   Arthur van Hoff
author:
   Joseph D. Darcy
version:
   1.108, 06/12/07
since:
   JDK1.0

Bit 63 (the bit that is selected by the mask 0x8000000000000000L ) represents the sign of the floating-point number.

Bit 63 (the bit that is selected by the mask 0x8000000000000000L ) represents the sign of the floating-point number.

If the argument is 0x7ff0000000000000L , the result is positive infinity.

If s is null , then a NullPointerException is thrown.

Leading and trailing whitespace characters in s are ignored.

 new Double(d1).compareTo(new Double(d2))
 

• Double.NaN is considered by this method to be equal to itself and greater than all other double values (including Double.POSITIVE_INFINITY ).
• 0.0d is considered by this method to be greater than -0.0d .

Bit 63 (the bit that is selected by the mask 0x8000000000000000L ) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask 0x7ff0000000000000L ) represent the exponent. Bits 51-0 (the bits that are selected by the mask 0x000fffffffffffffL ) represent the significand (sometimes called the mantissa) of the floating-point number.

If the argument is positive infinity, the result is 0x7ff0000000000000L .

If the argument is negative infinity, the result is 0xfff0000000000000L .

If the argument is NaN, the result is 0x7ff8000000000000L .

In all cases, the result is a long integer that, when given to the Double.longBitsToDouble(long) method, will produce a floating-point value the same as the argument to doubleToLongBits (except all NaN values are collapsed to a single "canonical" NaN value).
Parameters:
  value - a double precision floating-point number. the bits that represent the floating-point number.

Bit 63 (the bit that is selected by the mask 0x8000000000000000L ) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask 0x7ff0000000000000L ) represent the exponent. Bits 51-0 (the bits that are selected by the mask 0x000fffffffffffffL ) represent the significand (sometimes called the mantissa) of the floating-point number.

If the argument is positive infinity, the result is 0x7ff0000000000000L .

If the argument is negative infinity, the result is 0xfff0000000000000L .

If the argument is NaN, the result is the long integer representing the actual NaN value. Unlike the doubleToLongBits method, doubleToRawLongBits does not collapse all the bit patterns encoding a NaN to a single "canonical" NaN value.

In all cases, the result is a long integer that, when given to the Double.longBitsToDouble(long) method, will produce a floating-point value the same as the argument to doubleToRawLongBits .
Parameters:
  value - a double precision floating-point number. the bits that represent the floating-point number.
since:
   1.3

Note that in most cases, for two instances of class Double , d1 and d2 , the value of d1.equals(d2) is true if and only if

d1.doubleValue() == d2.doubleValue()

also has the value true . However, there are two exceptions:

• If d1 and d2 both represent Double.NaN , then the equals method returns true , even though Double.NaN==Double.NaN has the value false .
• If d1 represents +0.0 while d2 represents -0.0 , or vice versa, the equal test has the value false , even though +0.0==-0.0 has the value true .

(int)(v^(v>>>32))

long v = Double.doubleToLongBits(this.doubleValue());

If the argument is 0x7ff0000000000000L , the result is positive infinity.

If the argument is 0xfff0000000000000L , the result is negative infinity.

If the argument is any value in the range 0x7ff0000000000001L through 0x7fffffffffffffffL or in the range 0xfff0000000000001L through 0xffffffffffffffffL , the result is a NaN. No IEEE 754 floating-point operation provided by Java can distinguish between two NaN values of the same type with different bit patterns. Distinct values of NaN are only distinguishable by use of the Double.doubleToRawLongBits method.

In all other cases, let s, e, and m be three values that can be computed from the argument:

 int s = ((bits >> 63) == 0) ? 1 : -1;
 int e = (int)((bits >> 52) & 0x7ffL);
 long m = (e == 0) ?
 (bits & 0xfffffffffffffL) << 1 :
 (bits & 0xfffffffffffffL) | 0x10000000000000L;
 

Note that this method may not be able to return a double NaN with exactly same bit pattern as the long argument. IEEE 754 distinguishes between two kinds of NaNs, quiet NaNs and signaling NaNs. The differences between the two kinds of NaN are generally not visible in Java. Arithmetic operations on signaling NaNs turn them into quiet NaNs with a different, but often similar, bit pattern. However, on some processors merely copying a signaling NaN also performs that conversion. In particular, copying a signaling NaN to return it to the calling method may perform this conversion. So longBitsToDouble may not be able to return a double with a signaling NaN bit pattern. Consequently, for some long values, doubleToRawLongBits(longBitsToDouble(start)) may not equal start . Moreover, which particular bit patterns represent signaling NaNs is platform dependent; although all NaN bit patterns, quiet or signaling, must be in the NaN range identified above.
Parameters:
  bits - any long integer. the double floating-point value with the samebit pattern.

• If the argument is NaN, the result is the string " NaN ".
• Otherwise, the result is a string that represents the sign and magnitude of the argument. If the sign is negative, the first character of the result is ' - ' ('\u002D'); if the sign is positive, no sign character appears in the result. As for the magnitude m:
  • If m is infinity, it is represented by the string "Infinity" ; thus, positive infinity produces the result "Infinity" and negative infinity produces the result "-Infinity" .
  • If m is zero, it is represented by the string "0x0.0p0" ; thus, negative zero produces the result "-0x0.0p0" and positive zero produces the result "0x0.0p0" .
  • If m is a double value with a normalized representation, substrings are used to represent the significand and exponent fields. The significand is represented by the characters "0x1." followed by a lowercase hexadecimal representation of the rest of the significand as a fraction. Trailing zeros in the hexadecimal representation are removed unless all the digits are zero, in which case a single zero is used. Next, the exponent is represented by "p" followed by a decimal string of the unbiased exponent as if produced by a call to Integer.toString(int) Integer.toString on the exponent value.
  • If m is a double value with a subnormal representation, the significand is represented by the characters "0x0." followed by a hexadecimal representation of the rest of the significand as a fraction. Trailing zeros in the hexadecimal representation are removed. Next, the exponent is represented by "p-1022" . Note that there must be at least one nonzero digit in a subnormal significand.

• If the argument is NaN, the result is the string " NaN ".
• Otherwise, the result is a string that represents the sign and magnitude (absolute value) of the argument. If the sign is negative, the first character of the result is ' - ' ('\u002D'); if the sign is positive, no sign character appears in the result. As for the magnitude m:
  • If m is infinity, it is represented by the characters "Infinity" ; thus, positive infinity produces the result "Infinity" and negative infinity produces the result "-Infinity" .
  • If m is zero, it is represented by the characters "0.0" ; thus, negative zero produces the result "-0.0" and positive zero produces the result "0.0" .
  • If m is greater than or equal to 10^-3 but less than 10⁷, then it is represented as the integer part of m, in decimal form with no leading zeroes, followed by ' . ' ('\u002E'), followed by one or more decimal digits representing the fractional part of m.
  • If m is less than 10^-3 or greater than or equal to 10⁷, then it is represented in so-called "computerized scientific notation." Let n be the unique integer such that 10ⁿ ≤ m 10ⁿ⁺¹; then let a be the mathematically exact quotient of m and 10ⁿ so that 1 ≤ a 10. The magnitude is then represented as the integer part of a, as a single decimal digit, followed by ' . ' ('\u002E'), followed by decimal digits representing the fractional part of a, followed by the letter ' E ' ('\u0045'), followed by a representation of n as a decimal integer, as produced by the method Integer.toString(int) .

To create localized string representations of a floating-point value, use subclasses of java.text.NumberFormat .
Parameters:
  d - the double to be converted. a string representation of the argument.

If s is null , then a NullPointerException is thrown.

Leading and trailing whitespace characters in s are ignored. Whitespace is removed as if by the String.trim method; that is, both ASCII space and control characters are removed. The rest of s should constitute a FloatValue as described by the lexical syntax rules:

FloatValue:

Sign_opt NaN

Sign_opt Infinity

Sign_opt FloatingPointLiteral

Sign_opt HexFloatingPointLiteral

SignedInteger

HexFloatingPointLiteral:

HexSignificand BinaryExponent FloatTypeSuffix_opt

HexSignificand:

HexNumeral

HexNumeral .

0x HexDigits_opt . HexDigits

0X HexDigits_opt . HexDigits

BinaryExponent:

BinaryExponentIndicator SignedInteger

BinaryExponentIndicator:

p

P

To interpret localized string representations of a floating-point value, use subclasses of java.text.NumberFormat .

Note that trailing format specifiers, specifiers that determine the type of a floating-point literal ( 1.0f is a float value; 1.0d is a double value), do not influence the results of this method. In other words, the numerical value of the input string is converted directly to the target floating-point type. The two-step sequence of conversions, string to float followed by float to double , is not equivalent to converting a string directly to double . For example, the float literal 0.1f is equal to the double value 0.10000000149011612 ; the float literal 0.1f represents a different numerical value than the double literal 0.1 . (The numerical value 0.1 cannot be exactly represented in a binary floating-point number.)

To avoid calling this method on an invalid string and having a NumberFormatException be thrown, the regular expression below can be used to screen the input string:

 final String Digits	= "(\\p{Digit}+)";
 final String HexDigits  = "(\\p{XDigit}+)";
 // an exponent is 'e' or 'E' followed by an optionally 
 // signed decimal integer.
 final String Exp	= "[eE][+-]?"+Digits;
 final String fpRegex	=
 ("[\\x00-\\x20]*"+	// Optional leading "whitespace"
 "[+-]?(" +	// Optional sign character
 "NaN|" +		// "NaN" string
 "Infinity|" +	// "Infinity" string
 // A decimal floating-point string representing a finite positive
 // number without a leading sign has at most five basic pieces:
 // Digits . Digits ExponentPart FloatTypeSuffix
 // 
 // Since this method allows integer-only strings as input
 // in addition to strings of floating-point literals, the
 // two sub-patterns below are simplifications of the grammar
 // productions from the Java Language Specification, 2nd 
 // edition, section 3.10.2.
 // Digits ._opt Digits_opt ExponentPart_opt FloatTypeSuffix_opt
 "((("+Digits+"(\\.)?("+Digits+"?)("+Exp+")?)|"+
 // . Digits ExponentPart_opt FloatTypeSuffix_opt
 "(\\.("+Digits+")("+Exp+")?)|"+
 // Hexadecimal strings
 "((" +
 // 0[xX] HexDigits ._opt BinaryExponent FloatTypeSuffix_opt
 "(0[xX]" + HexDigits + "(\\.)?)|" +
 // 0[xX] HexDigits_opt . HexDigits BinaryExponent FloatTypeSuffix_opt
 "(0[xX]" + HexDigits + "?(\\.)" + HexDigits + ")" +
 ")[pP][+-]?" + Digits + "))" +
 "[fFdD]?))" +
 "[\\x00-\\x20]*");// Optional trailing "whitespace"
 if (Pattern.matches(fpRegex, myString))
 Double.valueOf(myString); // Will not throw NumberFormatException
 else {
 // Perform suitable alternative action
 }