Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.lang
Class Double

java.lang.Object
  |
  +--java.lang.Number
        |
        +--java.lang.Double
All Implemented Interfaces:
Comparable, Serializable
public final class Double
extends Number
implements Comparable

Safe: 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.

Since:
JDK1.0
Version:
1.80, 04/09/02
Author:
Lee Boynton, Arthur van Hoff
See Also:
Serialized Form

Field Summary
static double MAX_VALUE
          Enabled: A constant holding the largest positive finite value of type double, (2-2-52)·21023.
static double MIN_VALUE
          Enabled: A constant holding the smallest positive nonzero value of type double, 2-1074.
static double NaN
          Enabled: A constant holding a Not-a-Number (NaN) value of type double.
static double NEGATIVE_INFINITY
          Enabled: A constant holding the negative infinity of type double.
static double POSITIVE_INFINITY
          Enabled: A constant holding the positive infinity of type double.
private static long serialVersionUID
          use serialVersionUID from JDK 1.0.2 for interoperability
static Class TYPE
          Enabled: The Class instance representing the primitive type double.
private  double value
          The value of the Double.
 
Constructor Summary
Double(double value)
          Enabled: Constructs a newly allocated Double object that represents the primitive double argument.
Double(String s)
          Enabled: Constructs a newly allocated Double object that represents the floating-point value of type double represented by the string.
 
Method Summary
 boolean aboveZero()
          Added: Used in the expansion of E's ">" operator.
 double abs()
          Added:
 double acos()
          Added:
 double add(double arg)
          Added:
 double approxDivide(double arg)
          Added: Always gives back a double This corresponds to the Java floating-point "/" operator and the E "/" operator.
 double asin()
          Added:
 double atan()
          Added:
 double atan2(double arg)
          Added:
 boolean atLeastZero()
          Added: Used in the expansion of E's ">=" operator.
 boolean atMostZero()
          Added: Used in the expansion of E's "<=" operator.
 boolean belowZero()
          Added: Used in the expansion of E's "<" operator.
 byte byteValue()
          Enabled: Returns the value of this Double as a byte (by casting to a byte).
 BigInteger ceil()
          Added:
static int compare(double d1, double d2)
          Suppressed: Compares the two specified double values.
 int compareTo(Double anotherDouble)
          Suppressed: Compares two Double objects numerically.
 int compareTo(Object o)
          Enabled: Compares this Double object to another object.
 double compareTo(Object o)
          Added: Used in the expansion of E's comparison operators.
 double cos()
          Added:
static long doubleToLongBits(double value)
          Enabled: 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)
          Enabled: 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()
          Enabled: Returns the double value of this Double object.
 boolean equals(Object obj)
          Suppressed: Compares this object against the specified object.
 double exp()
          Added:
 float floatValue()
          Enabled: Returns the float value of this Double object.
 BigInteger floor()
          Added:
 BigInteger floorDivide(double arg)
          Added: Always gives an integer, resulting from rounding towards negative infinity, ie, flooring.
 int hashCode()
          Suppressed: Returns a hash code for this Double object.
 int intValue()
          Enabled: Returns the value of this Double as an int (by casting to type int).
 boolean isInfinite()
          Enabled: Returns true if this Double value is infinitely large in magnitude, false otherwise.
static boolean isInfinite(double v)
          Enabled: Returns true if the specified number is infinitely large in magnitude, false otherwise.
 boolean isNaN()
          Enabled: Returns true if this Double value is a Not-a-Number (NaN), false otherwise.
static boolean isNaN(double v)
          Enabled: Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.
 boolean isZero()
          Added: Used for arithmetic equality.
 double log()
          Added:
static double longBitsToDouble(long bits)
          Enabled: Returns the double value corresponding to a given bit representation.
 long longValue()
          Enabled: Returns the value of this Double as a long (by casting to type long).
 double max(double arg)
          Added:
 double min(double arg)
          Added:
 double mod(double arg)
          Added: Remainder from the floorDivide operation.
 double modPow(double exp, double modulus)
          Added:
 double multiply(double arg)
          Added:
 double negate()
          Added:
 double next()
          Added: Infinity.next() == Infinity
