FileDocCategorySizeDatePackage
Double.javaAPI DocAndroid 1.5 API16931Wed May 06 22:41:04 BST 2009java.lang

Double

public final class Double extends Number implements Comparable
The wrapper for the primitive type {@code double}.
see
java.lang.Number
since
Android 1.0

Fields Summary
private static final long
serialVersionUID
private final double
value
The value which the receiver represents.
public static final double
MAX_VALUE
Constant for the maximum {@code double} value, (2 - 2-52) * 21023.
public static final double
MIN_VALUE
Constant for the minimum {@code double} value, 2-1074.
public static final double
NaN
Constant for the Not-a-Number (NaN) value of the {@code double} type.
public static final double
POSITIVE_INFINITY
Constant for the Positive Infinity value of the {@code double} type.
public static final double
NEGATIVE_INFINITY
Constant for the Negative Infinity value of the {@code double} type.
public static final Class
TYPE
The {@link Class} object that represents the primitive type {@code double}.
public static final int
SIZE
Constant for the number of bits needed to represent a {@code double} in two's complement form.
Constructors Summary
public Double(double value)
Constructs a new {@code Double} with the specified primitive double value.

param
value the primitive double value to store in the new instance.
since
Android 1.0


                                               
       
        this.value = value;
    
public Double(String string)
Constructs a new {@code Double} from the specified string.

param
string the string representation of a double value.
throws
NumberFormatException if {@code string} can not be decoded into a double value.
see
#parseDouble(String)
since
Android 1.0

        this(parseDouble(string));
    
Methods Summary
public bytebyteValue()

        return (byte) value;
    
public static intcompare(double double1, double double2)
Compares the two specified double values. There are two special cases:
  • {@code Double.NaN} is equal to {@code Double.NaN} and it is greater than any other double value, including {@code Double.POSITIVE_INFINITY};
  • +0.0d is greater than -0.0d

param
double1 the first value to compare.
param
double2 the second value to compare.
return
a negative value if {@code double1} is less than {@code double2}; 0 if {@code double1} and {@code double2} are equal; a positive value if {@code double1} is greater than {@code double2}.
since
Android 1.0

        long d1, d2;
        long NaNbits = Double.doubleToLongBits(Double.NaN);
        if ((d1 = Double.doubleToLongBits(double1)) == NaNbits) {
            if (Double.doubleToLongBits(double2) == NaNbits) {
                return 0;
            }
            return 1;
        }
        if ((d2 = Double.doubleToLongBits(double2)) == NaNbits) {
            return -1;
        }
        if (double1 == double2) {
            if (d1 == d2) {
                return 0;
            }
            // check for -0
            return d1 > d2 ? 1 : -1;
        }
        return double1 > double2 ? 1 : -1;
    
public intcompareTo(java.lang.Double object)
Compares this object to the specified double object to determine their relative order. There are two special cases:
  • {@code Double.NaN} is equal to {@code Double.NaN} and it is greater than any other double value, including {@code Double.POSITIVE_INFINITY};
  • +0.0d is greater than -0.0d

param
object the double object to compare this object to.
return
a negative value if the value of this double is less than the value of {@code object}; 0 if the value of this double and the value of {@code object} are equal; a positive value if the value of this double is greater than the value of {@code object}.
see
java.lang.Comparable
since
Android 1.0

        long d1, d2;
        long NaNbits = Double.doubleToLongBits(Double.NaN);
        if ((d1 = Double.doubleToLongBits(value)) == NaNbits) {
            if (Double.doubleToLongBits(object.value) == NaNbits) {
                return 0;
            }
            return 1;
        }
        if ((d2 = Double.doubleToLongBits(object.value)) == NaNbits) {
            return -1;
        }
        if (value == object.value) {
            if (d1 == d2) {
                return 0;
            }
            // check for -0
            return d1 > d2 ? 1 : -1;
        }
        return value > object.value ? 1 : -1;
    
