bug fixes + annotations
[IRC.git] / Robust / src / ClassLibrary / SSJava / Double.java
index 8af978abd5347fb0e4d76215f49878b2cf4b4df4..4a5bdcff6ef69ab98a800b5497adc798eb18d0d3 100644 (file)
 
 //package java.lang;
 
-
 /**
  * Instances of class <code>Double</code> represent primitive
  * <code>double</code> values.
- *
+ * 
  * Additionally, this class provides various helper functions and variables
  * related to doubles.
- *
+ * 
  * @author Paul Fisher
  * @author Andrew Haley (aph@cygnus.com)
  * @author Eric Blake (ebb9@email.byu.edu)
  * @since 1.0
  * @status partly updated to 1.5
  */
-public final class Double extends Number //implements Comparable<Double>
+@LATTICE("V")
+@METHODDEFAULT("OUT<THIS,THIS<IN,THISLOC=THIS,RETURNLOC=OUT")
+public final class Double extends Number // implements Comparable<Double>
 {
   /**
    * Compatible with JDK 1.0+.
    */
   /**
    * The immutable value of this Double.
-   *
+   * 
    * @serial the wrapped double
    */
+  @LOC("V")
   private final double value;
 
   /**
    * Create a <code>Double</code> from the primitive <code>double</code>
    * specified.
-   *
-   * @param value the <code>double</code> argument
+   * 
+   * @param value
+   *          the <code>double</code> argument
    */
   public Double(double value) {
     this.value = value;
   }
 
   /**
-   * Create a <code>Double</code> from the specified <code>String</code>.
-   * This method calls <code>Double.parseDouble()</code>.
-   *
-   * @param s the <code>String</code> to convert
-   * @throws NumberFormatException if <code>s</code> cannot be parsed as a
-   *         <code>double</code>
-   * @throws NullPointerException if <code>s</code> is null
+   * Create a <code>Double</code> from the specified <code>String</code>. This
+   * method calls <code>Double.parseDouble()</code>.
+   * 
+   * @param s
+   *          the <code>String</code> to convert
+   * @throws NumberFormatException
+   *           if <code>s</code> cannot be parsed as a <code>double</code>
+   * @throws NullPointerException
+   *           if <code>s</code> is null
    * @see #parseDouble(String)
    */
   public Double(String s) {
@@ -91,126 +96,120 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Convert the <code>double</code> to a <code>String</code>.
-   * Floating-point string representation is fairly complex: here is a
-   * rundown of the possible values.  "<code>[-]</code>" indicates that a
-   * negative sign will be printed if the value (or exponent) is negative.
-   * "<code>&lt;number&gt;</code>" means a string of digits ('0' to '9').
-   * "<code>&lt;digit&gt;</code>" means a single digit ('0' to '9').<br>
-   *
+   * Convert the <code>double</code> to a <code>String</code>. Floating-point
+   * string representation is fairly complex: here is a rundown of the possible
+   * values. "<code>[-]</code>" indicates that a negative sign will be printed
+   * if the value (or exponent) is negative. "<code>&lt;number&gt;</code>" means
+   * a string of digits ('0' to '9'). "<code>&lt;digit&gt;</code>" means a
+   * single digit ('0' to '9').<br>
+   * 
    * <table border=1>
-   * <tr><th>Value of Double</th><th>String Representation</th></tr>
-   * <tr><td>[+-] 0</td> <td><code>[-]0.0</code></td></tr>
-   * <tr><td>Between [+-] 10<sup>-3</sup> and 10<sup>7</sup>, exclusive</td>
-   *     <td><code>[-]number.number</code></td></tr>
-   * <tr><td>Other numeric value</td>
-   *     <td><code>[-]&lt;digit&gt;.&lt;number&gt;
-   *          E[-]&lt;number&gt;</code></td></tr>
-   * <tr><td>[+-] infinity</td> <td><code>[-]Infinity</code></td></tr>
-   * <tr><td>NaN</td> <td><code>NaN</code></td></tr>
+   * <tr>
+   * <th>Value of Double</th>
+   * <th>String Representation</th>
+   * </tr>
+   * <tr>
+   * <td>[+-] 0</td>
+   * <td><code>[-]0.0</code></td>
+   * </tr>
+   * <tr>
+   * <td>Between [+-] 10<sup>-3</sup> and 10<sup>7</sup>, exclusive</td>
+   * <td><code>[-]number.number</code></td>
+   * </tr>
+   * <tr>
+   * <td>Other numeric value</td>
+   * <td><code>[-]&lt;digit&gt;.&lt;number&gt;
+   *          E[-]&lt;number&gt;</code></td>
+   * </tr>
+   * <tr>
+   * <td>[+-] infinity</td>
+   * <td><code>[-]Infinity</code></td>
+   * </tr>
+   * <tr>
+   * <td>NaN</td>
+   * <td><code>NaN</code></td>
+   * </tr>
    * </table>
-   *
-   * Yes, negative zero <em>is</em> a possible value.  Note that there is
-   * <em>always</em> a <code>.</code> and at least one digit printed after
-   * it: even if the number is 3, it will be printed as <code>3.0</code>.
-   * After the ".", all digits will be printed except trailing zeros. The
-   * result is rounded to the shortest decimal number which will parse back
-   * to the same double.
-   *
-   * <p>To create other output formats, use {@link java.text.NumberFormat}.
-   *
+   * 
+   * Yes, negative zero <em>is</em> a possible value. Note that there is
+   * <em>always</em> a <code>.</code> and at least one digit printed after it:
+   * even if the number is 3, it will be printed as <code>3.0</code>. After the
+   * ".", all digits will be printed except trailing zeros. The result is
+   * rounded to the shortest decimal number which will parse back to the same
+   * double.
+   * 
+   * <p>
+   * To create other output formats, use {@link java.text.NumberFormat}.
+   * 
    * @XXX specify where we are not in accord with the spec.
-   *
-   * @param d the <code>double</code> to convert
+   * 
+   * @param d
+   *          the <code>double</code> to convert
    * @return the <code>String</code> representing the <code>double</code>
    */
-  public static String toString(double d) {
+  public static String toString(@LOC("IN") double d) {
     return String.valueOf(d);
   }
 
   /**
-   * Convert a double value to a hexadecimal string.  This converts as
-   * follows:
+   * Convert a double value to a hexadecimal string. This converts as follows:
    * <ul>
-   * <li> A NaN value is converted to the string "NaN".
-   * <li> Positive infinity is converted to the string "Infinity".
-   * <li> Negative infinity is converted to the string "-Infinity".
-   * <li> For all other values, the first character of the result is '-'
-   * if the value is negative.  This is followed by '0x1.' if the
-   * value is normal, and '0x0.' if the value is denormal.  This is
-   * then followed by a (lower-case) hexadecimal representation of the
-   * mantissa, with leading zeros as required for denormal values.
-   * The next character is a 'p', and this is followed by a decimal
-   * representation of the unbiased exponent.
+   * <li>A NaN value is converted to the string "NaN".
+   * <li>Positive infinity is converted to the string "Infinity".
+   * <li>Negative infinity is converted to the string "-Infinity".
+   * <li>For all other values, the first character of the result is '-' if the
+   * value is negative. This is followed by '0x1.' if the value is normal, and
+   * '0x0.' if the value is denormal. This is then followed by a (lower-case)
+   * hexadecimal representation of the mantissa, with leading zeros as required
+   * for denormal values. The next character is a 'p', and this is followed by a
+   * decimal representation of the unbiased exponent.
    * </ul>
-   * @param d the double value
+   * 
+   * @param d
+   *          the double value
    * @return the hexadecimal string representation
    * @since 1.5
    */
   public static String toHexString(double d) {
     /*
-       if (isNaN(d))
-       return "NaN";
-       if (isInfinite(d))
-       return d < 0 ? "-Infinity" : "Infinity";
-
-       long bits = doubleToLongBits(d);
-       StringBuilder result = new StringBuilder();
-
-       if (bits < 0)
-       result.append('-');
-       result.append("0x");
-
-       final int mantissaBits = 52;
-       final int exponentBits = 11;
-       long mantMask = (1L << mantissaBits) - 1;
-       long mantissa = bits & mantMask;
-       long expMask = (1L << exponentBits) - 1;
-       long exponent = (bits >>> mantissaBits) & expMask;
-
-       result.append(exponent == 0 ? '0' : '1');
-       result.append('.');
-       result.append(Long.toHexString(mantissa));
-       if (exponent == 0 && mantissa != 0)
-       {
-        // Treat denormal specially by inserting '0's to make
-        // the length come out right.  The constants here are
-        // to account for things like the '0x'.
-        int offset = 4 + ((bits < 0) ? 1 : 0);
-        // The silly +3 is here to keep the code the same between
-        // the Float and Double cases.  In Float the value is
-        // not a multiple of 4.
-        int desiredLength = offset + (mantissaBits + 3) / 4;
-        while (result.length() < desiredLength)
-          result.insert(offset, '0');
-       }
-       result.append('p');
-       if (exponent == 0 && mantissa == 0)
-       {
-        // Zero, so do nothing special.
-       }
-       else
-       {
-        // Apply bias.
-        boolean denormal = exponent == 0;
-        exponent -= (1 << (exponentBits - 1)) - 1;
-        // Handle denormal.
-        if (denormal)
-     ++exponent;
-       }
-
-       result.append(Long.toString(exponent));
-       return result.toString();
+     * if (isNaN(d)) return "NaN"; if (isInfinite(d)) return d < 0 ? "-Infinity"
+     * : "Infinity";
+     * 
+     * long bits = doubleToLongBits(d); StringBuilder result = new
+     * StringBuilder();
+     * 
+     * if (bits < 0) result.append('-'); result.append("0x");
+     * 
+     * final int mantissaBits = 52; final int exponentBits = 11; long mantMask =
+     * (1L << mantissaBits) - 1; long mantissa = bits & mantMask; long expMask =
+     * (1L << exponentBits) - 1; long exponent = (bits >>> mantissaBits) &
+     * expMask;
+     * 
+     * result.append(exponent == 0 ? '0' : '1'); result.append('.');
+     * result.append(Long.toHexString(mantissa)); if (exponent == 0 && mantissa
+     * != 0) { // Treat denormal specially by inserting '0's to make // the
+     * length come out right. The constants here are // to account for things
+     * like the '0x'. int offset = 4 + ((bits < 0) ? 1 : 0); // The silly +3 is
+     * here to keep the code the same between // the Float and Double cases. In
+     * Float the value is // not a multiple of 4. int desiredLength = offset +
+     * (mantissaBits + 3) / 4; while (result.length() < desiredLength)
+     * result.insert(offset, '0'); } result.append('p'); if (exponent == 0 &&
+     * mantissa == 0) { // Zero, so do nothing special. } else { // Apply bias.
+     * boolean denormal = exponent == 0; exponent -= (1 << (exponentBits - 1)) -
+     * 1; // Handle denormal. if (denormal) ++exponent; }
+     * 
+     * result.append(Long.toString(exponent)); return result.toString();
      */
     return "0x0";
   }
 
   /**
-   * Returns a <code>Double</code> object wrapping the value.
-   * In contrast to the <code>Double</code> constructor, this method
-   * may cache some values.  It is used by boxing conversion.
-   *
-   * @param val the value to wrap
+   * Returns a <code>Double</code> object wrapping the value. In contrast to the
+   * <code>Double</code> constructor, this method may cache some values. It is
+   * used by boxing conversion.
+   * 
+   * @param val
+   *          the value to wrap
    * @return the <code>Double</code>
    * @since 1.5
    */
@@ -221,12 +220,14 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Create a new <code>Double</code> object using the <code>String</code>.
-   *
-   * @param s the <code>String</code> to convert
+   * 
+   * @param s
+   *          the <code>String</code> to convert
    * @return the new <code>Double</code>
-   * @throws NumberFormatException if <code>s</code> cannot be parsed as a
-   *         <code>double</code>
-   * @throws NullPointerException if <code>s</code> is null.
+   * @throws NumberFormatException
+   *           if <code>s</code> cannot be parsed as a <code>double</code>
+   * @throws NullPointerException
+   *           if <code>s</code> is null.
    * @see #parseDouble(String)
    */
   public static Double valueOf(String s) {
@@ -236,6 +237,7 @@ public final class Double extends Number //implements Comparable<Double>
   /**
    * Parse the specified <code>String</code> as a <code>double</code>. The
    * extended BNF grammar is as follows:<br>
+   * 
    * <pre>
    * <em>DecodableString</em>:
    *      ( [ <code>-</code> | <code>+</code> ] <code>NaN</code> )
@@ -252,30 +254,35 @@ public final class Double extends Number //implements Comparable<Double>
    *              [ <code>-</code> | <code>+</code> ] { <em>Digit</em> }+ )
    * <em>Digit</em>: <em><code>'0'</code> through <code>'9'</code></em>
    * </pre>
-   *
-   * <p>NaN and infinity are special cases, to allow parsing of the output
-   * of toString.  Otherwise, the result is determined by calculating
-   * <em>n * 10<sup>exponent</sup></em> to infinite precision, then rounding
-   * to the nearest double. Remember that many numbers cannot be precisely
-   * represented in floating point. In case of overflow, infinity is used,
-   * and in case of underflow, signed zero is used. Unlike Integer.parseInt,
-   * this does not accept Unicode digits outside the ASCII range.
-   *
-   * <p>If an unexpected character is found in the <code>String</code>, a
-   * <code>NumberFormatException</code> will be thrown.  Leading and trailing
-   * 'whitespace' is ignored via <code>String.trim()</code>, but spaces
-   * internal to the actual number are not allowed.
-   *
-   * <p>To parse numbers according to another format, consider using
+   * 
+   * <p>
+   * NaN and infinity are special cases, to allow parsing of the output of
+   * toString. Otherwise, the result is determined by calculating
+   * <em>n * 10<sup>exponent</sup></em> to infinite precision, then rounding to
+   * the nearest double. Remember that many numbers cannot be precisely
+   * represented in floating point. In case of overflow, infinity is used, and
+   * in case of underflow, signed zero is used. Unlike Integer.parseInt, this
+   * does not accept Unicode digits outside the ASCII range.
+   * 
+   * <p>
+   * If an unexpected character is found in the <code>String</code>, a
+   * <code>NumberFormatException</code> will be thrown. Leading and trailing
+   * 'whitespace' is ignored via <code>String.trim()</code>, but spaces internal
+   * to the actual number are not allowed.
+   * 
+   * <p>
+   * To parse numbers according to another format, consider using
    * {@link java.text.NumberFormat}.
-   *
+   * 
    * @XXX specify where/how we are not in accord with the spec.
-   *
-   * @param str the <code>String</code> to convert
+   * 
+   * @param str
+   *          the <code>String</code> to convert
    * @return the <code>double</code> value of <code>s</code>
-   * @throws NumberFormatException if <code>s</code> cannot be parsed as a
-   *         <code>double</code>
-   * @throws NullPointerException if <code>s</code> is null
+   * @throws NumberFormatException
+   *           if <code>s</code> cannot be parsed as a <code>double</code>
+   * @throws NullPointerException
+   *           if <code>s</code> is null
    * @see #MIN_VALUE
    * @see #MAX_VALUE
    * @see #POSITIVE_INFINITY
@@ -287,27 +294,30 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   public static native double nativeparsedouble(String str);
+
   public static native double nativeparsedouble(int start, int length, byte[] str);
 
   /**
-   * Return <code>true</code> if the <code>double</code> has the same
-   * value as <code>NaN</code>, otherwise return <code>false</code>.
-   *
-   * @param v the <code>double</code> to compare
+   * Return <code>true</code> if the <code>double</code> has the same value as
+   * <code>NaN</code>, otherwise return <code>false</code>.
+   * 
+   * @param v
+   *          the <code>double</code> to compare
    * @return whether the argument is <code>NaN</code>.
    */
-  public static boolean isNaN(double v) {
+  public static boolean isNaN(@LOC("IN") double v) {
     // This works since NaN != NaN is the only reflexive inequality
     // comparison which returns true.
     return v != v;
   }
 
   /**
-   * Return <code>true</code> if the <code>double</code> has a value
-   * equal to either <code>NEGATIVE_INFINITY</code> or
-   * <code>POSITIVE_INFINITY</code>, otherwise return <code>false</code>.
-   *
-   * @param v the <code>double</code> to compare
+   * Return <code>true</code> if the <code>double</code> has a value equal to
+   * either <code>NEGATIVE_INFINITY</code> or <code>POSITIVE_INFINITY</code>,
+   * otherwise return <code>false</code>.
+   * 
+   * @param v
+   *          the <code>double</code> to compare
    * @return whether the argument is (-/+) infinity.
    */
   public static boolean isInfinite(double v) {
@@ -315,9 +325,9 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Return <code>true</code> if the value of this <code>Double</code>
-   * is the same as <code>NaN</code>, otherwise return <code>false</code>.
-   *
+   * Return <code>true</code> if the value of this <code>Double</code> is the
+   * same as <code>NaN</code>, otherwise return <code>false</code>.
+   * 
    * @return whether this <code>Double</code> is <code>NaN</code>
    */
   public boolean isNaN() {
@@ -325,10 +335,10 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Return <code>true</code> if the value of this <code>Double</code>
-   * is the same as <code>NEGATIVE_INFINITY</code> or
-   * <code>POSITIVE_INFINITY</code>, otherwise return <code>false</code>.
-   *
+   * Return <code>true</code> if the value of this <code>Double</code> is the
+   * same as <code>NEGATIVE_INFINITY</code> or <code>POSITIVE_INFINITY</code>,
+   * otherwise return <code>false</code>.
+   * 
    * @return whether this <code>Double</code> is (-/+) infinity
    */
   public boolean isInfinite() {
@@ -336,10 +346,10 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Convert the <code>double</code> value of this <code>Double</code>
-   * to a <code>String</code>.  This method calls
-   * <code>Double.toString(double)</code> to do its dirty work.
-   *
+   * Convert the <code>double</code> value of this <code>Double</code> to a
+   * <code>String</code>. This method calls <code>Double.toString(double)</code>
+   * to do its dirty work.
+   * 
    * @return the <code>String</code> representation
    * @see #toString(double)
    */
@@ -349,7 +359,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code> as a <code>byte</code>.
-   *
+   * 
    * @return the byte value
    * @since 1.1
    */
@@ -359,7 +369,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code> as a <code>short</code>.
-   *
+   * 
    * @return the short value
    * @since 1.1
    */
@@ -369,7 +379,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code> as an <code>int</code>.
-   *
+   * 
    * @return the int value
    */
   public int intValue() {
@@ -378,7 +388,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code> as a <code>long</code>.
-   *
+   * 
    * @return the long value
    */
   public long longValue() {
@@ -387,7 +397,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code> as a <code>float</code>.
-   *
+   * 
    * @return the float value
    */
   public float floatValue() {
@@ -396,7 +406,7 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Return the value of this <code>Double</code>.
-   *
+   * 
    * @return the double value
    */
   public double doubleValue() {
@@ -404,16 +414,16 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Return a hashcode representing this Object. <code>Double</code>'s hash
-   * code is calculated by:<br>
+   * Return a hashcode representing this Object. <code>Double</code>'s hash code
+   * is calculated by:<br>
    * <code>long v = Double.doubleToLongBits(doubleValue());<br>
    *    int hash = (int)(v^(v&gt;&gt;32))</code>.
-   *
+   * 
    * @return this Object's hash code
    * @see #doubleToLongBits(double)
    */
   public int hashCode() {
-    long v = doubleToLongBits(value);
+    @LOC("OUT") long v = doubleToLongBits(value);
     return (int) (v ^ (v >>> 32));
   }
 
@@ -423,12 +433,14 @@ public final class Double extends Number //implements Comparable<Double>
    * two doubles with <code>==</code>, this treats two instances of
    * <code>Double.NaN</code> as equal, but treats <code>0.0</code> and
    * <code>-0.0</code> as unequal.
-   *
-   * <p>Note that <code>d1.equals(d2)</code> is identical to
+   * 
+   * <p>
+   * Note that <code>d1.equals(d2)</code> is identical to
    * <code>doubleToLongBits(d1.doubleValue()) ==
    *    doubleToLongBits(d2.doubleValue())</code>.
-   *
-   * @param obj the object to compare
+   * 
+   * @param obj
+   *          the object to compare
    * @return whether the objects are semantically equal
    */
   public boolean equals(Object obj) {
@@ -447,73 +459,75 @@ public final class Double extends Number //implements Comparable<Double>
 
   /**
    * Convert the double to the IEEE 754 floating-point "double format" bit
-   * layout. Bit 63 (the most significant) is the sign bit, bits 62-52
-   * (masked by 0x7ff0000000000000L) represent the exponent, and bits 51-0
-   * (masked by 0x000fffffffffffffL) are the mantissa. This function
-   * collapses all versions of NaN to 0x7ff8000000000000L. The result of this
-   * function can be used as the argument to
-   * <code>Double.longBitsToDouble(long)</code> to obtain the original
-   * <code>double</code> value.
-   *
-   * @param value the <code>double</code> to convert
+   * layout. Bit 63 (the most significant) is the sign bit, bits 62-52 (masked
+   * by 0x7ff0000000000000L) represent the exponent, and bits 51-0 (masked by
+   * 0x000fffffffffffffL) are the mantissa. This function collapses all versions
+   * of NaN to 0x7ff8000000000000L. The result of this function can be used as
+   * the argument to <code>Double.longBitsToDouble(long)</code> to obtain the
+   * original <code>double</code> value.
+   * 
+   * @param value
+   *          the <code>double</code> to convert
    * @return the bits of the <code>double</code>
    * @see #longBitsToDouble(long)
    */
-  public static long doubleToLongBits(double value) {
+  public static long doubleToLongBits(@LOC("IN") double value) {
     if (isNaN(value))
       return 0x7ff8000000000000L;
     else
-      return /*VMDouble.*/ doubleToRawLongBits(value);
+      return /* VMDouble. */doubleToRawLongBits(value);
   }
 
   /**
    * Convert the double to the IEEE 754 floating-point "double format" bit
-   * layout. Bit 63 (the most significant) is the sign bit, bits 62-52
-   * (masked by 0x7ff0000000000000L) represent the exponent, and bits 51-0
-   * (masked by 0x000fffffffffffffL) are the mantissa. This function
-   * leaves NaN alone, rather than collapsing to a canonical value. The
-   * result of this function can be used as the argument to
-   * <code>Double.longBitsToDouble(long)</code> to obtain the original
-   * <code>double</code> value.
-   *
-   * @param value the <code>double</code> to convert
+   * layout. Bit 63 (the most significant) is the sign bit, bits 62-52 (masked
+   * by 0x7ff0000000000000L) represent the exponent, and bits 51-0 (masked by
+   * 0x000fffffffffffffL) are the mantissa. This function leaves NaN alone,
+   * rather than collapsing to a canonical value. The result of this function
+   * can be used as the argument to <code>Double.longBitsToDouble(long)</code>
+   * to obtain the original <code>double</code> value.
+   * 
+   * @param value
+   *          the <code>double</code> to convert
    * @return the bits of the <code>double</code>
    * @see #longBitsToDouble(long)
    */
-  /*public static long doubleToRawLongBits(double value)
-     {
-     return VMDouble.doubleToRawLongBits(value);
-     }*/
+  /*
+   * public static long doubleToRawLongBits(double value) { return
+   * VMDouble.doubleToRawLongBits(value); }
+   */
   public static native long doubleToRawLongBits(double value);
 
   /**
-   * Convert the argument in IEEE 754 floating-point "double format" bit
-   * layout to the corresponding float. Bit 63 (the most significant) is the
-   * sign bit, bits 62-52 (masked by 0x7ff0000000000000L) represent the
-   * exponent, and bits 51-0 (masked by 0x000fffffffffffffL) are the mantissa.
-   * This function leaves NaN alone, so that you can recover the bit pattern
-   * with <code>Double.doubleToRawLongBits(double)</code>.
-   *
-   * @param bits the bits to convert
+   * Convert the argument in IEEE 754 floating-point "double format" bit layout
+   * to the corresponding float. Bit 63 (the most significant) is the sign bit,
+   * bits 62-52 (masked by 0x7ff0000000000000L) represent the exponent, and bits
+   * 51-0 (masked by 0x000fffffffffffffL) are the mantissa. This function leaves
+   * NaN alone, so that you can recover the bit pattern with
+   * <code>Double.doubleToRawLongBits(double)</code>.
+   * 
+   * @param bits
+   *          the bits to convert
    * @return the <code>double</code> represented by the bits
    * @see #doubleToLongBits(double)
    * @see #doubleToRawLongBits(double)
    */
-  /*public static double longBitsToDouble(long bits)
-     {
-     return VMDouble.longBitsToDouble(bits);
-     }*/
+  /*
+   * public static double longBitsToDouble(long bits) { return
+   * VMDouble.longBitsToDouble(bits); }
+   */
   public static native double longBitsToDouble(long bits);
 
   /**
    * Compare two Doubles numerically by comparing their <code>double</code>
    * values. The result is positive if the first is greater, negative if the
-   * second is greater, and 0 if the two are equal. However, this special
-   * cases NaN and signed zero as follows: NaN is considered greater than
-   * all other doubles, including <code>POSITIVE_INFINITY</code>, and positive
-   * zero is considered greater than negative zero.
-   *
-   * @param d the Double to compare
+   * second is greater, and 0 if the two are equal. However, this special cases
+   * NaN and signed zero as follows: NaN is considered greater than all other
+   * doubles, including <code>POSITIVE_INFINITY</code>, and positive zero is
+   * considered greater than negative zero.
+   * 
+   * @param d
+   *          the Double to compare
    * @return the comparison
    * @since 1.2
    */
@@ -522,12 +536,14 @@ public final class Double extends Number //implements Comparable<Double>
   }
 
   /**
-   * Behaves like <code>new Double(x).compareTo(new Double(y))</code>; in
-   * other words this compares two doubles, special casing NaN and zero,
-   * without the overhead of objects.
-   *
-   * @param x the first double to compare
-   * @param y the second double to compare
+   * Behaves like <code>new Double(x).compareTo(new Double(y))</code>; in other
+   * words this compares two doubles, special casing NaN and zero, without the
+   * overhead of objects.
+   * 
+   * @param x
+   *          the first double to compare
+   * @param y
+   *          the second double to compare
    * @return the comparison
    * @since 1.4
    */
@@ -546,11 +562,11 @@ public final class Double extends Number //implements Comparable<Double>
 
     // handle NaNs:
     if (x != x)
-      return (y != y)?0:1;
+      return (y != y) ? 0 : 1;
     else if (y != y)
       return -1;
 
     // handle +/- 0.0
-    return (lx < ly)?-1:1;
+    return (lx < ly) ? -1 : 1;
   }
 }