static double parseDouble(String s)
          Enabled: Returns a new double initialized to the value represented by the specified String, as performed by the valueOf method of class Double.
 double pow(double arg)
          Added:
 double previous()
          Added: (-Infinity).previous() == -Infinity
 double random()
          Added: A number randomly chosen between 0 and this number.
 double remainder(double arg)
          Added: Remainder from truncDivide operation.
 BigInteger round()
          Added:
 short shortValue()
          Enabled: Returns the value of this Double as a short (by casting to a short).
 double sin()
          Added:
 double sqrt()
          Added:
 double subtract(double arg)
          Added:
 double tan()
          Added:
 String toString()
          Suppressed: Returns a string representation of this Double object.
static String toString(double d)
          Enabled: Returns a string representation of the double argument.
 BigInteger truncate()
          Added:
 long truncDivide(double arg)
          Added: Always gives an integer resulting from rounding towards zero, ie, truncating.
static Double valueOf(String s)
          Enabled: 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
 

Field Detail

POSITIVE_INFINITY

public static final double POSITIVE_INFINITY
Enabled: A constant holding the positive infinity of type double. It is equal to the value returned by Double.longBitsToDouble(0x7ff0000000000000L).

NEGATIVE_INFINITY

public static final double NEGATIVE_INFINITY
Enabled: A constant holding the negative infinity of type double. It is equal to the value returned by Double.longBitsToDouble(0xfff0000000000000L).

NaN

public static final double NaN
Enabled: A constant holding a Not-a-Number (NaN) value of type double. It is equivalent to the value returned by Double.longBitsToDouble(0x7ff8000000000000L).

MAX_VALUE

public static final double MAX_VALUE
Enabled: A constant holding the largest positive finite value of type double, (2-2-52)·21023. It is equal to the value returned by: Double.longBitsToDouble(0x7fefffffffffffffL).

MIN_VALUE

public static final double MIN_VALUE
Enabled: A constant holding the smallest positive nonzero value of type double, 2-1074. It is equal to the value returned by Double.longBitsToDouble(0x1L).

TYPE

public static final Class TYPE
Enabled: The Class instance representing the primitive type double.

Since:
JDK1.1

value

private double value
The value of the Double.

serialVersionUID

private static final long serialVersionUID
use serialVersionUID from JDK 1.0.2 for interoperability

Constructor Detail

Double

public Double(double value)
Enabled: Constructs a newly allocated Double object that represents the primitive double argument.

Parameters:
value - the value to be represented by the Double.

Double

public Double(String s)
       throws NumberFormatException
Enabled: Constructs a newly allocated Double object that represents the floating-point value of type double represented by the string. The string is converted to a double value as if by the valueOf method.

Parameters:
s - a string to be converted to a Double.
See Also:
java.lang.Double#valueOf(java.lang.String)
Method Detail

toString

public static String toString(double d)
Enabled: Returns a string representation of the double argument. All characters mentioned below are ASCII characters. How many digits must be printed for the fractional part of m or a? There must be at least one digit to represent the fractional part, and beyond that as many, but only as many, more digits as are needed to uniquely distinguish the argument value from adjacent values of type double. That is, suppose that x is the exact mathematical value represented by the decimal representation produced by this method for a finite nonzero argument d. Then d must be the double value nearest to x; or if two double values are equally close to x, then d must be one of them and the least significant bit of the significand of d must be 0.

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

Parameters:
d - the double to be converted.
Returns:
a string representation of the argument.

valueOf

public static Double valueOf(String s)
                      throws NumberFormatException
Enabled: Returns a Double object holding the double value represented by the argument string s.

If s is null, then a NullPointerException is thrown.

Leading and trailing whitespace characters in s are ignored. The rest of s should constitute a FloatValue as described by the lexical rule:

FloatValue:
Signopt NaN
Signopt Infinity
Signopt FloatingPointLiteral
where Sign and FloatingPointLiteral are as defined in §3.10.2 of the Java Language Specification. If s does not have the form of a FloatValue, then a NumberFormatException is thrown. Otherwise, s is regarded as representing an exact decimal value in the usual "computerized scientific notation"; this exact decimal value is then conceptually converted to an "infinitely precise" binary value that is then rounded to type double by the usual round-to-nearest rule of IEEE 754 floating-point arithmetic, which includes preserving the sign of a zero value. Finally, a Double object representing this double value is returned.

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

Parameters:
s - the string to be parsed.
Returns:
a Double object holding the value represented by the String argument.
NumberFormatException

parseDouble

public static double parseDouble(String s)
                          throws NumberFormatException
Enabled: Returns a new double initialized to the value represented by the specified String, as performed by the valueOf method of class Double.

