is new.
java.lang.Objectjava.lang.Number
java.lang.Double
<
Double
>
The Double class wraps a value of the primitive type double in an object. An object of type Double contains a single field whose type is double.
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.
| Field Summary | |
|---|---|
| static double |
MAX_VALUE
A constant holding the largest positive finite value of type double, (2-2 -52 )·2 1023 . |
| static double |
MIN_VALUE
A constant holding the smallest positive nonzero value of type double, 2 -1074 . |
| static double |
NaN
A constant holding a Not-a-Number (NaN) value of type double. |
| static double |
NEGATIVE_INFINITY
A constant holding the negative infinity of type double. |
| static double |
POSITIVE_INFINITY
A constant holding the positive infinity of type double. |
static int
|
SIZE
The number of bits used to represent a
double
value.
|
|
|
static
Class
<
Double
|
TYPE
The Class instance representing the primitive type double.
|
| Constructor Summary | |
|---|---|
|
Double
(double value) Constructs a newly allocated Double object that represents the primitive double argument. |
|
|
Double
(
String
s) Constructs a newly allocated Double object that represents the floating-point value of type double represented by the string. |
|
| Method Summary | |
|---|---|
| byte |
byteValue
() Returns the value of this Double as a byte (by casting to a byte). |
| static int |
compare
(double d1, double d2) Compares the two specified double values. |
| int |
compareTo
(
Double
anotherDouble) Compares two Double objects numerically. |
|
|
| static long |
doubleToLongBits
(double value) Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "double format" bit layout. |
| static long |
doubleToRawLongBits
(double value) Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "double format" bit layout, preserving Not-a-Number (NaN) values. |
| double |
doubleValue
() Returns the double value of this Double object. |
| boolean |
equals
(
Object
obj) Compares this object against the specified object. |
| float |
floatValue
() Returns the float value of this Double object. |
| int |
hashCode
() Returns a hash code for this Double object. |
| int |
intValue
() Returns the value of this Double as an int (by casting to type int). |
| boolean |
isInfinite
() Returns true if this Double value is infinitely large in magnitude, false otherwise. |
| static boolean |
isInfinite
(double v) Returns true if the specified number is infinitely large in magnitude, false otherwise. |
| boolean |
isNaN
() Returns true if this Double value is a Not-a-Number (NaN), false otherwise. |
| static boolean |
isNaN
(double v) Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise. |
| static double |
longBitsToDouble
(long bits) Returns the double value corresponding to a given bit representation. |
| long |
longValue
() Returns the value of this Double as a long (by casting to type long). |
| static double |
parseDouble
(
String
s) Returns a new double initialized to the value represented by the specified String, as performed by the valueOf method of class Double. |
| short |
shortValue
() Returns the value of this Double as a short (by casting to a short). |
static
String
|
toHexString
(double d)
Returns a hexadecimal string representation of the double argument.
|
| String |
toString
() Returns a string representation of this Double object. |
| static String |
toString
(double d) Returns a string representation of the double argument. |
static
Double
|
valueOf
(double d)
Returns a
Double
instance representing the specified
double
value.
|
| static Double |
valueOf
(
String
s) Returns a Double object holding the double value represented by the argument string s. |
| Methods inherited from class java.lang. Object |
|---|
| clone , finalize , getClass , notify , notifyAll , wait , wait , wait |
Methods inherited from interface java.lang.
Comparable
|
|---|
compareTo
|
| Field Detail |
|---|
public static final double POSITIVE_INFINITY
public static final double NEGATIVE_INFINITY
public static final double NaN
public static final double MAX_VALUE
hexadecimal floating-point literal 0x1.fffffffffffffP+1023 and also equal to
public static final double MIN_VALUE
hexadecimal floating-point literal 0x0.0000000000001P-1022 and also equal to
SIZE
public static final int
SIZE
The number of bits used to represent a
double
value.
Since:
1.5
See Also:
Constant Field Values
public static final Class<
Double
> TYPE
| Constructor Detail |
|---|
public Double(double value)
public Double(String s)
throws NumberFormatException
| Method Detail |
|---|
public static String toString(double d)
To create localized string representations of a floating-point value, use subclasses of NumberFormat .
toHexString
public static
String
toHexString
(double d)
Returns a hexadecimal string representation of the double argument. All characters mentioned below are ASCII characters.
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
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.
Parameters:
d - the double to be converted.
Returns:
a hex string representation of the argument.
Since:
1.5
public static Double valueOf(String s)
throws NumberFormatException
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:
rule:
- 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
,
,
HexNumeral
,
HexDigits
,
SignedInteger
and
FloatTypeSuffix
are as defined in the lexical structure sections of the of the
Java Language Specification
"computerized
notation" or as an exact hexadecimal value;
numerical
"infinitely precise"
To interpret localized string representations of a floating-point value, use subclasses of 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 a 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 }
valueOf
public staticDouble
doublevalueOf
parseDouble(double d)
(Strings) throwsNumberFormatException
Returns a
Double
instance representing the specified
double
value. If a new
Double
instance is not required, this method should generally be used in preference to the constructor
Double(double)
, as this method is likely to to yield significantly better space and time performance by cacheing frequently requested values.
d - a double value.
a
Double
instance representing
d
.
1.5
parseDouble
public staticdouble
booleanparseDouble
isNaN(
String
s) throws
NumberFormatException
(double v)
Returns a new double initialized to the value represented by the specified String, as performed by the valueOf method of class Double.
s
string
parsed.
the double value represented by the string argument.
Throws:
NumberFormatException
- if the string does not contain a parsable double.
Since:
1.2
See Also:
valueOf(String)
isNaN
public static booleanisNaN
isInfinite(double v)
a Not-a-Number (NaN) value,
NaN;
isInfinite
publicstatic boolean
isInfinite
isNaN(double v)
()
Returns true if the specified number is infinitely large in magnitude, false otherwise.
Parameters:
v - the value to be tested.
of the argument
positive infinity or negative infinity;
isNaN
public booleanisNaN
isInfinite()
a Not-a-Number (NaN),
NaN;
isInfinite
public boolean
publicStringisInfinite
toString()
Returns true if this Double value is infinitely large in magnitude, false otherwise.
true if the value represented by this object is positive infinity or negative infinity; false otherwise.
toString
public
String
public bytetoString
byteValue()
Returns a string representation of this Double object. The primitive double value represented by this object is converted to a string exactly as if by the method toString of one argument.
toString
Object
a String representation of this object.
See Also:
toString(double)
byteValue
publicbyte
shortbyteValue
shortValue()
byte
byte).
byteValue
byte
shortValue
publicshort
intshortValue
intValue()
a short
a short).
Overrides:
shortValue
short
Since:
JDK1.1
intValue
publicint
longintValue
longValue()
an int
int).
intValue
int
longValue
publiclong
floatlongValue
floatValue()
as a long (by casting to type long).
longValue
long
floatValue
publicfloat
doublefloatValue
doubleValue()
float
floatValue
converted to type float
Since:
JDK1.0
doubleValue
publicdouble
intdoubleValue
hashCode()
Returns the double value of this Double object.
(int)(v^(v>>>32))
long v = Double.doubleToLongBits(this.doubleValue());
Specified by:
doubleValue
Number
the double value represented by this object
hashCode
publicint
booleanhashCode
equals()
(Objectobj)
Returns a hash code for this Double object. The result is the exclusive OR of the two halves of the long integer bit representation, exactly as produced by the method
doubleToLongBits(double)
, of the primitive double value represented by this Double object. That is, the hash code is the value of the expression:
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
(int)(v^(v>>>32))
d1.doubleValue() == d2.doubleValue()
where v is defined by:
long v = Double.doubleToLongBits(this.doubleValue());
also has the value true. However, there are two exceptions:
hashCode
a hash code value for this object.
Object.equals(java.lang.Object)
,
Hashtable
equals
public boolean
public static longequals
doubleToLongBits(
Object
obj)
(double value)
Compares this object against the specified object. The result is true if and only if the argument is not null and is a Double object that represents a double that has the same value as the double represented by this object. For this purpose, two double values are considered to be the same if and only if the method
doubleToLongBits(double)
returns the identical long value when applied to each.
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.
This definition allows hash tables to operate properly.
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
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).
Overrides:
equals
in class
Object
obj - the object to compare with.
true if the objects are the same; false otherwise.
See Also:
doubleToLongBits(double)
doubleToLongBits
public static longdoubleToLongBits
doubleToRawLongBits(double value)
layout.
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.
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
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).
doubleToRawLongBits.
doubleToRawLongBits
public staticlong
doubledoubleToRawLongBits
longBitsToDouble(double value)
(long bits)
the specified
layout, preserving Not-a-Number (NaN) values.
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 0x7ff0000000000000L, the result is positive infinity.
If the argument is
positive infinity,
0xfff0000000000000L,
the result is
0x7ff0000000000000L.
negative infinity.
If the argument is negative infinity, the result is 0xfff0000000000000L.
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.
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 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;
In all cases, the result is a long integer that, when given to the
longBitsToDouble(long)
method, will produce a floating-point value the same as the argument to doubleToRawLongBits.
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.
value - a double precision floating-point number.
the bits that represent the floating-point number.
longBitsToDouble
public static double
public intlongBitsToDouble
compareTo(long bits)
(DoubleanotherDouble)
Returns the double value corresponding to a given bit representation. The argument is considered to be a representation of a floating-point value according to the IEEE 754 floating-point "double format" bit layout.
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
Compares two Double objects numerically. There are two ways in which comparisons performed by this method differ from those performed by the Java language numerical comparison operators (<, <=, ==, >= >) when applied to primitive double values:
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;
Then the floating-point result equals the value of the mathematical expression
s
·
m
·2
e
-1075
.
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.
bits - any long integer.
the double floating-point value with the same bit pattern.
public int compareTo(Double
ObjectanotherDouble)
o)
Compares two Double objects numerically. There are two ways in which comparisons performed by this method differ from those performed by the Java language numerical comparison operators (<, <=, ==, >= >) when applied to primitive double values:
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.
This ensures that the
natural ordering
of
Double
objects imposed by this method is
consistent with equals
.
anotherDouble
Double
the value 0 if anotherDouble is numerically equal to this Double; a value less than 0 if this Double is numerically less than anotherDouble; and a value greater than 0 if this Double is numerically greater than anotherDouble.
public static int compare(double d1,
double d2)
new Double(d1).compareTo(new Double(d2))