public static native longdoubleToLongBits(double value)
Converts the specified double value to a binary representation conforming to the IEEE 754 floating-point double precision bit layout. All Not-a-Number (NaN) values are converted to a single NaN representation ({@code 0x7ff8000000000000L}).

param
value the double value to convert.
return
the IEEE 754 floating-point double precision representation of {@code value}.
see
#doubleToRawLongBits(double)
see
#longBitsToDouble(long)
since
Android 1.0

public static native longdoubleToRawLongBits(double value)
Converts the specified double value to a binary representation conforming to the IEEE 754 floating-point double precision bit layout. Not-a-Number (NaN) values are preserved.

param
value the double value to convert.
return
the IEEE 754 floating-point double precision representation of {@code value}.
see
#doubleToLongBits(double)
see
#longBitsToDouble(long)
since
Android 1.0

public doubledoubleValue()
Gets the primitive value of this double.

return
this object's primitive value.
since
Android 1.0

        return value;
    
public booleanequals(java.lang.Object object)
Compares this object with the specified object and indicates if they are equal. In order to be equal, {@code object} must be an instance of {@code Double} and the bit pattern of its double value is the same as this object's.

param
object the object to compare this double with.
return
{@code true} if the specified object is equal to this {@code Double}; {@code false} otherwise.
since
Android 1.0

        return (object == this)
                || (object instanceof Double)
                && (doubleToLongBits(this.value) == doubleToLongBits(((Double) object).value));
    
public floatfloatValue()

        return (float) value;
    
public inthashCode()

        long v = doubleToLongBits(value);
        return (int) (v ^ (v >>> 32));
    
public intintValue()

        return (int) value;
    
public booleanisInfinite()
Indicates whether this object represents an infinite value.

return
{@code true} if the value of this double is positive or negative infinity; {@code false} otherwise.
since
Android 1.0

        return isInfinite(value);
    
public static booleanisInfinite(double d)
Indicates whether the specified double represents an infinite value.

param
d the double to check.
return
{@code true} if the value of {@code d} is positive or negative infinity; {@code false} otherwise.
since
Android 1.0

        return (d == POSITIVE_INFINITY) || (d == NEGATIVE_INFINITY);
    
public booleanisNaN()
Indicates whether this object is a Not-a-Number (NaN) value.

return
{@code true} if this double is Not-a-Number; {@code false} if it is a (potentially infinite) double number.
since
Android 1.0

        return isNaN(value);
    
public static booleanisNaN(double d)
Indicates whether the specified double is a Not-a-Number (NaN) value.

param
d the double value to check.
return
{@code true} if {@code d} is Not-a-Number; {@code false} if it is a (potentially infinite) double number.
since
Android 1.0

        return d != d;
    
public static native doublelongBitsToDouble(long bits)
Converts the specified IEEE 754 floating-point double precision bit pattern to a Java double value.

param
bits the IEEE 754 floating-point double precision representation of a double value.
return
the double value converted from {@code bits}.
see
#doubleToLongBits(double)
see
#doubleToRawLongBits(double)
since
Android 1.0

public longlongValue()

        return (long) value;
    
public static doubleparseDouble(java.lang.String string)
Parses the specified string as a double value.

param
string the string representation of a double value.
return
the primitive double value represented by {@code string}.
throws
NumberFormatException if {@code string} is {@code null}, has a length of zero or can not be parsed as a double value.
since
Android 1.0

        return org.apache.harmony.luni.util.FloatingPointParser
                .parseDouble(string);
    
public shortshortValue()

        return (short) value;
    
public static java.lang.StringtoHexString(double d)
Converts the specified double into its hexadecimal string representation.