Parameters:
s - the string to be parsed.
Returns:
the double value represented by the string argument.
NumberFormatException
Since:
1.2
See Also:
java.lang.Double#valueOf(String)

isNaN

public static boolean isNaN(double v)
Enabled: Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

Parameters:
v - the value to be tested.
Returns:
true if the value of the argument is NaN; false otherwise.

isInfinite

public static boolean isInfinite(double v)
Enabled: Returns true if the specified number is infinitely large in magnitude, false otherwise.

Parameters:
v - the value to be tested.
Returns:
true if the value of the argument is positive infinity or negative infinity; false otherwise.

isNaN

public boolean isNaN()
Enabled: Returns true if this Double value is a Not-a-Number (NaN), false otherwise.

Returns:
true if the value represented by this object is NaN; false otherwise.

isInfinite

public boolean isInfinite()
Enabled: Returns true if this Double value is infinitely large in magnitude, false otherwise.

Returns:
true if the value represented by this object is positive infinity or negative infinity; false otherwise.

toString

public String toString()
Suppressed: 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.

Overrides:
toString in class Object
Returns:
a String representation of this object.
See Also:
java.lang.Double#toString(double)

byteValue

public byte byteValue()
Enabled: Returns the value of this Double as a byte (by casting to a byte).

Overrides:
byteValue in class Number
Returns:
the double value represented by this object converted to type byte
Since:
JDK1.1

shortValue

public short shortValue()
Enabled: Returns the value of this Double as a short (by casting to a short).

Overrides:
shortValue in class Number
Returns:
the double value represented by this object converted to type short
Since:
JDK1.1

intValue

public int intValue()
Enabled: Returns the value of this Double as an int (by casting to type int).

Specified by:
intValue in class Number
Returns:
the double value represented by this object converted to type int

longValue

public long longValue()
Enabled: Returns the value of this Double as a long (by casting to type long).

Specified by:
longValue in class Number
Returns:
the double value represented by this object converted to type long

floatValue

public float floatValue()
Enabled: Returns the float value of this Double object.

Specified by:
floatValue in class Number
Returns:
the double value represented by this object converted to type float
Since:
JDK1.0

doubleValue

public double doubleValue()
Enabled: Returns the double value of this Double object.

Specified by:
doubleValue in class Number
Returns:
the double value represented by this object

hashCode

public int hashCode()
Suppressed: 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: 
 (int)(v^(v>>>32))
where v is defined by: 
 long v = Double.doubleToLongBits(this.doubleValue());

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
java.lang.Object#equals(java.lang.Object), java.util.Hashtable

equals

public boolean equals(Object obj)
Suppressed: 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:

This definition allows hash tables to operate properly.

Overrides:
equals in class Object
Parameters:
obj - the object to compare with.
Returns:
true if the objects are the same; false otherwise.
See Also:
java.lang.Double#doubleToLongBits(double)

doubleToLongBits

public static long doubleToLongBits(double value)
Enabled: Returns a representation of the specified floating-point value according to the IEEE 754 floating-point "double format" bit 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.

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).

Parameters:
value - a double precision floating-point number.
Returns:
the bits that represent the floating-point number.

doubleToRawLongBits

public static long doubleToRawLongBits(double value)
Enabled: 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.

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 longBitsToDouble(long) method, will produce a floating-point value the same as the argument to doubleToRawLongBits.

Parameters:
value - a double precision floating-point number.
Returns:
the bits that represent the floating-point number.

longBitsToDouble

public static double longBitsToDouble(long bits)
Enabled: 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 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·2e-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.

Parameters:
bits - any long integer.
Returns:
the double floating-point value with the same bit pattern.

compareTo

public int compareTo(Double anotherDouble)
Suppressed: 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: This ensures that Double.compareTo(Object) (which forwards its behavior to this method) obeys the general contract for Comparable.compareTo, and that the natural order on Doubles is consistent with equals.

Parameters:
anotherDouble - the Double to be compared.
Returns:
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.
Since:
1.2
See Also:
Comparable.compareTo(Object)

compareTo

public int compareTo(Object o)
Enabled: Compares this Double object to another object. If the object is a Double, this function behaves like compareTo(Double). Otherwise, it throws a ClassCastException (as Double objects are comparable only to other Double objects).

Specified by:
compareTo in interface Comparable
Parameters:
o - the Object to be compared.
Returns:
the value 0 if the argument is a Double numerically equal to this Double; a value less than 0 if the argument is a Double numerically greater than this Double; and a value greater than 0 if the argument is a Double numerically less than this Double.
Since:
1.2
See Also:
java.lang.Comparable

