public final classDoubleextendsNumberimplementsComparable<Double>
Double
class wraps a value of the primitive typedouble
in an object. An object of typeDouble
contains a single field whose type isdouble
.In addition, this class provides several methods for converting adouble
to aString
and aString
to adouble
, as well as other constants and methods useful when dealing with adouble
.
Modifier and Type | Field | Description |
---|---|---|
static int | BYTES | The number of bytes used to represent a double value. |
static int | MAX_EXPONENT | Maximum exponent a finite double variable may have. |
static double | MAX_VALUE | A constant holding the largest positive finite value of type double , (2-2-52)·21023. |
static int | MIN_EXPONENT | Minimum exponent a normalized double variable may have. |
static double | MIN_NORMAL | A constant holding the smallest positive normal value of type double , 2-1022. |
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. |
staticClass<Double> | TYPE | The Class instance representing the primitive typedouble . |
Constructor | Description |
---|---|
Double(double value) | Constructs a newly allocated Double object that represents the primitivedouble argument. |
Double(String s) | Constructs a newly allocated Double object that represents the floating-point value of typedouble represented by the string. |
Modifier and Type | Method | Description |
---|---|---|
byte | byteValue() | Returns the value of this Double as abyte after a narrowing primitive conversion. |
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 thisDouble object. |
boolean | equals(Object obj) | Compares this object against the specified object. |
float | floatValue() | Returns the value of this Double as afloat after a narrowing primitive conversion. |
int | hashCode() | Returns a hash code for this Double object. |
static int | hashCode(double value) | Returns a hash code for a double value; compatible withDouble.hashCode() . |
int | intValue() | Returns the value of this Double as anint after a narrowing primitive conversion. |
static boolean | isFinite(double d) | Returns true if the argument is a finite floating-point value; returnsfalse otherwise (for NaN and infinity arguments). |
boolean | isInfinite() | Returns true if thisDouble 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 thisDouble 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 along after a narrowing primitive conversion. |
static double | max(double a, double b) | Returns the greater of two double values as if by callingMath.max . |
static double | min(double a, double b) | Returns the smaller of two double values as if by callingMath.min . |
static double | parseDouble(String s) | Returns a new double initialized to the value represented by the specifiedString , as performed by thevalueOf method of classDouble . |
short | shortValue() | Returns the value of this Double as ashort after a narrowing primitive conversion. |
static double | sum(double a, double b) | Adds two double values together as per the + operator. |
staticString | toHexString(double d) | Returns a hexadecimal string representation of the double argument. |
String | toString() | Returns a string representation of this Double object. |
staticString | toString(double d) | Returns a string representation of the double argument. |
staticDouble | valueOf(double d) | Returns a Double instance representing the specifieddouble value. |
staticDouble | valueOf(String s) | Returns a Double object holding thedouble value represented by the argument strings . |
public static final double POSITIVE_INFINITY
double
. It is equal to the value returned byDouble.longBitsToDouble(0x7ff0000000000000L)
.public static final double NEGATIVE_INFINITY
double
. It is equal to the value returned byDouble.longBitsToDouble(0xfff0000000000000L)
.public static final double NaN
double
. It is equivalent to the value returned byDouble.longBitsToDouble(0x7ff8000000000000L)
.public static final double MAX_VALUE
double
, (2-2-52)·21023. It is equal to the hexadecimal floating-point literal0x1.fffffffffffffP+1023
and also equal toDouble.longBitsToDouble(0x7fefffffffffffffL)
.public static final double MIN_NORMAL
double
, 2-1022. It is equal to the hexadecimal floating-point literal0x1.0p-1022
and also equal toDouble.longBitsToDouble(0x0010000000000000L)
.public static final double MIN_VALUE
double
, 2-1074. It is equal to the hexadecimal floating-point literal0x0.0000000000001P-1022
and also equal toDouble.longBitsToDouble(0x1L)
.public static final int MAX_EXPONENT
double
variable may have. It is equal to the value returned byMath.getExponent(Double.MAX_VALUE)
.public static final int MIN_EXPONENT
double
variable may have. It is equal to the value returned byMath.getExponent(Double.MIN_NORMAL)
.public static final int SIZE
double
value.public static final int BYTES
double
value.public Double(double value)
Double
object that represents the primitivedouble
argument.value
- the value to be represented by theDouble
.public Double(String s) throwsNumberFormatException
Double
object that represents the floating-point value of typedouble
represented by the string. The string is converted to adouble
value as if by thevalueOf
method.s
- a string to be converted to aDouble
.NumberFormatException
- if the string does not contain a parsable number.valueOf(java.lang.String)
public static String toString(double d)
double
argument. All characters mentioned below are ASCII characters.NaN
".-
' ('\u002D'
); if the sign is positive, no sign character appears in the result. As for the magnitudem:"Infinity"
; thus, positive infinity produces the result"Infinity"
and negative infinity produces the result"-Infinity"
."0.0"
; thus, negative zero produces the result"-0.0"
and positive zero produces the result"0.0"
..
' ('\u002E'
), followed by one or more decimal digits representing the fractional part ofm..
' ('\u002E'
), followed by decimal digits representing the fractional part ofa, followed by the letter 'E
' ('\u0045'
), followed by a representation ofn as a decimal integer, as produced by the methodInteger.toString(int)
.double
. That is, suppose thatx is the exact mathematical value represented by the decimal representation produced by this method for a finite nonzero argumentd. Thend must be thedouble
value nearest tox; or if twodouble
values are equally close tox, thend must be one of them and the least significant bit of the significand ofd must be0
.To create localized string representations of a floating-point value, use subclasses ofNumberFormat
.
d
- thedouble
to be converted.public static String toHexString(double d)
double
argument. All characters mentioned below are ASCII characters.NaN
".-
' ('\u002D'
); if the sign is positive, no sign character appears in the result. As for the magnitudem:"Infinity"
; thus, positive infinity produces the result"Infinity"
and negative infinity produces the result"-Infinity"
."0x0.0p0"
; thus, negative zero produces the result"-0x0.0p0"
and positive zero produces the result"0x0.0p0"
.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 toInteger.toString
on the exponent value.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.Floating-point Value | Hexadecimal String |
---|---|
1.0 | 0x1.0p0 |
-1.0 | -0x1.0p0 |
2.0 | 0x1.0p1 |
3.0 | 0x1.8p1 |
0.5 | 0x1.0p-1 |
0.25 | 0x1.0p-2 |
Double.MAX_VALUE | 0x1.fffffffffffffp1023 |
Minimum Normal Value | 0x1.0p-1022 |
Maximum Subnormal Value | 0x0.fffffffffffffp-1022 |
Double.MIN_VALUE | 0x0.0000000000001p-1022 |
d
- thedouble
to be converted.public static Double valueOf(String s) throwsNumberFormatException
Double
object holding thedouble
value represented by the argument strings
.Ifs
isnull
, then aNullPointerException
is thrown.
Leading and trailing whitespace characters ins
are ignored. Whitespace is removed as if by theString.trim()
method; that is, both ASCII space and control characters are removed. The rest ofs
should constitute aFloatValue as described by the lexical syntax rules:
whereSign,FloatingPointLiteral,HexNumeral,HexDigits,SignedInteger andFloatTypeSuffix are as defined in the lexical structure sections ofThe Java™ Language Specification, except that underscores are not accepted between digits. If
- FloatValue:
- Signopt
NaN
- Signopt
Infinity
- Signopt FloatingPointLiteral
- Signopt HexFloatingPointLiteral
- SignedInteger
- HexFloatingPointLiteral:
- HexSignificand BinaryExponent FloatTypeSuffixopt
- HexSignificand:
- HexNumeral
- HexNumeral
.
0x
HexDigitsopt.
HexDigits0X
HexDigitsopt.
HexDigits
- BinaryExponent:
- BinaryExponentIndicator SignedInteger
- BinaryExponentIndicator:
p
P
s
does not have the form of aFloatValue, then aNumberFormatException
is thrown. Otherwise,s
is regarded as representing an exact decimal value in the usual "computerized scientific notation" or as an exact hexadecimal value; this exact numerical value is then conceptually converted to an "infinitely precise" binary value that is then rounded to typedouble
by the usual round-to-nearest rule of IEEE 754 floating-point arithmetic, which includes preserving the sign of a zero value. Note that the round-to-nearest rule also implies overflow and underflow behaviour; if the exact value ofs
is large enough in magnitude (greater than or equal to (MAX_VALUE
+ulp(MAX_VALUE)
/2), rounding todouble
will result in an infinity and if the exact value ofs
is small enough in magnitude (less than or equal toMIN_VALUE
/2), rounding to float will result in a zero. Finally, after rounding aDouble
object representing thisdouble
value is returned. To interpret localized string representations of a floating-point value, use subclasses ofNumberFormat
.
Note that trailing format specifiers, specifiers that determine the type of a floating-point literal (1.0f
is afloat
value;1.0d
is adouble
value), donot 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 tofloat
followed byfloat
todouble
, isnot equivalent to converting a string directly todouble
. For example, thefloat
literal0.1f
is equal to thedouble
value0.10000000149011612
; thefloat
literal0.1f
represents a different numerical value than thedouble
literal0.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 aNumberFormatException
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 section 3.10.2 of // The Java Language Specification. // 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 }
s
- the string to be parsed.Double
object holding the value represented by theString
argument.NumberFormatException
- if the string does not contain a parsable number.public static Double valueOf(double d)
Double
instance representing the specifieddouble
value. If a newDouble
instance is not required, this method should generally be used in preference to the constructorDouble(double)
, as this method is likely to yield significantly better space and time performance by caching frequently requested values.d
- a double value.Double
instance representingd
.public static double parseDouble(String s) throwsNumberFormatException
double
initialized to the value represented by the specifiedString
, as performed by thevalueOf
method of classDouble
.s
- the string to be parsed.double
value represented by the string argument.NullPointerException
- if the string is nullNumberFormatException
- if the string does not contain a parsabledouble
.valueOf(String)
public static boolean isNaN(double v)
true
if the specified number is a Not-a-Number (NaN) value,false
otherwise.v
- the value to be tested.true
if the value of the argument is NaN;false
otherwise.public static boolean isInfinite(double v)
true
if the specified number is infinitely large in magnitude,false
otherwise.v
- the value to be tested.true
if the value of the argument is positive infinity or negative infinity;false
otherwise.public static boolean isFinite(double d)
true
if the argument is a finite floating-point value; returnsfalse
otherwise (for NaN and infinity arguments).d
- thedouble
value to be testedtrue
if the argument is a finite floating-point value,false
otherwise.public boolean isNaN()
true
if thisDouble
value is a Not-a-Number (NaN),false
otherwise.true
if the value represented by this object is NaN;false
otherwise.public boolean isInfinite()
true
if thisDouble
value is infinitely large in magnitude,false
otherwise.true
if the value represented by this object is positive infinity or negative infinity;false
otherwise.public String toString()
Double
object. The primitivedouble
value represented by this object is converted to a string exactly as if by the methodtoString
of one argument.toString
in class Object
String
representation of this object.toString(double)
public byte byteValue()
Double
as abyte
after a narrowing primitive conversion.public short shortValue()
Double
as ashort
after a narrowing primitive conversion.shortValue
in class Number
double
value represented by this object converted to typeshort
public int intValue()
Double
as anint
after a narrowing primitive conversion.public long longValue()
Double
as along
after a narrowing primitive conversion.public float floatValue()
Double
as afloat
after a narrowing primitive conversion.floatValue
in class Number
double
value represented by this object converted to typefloat
public double doubleValue()
double
value of thisDouble
object.doubleValue
in class Number
double
value represented by this objectpublic int hashCode()
Double
object. The result is the exclusive OR of the two halves of thelong
integer bit representation, exactly as produced by the methoddoubleToLongBits(double)
, of the primitivedouble
value represented by thisDouble
object. That is, the hash code is the value of the expression:(int)(v^(v>>>32))
wherev
is defined by:long v = Double.doubleToLongBits(this.doubleValue());
hashCode
in class Object
hash code
value for this object.Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
public static int hashCode(double value)
double
value; compatible withDouble.hashCode()
.value
- the value to hashdouble
value.public boolean equals(Object obj)
true
if and only if the argument is notnull
and is aDouble
object that represents adouble
that has the same value as thedouble
represented by this object. For this purpose, twodouble
values are considered to be the same if and only if the methoddoubleToLongBits(double)
returns the identicallong
value when applied to each.Note that in most cases, for two instances of classDouble
,d1
andd2
, the value ofd1.equals(d2)
istrue
if and only if
d1.doubleValue() == d2.doubleValue()
also has the valuetrue
. However, there are two exceptions:
d1
andd2
both representDouble.NaN
, then theequals
method returnstrue
, even thoughDouble.NaN==Double.NaN
has the valuefalse
.d1
represents+0.0
whiled2
represents-0.0
, or vice versa, theequal
test has the valuefalse
, even though+0.0==-0.0
has the valuetrue
.equals
in class Object
obj
- the object to compare with.true
if the objects are the same;false
otherwise.doubleToLongBits(double)
public static long doubleToLongBits(double value)
Bit 63 (the bit that is selected by the mask0x8000000000000000L
) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask0x7ff0000000000000L
) represent the exponent. Bits 51-0 (the bits that are selected by the mask0x000fffffffffffffL
) represent the significand (sometimes called the mantissa) of the floating-point number.
If the argument is positive infinity, the result is0x7ff0000000000000L
.
If the argument is negative infinity, the result is0xfff0000000000000L
.
If the argument is NaN, the result is0x7ff8000000000000L
.
In all cases, the result is along
integer that, when given to thelongBitsToDouble(long)
method, will produce a floating-point value the same as the argument todoubleToLongBits
(except all NaN values are collapsed to a single "canonical" NaN value).
value
- adouble
precision floating-point number.public static long doubleToRawLongBits(double value)
Bit 63 (the bit that is selected by the mask0x8000000000000000L
) represents the sign of the floating-point number. Bits 62-52 (the bits that are selected by the mask0x7ff0000000000000L
) represent the exponent. Bits 51-0 (the bits that are selected by the mask0x000fffffffffffffL
) represent the significand (sometimes called the mantissa) of the floating-point number.
If the argument is positive infinity, the result is0x7ff0000000000000L
.
If the argument is negative infinity, the result is0xfff0000000000000L
.
If the argument is NaN, the result is thelong
integer representing the actual NaN value. Unlike thedoubleToLongBits
method,doubleToRawLongBits
does not collapse all the bit patterns encoding a NaN to a single "canonical" NaN value.
In all cases, the result is along
integer that, when given to thelongBitsToDouble(long)
method, will produce a floating-point value the same as the argument todoubleToRawLongBits
.
value
- adouble
precision floating-point number.public static double longBitsToDouble(long bits)
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 is0x7ff0000000000000L
, the result is positive infinity.
If the argument is0xfff0000000000000L
, the result is negative infinity.
If the argument is any value in the range0x7ff0000000000001L
through0x7fffffffffffffffL
or in the range0xfff0000000000001L
through0xffffffffffffffffL
, 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 theDouble.doubleToRawLongBits
method.
In all other cases, lets,e, andm be three values that can be computed from the argument:
Then the floating-point result equals the value of the mathematical expressions·m·2e-1075.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 adouble
NaN with exactly same bit pattern as thelong
argument. IEEE 754 distinguishes between two kinds of NaNs, quiet NaNs andsignaling 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. SolongBitsToDouble
may not be able to return adouble
with a signaling NaN bit pattern. Consequently, for somelong
values,doubleToRawLongBits(longBitsToDouble(start))
maynot equalstart
. 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
- anylong
integer.double
floating-point value with the same bit pattern.public int compareTo(Double anotherDouble)
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 primitivedouble
values:Double.NaN
is considered by this method to be equal to itself and greater than all otherdouble
values (includingDouble.POSITIVE_INFINITY
).0.0d
is considered by this method to be greater than-0.0d
.Double
objects imposed by this method isconsistent with equals.compareTo
in interface Comparable<Double>
anotherDouble
- theDouble
to be compared.0
ifanotherDouble
is numerically equal to thisDouble
; a value less than0
if thisDouble
is numerically less thananotherDouble
; and a value greater than0
if thisDouble
is numerically greater thananotherDouble
.public static int compare(double d1, double d2)
double
values. The sign of the integer value returned is the same as that of the integer that would be returned by the call:new Double(d1).compareTo(new Double(d2))
d1
- the firstdouble
to compared2
- the seconddouble
to compare0
ifd1
is numerically equal tod2
; a value less than0
ifd1
is numerically less thand2
; and a value greater than0
ifd1
is numerically greater thand2
.public static double sum(double a, double b)
double
values together as per the + operator.a
- the first operandb
- the second operanda
andb
BinaryOperator
public static double max(double a, double b)
double
values as if by callingMath.max
.a
- the first operandb
- the second operanda
andb
BinaryOperator
public static double min(double a, double b)
double
values as if by callingMath.min
.a
- the first operandb
- the second operanda
andb
.BinaryOperator