param
d the double to convert.
return
the hexadecimal string representation of {@code d}.
since
Android 1.0

        /*
         * Reference: http://en.wikipedia.org/wiki/IEEE_754
         */
        if (d != d) {
            return "NaN"; //$NON-NLS-1$
        }
        if (d == POSITIVE_INFINITY) {
            return "Infinity"; //$NON-NLS-1$
        }
        if (d == NEGATIVE_INFINITY) {
            return "-Infinity"; //$NON-NLS-1$
        }

        long bitValue = doubleToLongBits(d);

        boolean negative = (bitValue & 0x8000000000000000L) != 0;
        // mask exponent bits and shift down
        long exponent = (bitValue & 0x7FF0000000000000L) >>> 52;
        // mask significand bits and shift up
        long significand = bitValue & 0x000FFFFFFFFFFFFFL;

        if (exponent == 0 && significand == 0) {
            return (negative ? "-0x0.0p0" : "0x0.0p0"); //$NON-NLS-1$ //$NON-NLS-2$
        }

        StringBuilder hexString = new StringBuilder(10);
        if (negative) {
            hexString.append("-0x"); //$NON-NLS-1$
        } else {
            hexString.append("0x"); //$NON-NLS-1$
        }

        if (exponent == 0) { // denormal (subnormal) value
            hexString.append("0."); //$NON-NLS-1$
            // significand is 52-bits, so there can be 13 hex digits
            int fractionDigits = 13;
            // remove trailing hex zeros, so Integer.toHexString() won't print
            // them
            while ((significand != 0) && ((significand & 0xF) == 0)) {
                significand >>>= 4;
                fractionDigits--;
            }
            // this assumes Integer.toHexString() returns lowercase characters
            String hexSignificand = Long.toHexString(significand);

            // if there are digits left, then insert some '0' chars first
            if (significand != 0 && fractionDigits > hexSignificand.length()) {
                int digitDiff = fractionDigits - hexSignificand.length();
                while (digitDiff-- != 0) {
                    hexString.append('0");
                }
            }
            hexString.append(hexSignificand);
            hexString.append("p-1022"); //$NON-NLS-1$
        } else { // normal value
            hexString.append("1."); //$NON-NLS-1$
            // significand is 52-bits, so there can be 13 hex digits
            int fractionDigits = 13;
            // remove trailing hex zeros, so Integer.toHexString() won't print
            // them
            while ((significand != 0) && ((significand & 0xF) == 0)) {
                significand >>>= 4;
                fractionDigits--;
            }
            // this assumes Integer.toHexString() returns lowercase characters
            String hexSignificand = Long.toHexString(significand);

            // if there are digits left, then insert some '0' chars first
            if (significand != 0 && fractionDigits > hexSignificand.length()) {
                int digitDiff = fractionDigits - hexSignificand.length();
                while (digitDiff-- != 0) {
                    hexString.append('0");
                }
            }

            hexString.append(hexSignificand);
            hexString.append('p");
            // remove exponent's 'bias' and convert to a string
            hexString.append(Long.toString(exponent - 1023));
        }
        return hexString.toString();
    
public java.lang.StringtoString()

        return Double.toString(value);
    
public static java.lang.StringtoString(double d)
Returns a string containing a concise, human-readable description of the specified double value.

param
d the double to convert to a string.
return
a printable representation of {@code d}.
since
Android 1.0

        return org.apache.harmony.luni.util.NumberConverter.convert(d);
    
public static java.lang.DoublevalueOf(java.lang.String string)
Parses the specified string as a double value.

param
string the string representation of a double value.
return
a {@code Double} instance containing the double value represented by {@code string}.
throws
NumberFormatException if {@code string} is {@code null}, has a length of zero or can not be parsed as a double value.
see
#parseDouble(String)
since
Android 1.0

        return new Double(parseDouble(string));
    
public static java.lang.DoublevalueOf(double d)
Returns a {@code Double} instance for the specified double value.

param
d the double value to store in the instance.
return
a {@code Double} instance containing {@code d}.
since
Android 1.0

        return new Double(d);