compare

public static int compare(double d1,
                          double d2)
Suppressed: Compares the two specified 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))

Parameters:
d1 - the first double to compare
d2 - the second double to compare
Returns:
the value 0 if d1 is numerically equal to d2; a value less than 0 if d1 is numerically less than d2; and a value greater than 0 if d1 is numerically greater than d2.
Since:
1.4

sin

public double sin()
Added:

cos

public double cos()
Added:

tan

public double tan()
Added:

atan2

public double atan2(double arg)
Added:

sqrt

public double sqrt()
Added:

pow

public double pow(double arg)
Added:

compareTo

public double compareTo(Object o)
Added: Used in the expansion of E's comparison operators. As is Java, is E, NaNs are incomparable to everything else, and so yield a NaN as an answer.

Specified by:
compareTo in interface Comparable
Parameters:
o - the Object to be compared.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

min

public double min(double arg)
Added:

add

public double add(double arg)
Added:

next

public double next()
Added: Infinity.next() == Infinity

NaN.next() == NaN

Double.getMAX_VALUE().next() == Infinity

(-Infinity).next() == -(Double.getMAX_VALUE())

otherwise, *num*.next() == *next representable number*

max

public double max(double arg)
Added:

previous

public double previous()
Added: (-Infinity).previous() == -Infinity

NaN.previous() == NaN

-(Double.getMAX_VALUE()).previous() == -Infinity

Infinity.previous() == Double.getMAX_VALUE()

otherwise, *num*.previous() == *previous representable number*

asin

public double asin()
Added:

acos

public double acos()
Added:

atan

public double atan()
Added:

exp

public double exp()
Added:

log

public double log()
Added:

ceil

public BigInteger ceil()
Added:

floor

public BigInteger floor()
Added:

round

public BigInteger round()
Added:

random

public double random()
Added: A number randomly chosen between 0 and this number. Only as good as Math.random(), which it uses.

abs

public double abs()
Added:

multiply

public double multiply(double arg)
Added:

subtract

public double subtract(double arg)
Added:

remainder

public double remainder(double arg)
Added: Remainder from truncDivide operation. 

      (a truncDivide b)*b + (a remainder b) == a
      [ 5, 3]: ( 1* 3) +  2 ==  5
      [ 5,-3]: (-1*-3) +  2 ==  5
      [-5, 3]: (-1* 3) + -2 == -5
      [-5,-3]: ( 1*-3) + -2 == -5

Therefore, if the result is non-zero, the sign of the result must be the same as the sign of a. This corresponds to the Java and E "%" operator.

negate

public double negate()
Added:

mod

public double mod(double arg)
Added: Remainder from the floorDivide operation. 

     (a floorDivide b)*b + (a modulo b) == a
      [ 5, 3]: ( 1* 3) +  2 ==  5
      [ 5,-3]: (-2*-3) + -1 ==  5
      [-5, 3]: (-2* 3) +  1 == -5
      [-5,-3]: ( 1*-3) + -2 == -5

Therefore, if the result is non-zero, the sign of the result must be the same as the sign of b, and so the result ranges from 0 inclusive to b exclusive. This corresponds to the E "%%" operator. When b >= 0, it also corresponds to Java's BigInteger.mod().

modPow

public double modPow(double exp,
                     double modulus)
Added:

isZero

public boolean isZero()
Added: Used for arithmetic equality. NaN says false

truncate

public BigInteger truncate()
Added:

approxDivide

public double approxDivide(double arg)
Added: Always gives back a double This corresponds to the Java floating-point "/" operator and the E "/" operator.

aboveZero

public boolean aboveZero()
Added: Used in the expansion of E's ">" operator. NaN says false

atLeastZero

public boolean atLeastZero()
Added: Used in the expansion of E's ">=" operator. NaN says false

atMostZero

public boolean atMostZero()
Added: Used in the expansion of E's "<=" operator. NaN says false

belowZero

public boolean belowZero()
Added: Used in the expansion of E's "<" operator. NaN says false

floorDivide

public BigInteger floorDivide(double arg)
Added: Always gives an integer, resulting from rounding towards negative infinity, ie, flooring. This corresponds to the E "_/" operator.

truncDivide

public long truncDivide(double arg)
Added: Always gives an integer resulting from rounding towards zero, ie, truncating. This corresponds to the Java integer "/" operator.

Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
comments?