1 /* 2 * Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.lang; 27 28 import sun.misc.FloatingDecimal; 29 import sun.misc.FpUtils; 30 import sun.misc.DoubleConsts; 31 32 /** 33 * The {@code Double} class wraps a value of the primitive type 34 * {@code double} in an object. An object of type 35 * {@code Double} contains a single field whose type is 36 * {@code double}. 37 * 38 * <p>In addition, this class provides several methods for converting a 39 * {@code double} to a {@code String} and a 40 * {@code String} to a {@code double}, as well as other 41 * constants and methods useful when dealing with a 42 * {@code double}. 43 * 44 * @author Lee Boynton 45 * @author Arthur van Hoff 46 * @author Joseph D. Darcy 47 * @since JDK1.0 48 */ 49 public final class Double extends Number implements Comparable<Double> { 50 /** 51 * A constant holding the positive infinity of type 52 * {@code double}. It is equal to the value returned by 53 * {@code Double.longBitsToDouble(0x7ff0000000000000L)}. 54 */ 55 public static final double POSITIVE_INFINITY = 1.0 / 0.0; 56 57 /** 58 * A constant holding the negative infinity of type 59 * {@code double}. It is equal to the value returned by 60 * {@code Double.longBitsToDouble(0xfff0000000000000L)}. 61 */ 62 public static final double NEGATIVE_INFINITY = -1.0 / 0.0; 63 64 /** 65 * A constant holding a Not-a-Number (NaN) value of type 66 * {@code double}. It is equivalent to the value returned by 67 * {@code Double.longBitsToDouble(0x7ff8000000000000L)}. 68 */ 69 public static final double NaN = 0.0d / 0.0; 70 71 /** 72 * A constant holding the largest positive finite value of type 73 * {@code double}, 74 * (2-2<sup>-52</sup>)·2<sup>1023</sup>. It is equal to 75 * the hexadecimal floating-point literal 76 * {@code 0x1.fffffffffffffP+1023} and also equal to 77 * {@code Double.longBitsToDouble(0x7fefffffffffffffL)}. 78 */ 79 public static final double MAX_VALUE = 0x1.fffffffffffffP+1023; // 1.7976931348623157e+308 80 81 /** 82 * A constant holding the smallest positive normal value of type 83 * {@code double}, 2<sup>-1022</sup>. It is equal to the 84 * hexadecimal floating-point literal {@code 0x1.0p-1022} and also 85 * equal to {@code Double.longBitsToDouble(0x0010000000000000L)}. 86 * 87 * @since 1.6 88 */ 89 public static final double MIN_NORMAL = 0x1.0p-1022; // 2.2250738585072014E-308 90 91 /** 92 * A constant holding the smallest positive nonzero value of type 93 * {@code double}, 2<sup>-1074</sup>. It is equal to the 94 * hexadecimal floating-point literal 95 * {@code 0x0.0000000000001P-1022} and also equal to 96 * {@code Double.longBitsToDouble(0x1L)}. 97 */ 98 public static final double MIN_VALUE = 0x0.0000000000001P-1022; // 4.9e-324 99 100 /** 101 * Maximum exponent a finite {@code double} variable may have. 102 * It is equal to the value returned by 103 * {@code Math.getExponent(Double.MAX_VALUE)}. 104 * 105 * @since 1.6 106 */ 107 public static final int MAX_EXPONENT = 1023; 108 109 /** 110 * Minimum exponent a normalized {@code double} variable may 111 * have. It is equal to the value returned by 112 * {@code Math.getExponent(Double.MIN_NORMAL)}. 113 * 114 * @since 1.6 115 */ 116 public static final int MIN_EXPONENT = -1022; 117 118 /** 119 * The number of bits used to represent a {@code double} value. 120 * 121 * @since 1.5 122 */ 123 public static final int SIZE = 64; 124 125 /** 126 * The {@code Class} instance representing the primitive type 127 * {@code double}. 128 * 129 * @since JDK1.1 130 */ 131 public static final Class<Double> TYPE = (Class<Double>) Class.getPrimitiveClass("double"); 132 133 /** 134 * Returns a string representation of the {@code double} 135 * argument. All characters mentioned below are ASCII characters. 136 * <ul> 137 * <li>If the argument is NaN, the result is the string 138 * "{@code NaN}". 139 * <li>Otherwise, the result is a string that represents the sign and 140 * magnitude (absolute value) of the argument. If the sign is negative, 141 * the first character of the result is '{@code -}' 142 * (<code>'\u002D'</code>); if the sign is positive, no sign character 143 * appears in the result. As for the magnitude <i>m</i>: 144 * <ul> 145 * <li>If <i>m</i> is infinity, it is represented by the characters 146 * {@code "Infinity"}; thus, positive infinity produces the result 147 * {@code "Infinity"} and negative infinity produces the result 148 * {@code "-Infinity"}. 149 * 150 * <li>If <i>m</i> is zero, it is represented by the characters 151 * {@code "0.0"}; thus, negative zero produces the result 152 * {@code "-0.0"} and positive zero produces the result 153 * {@code "0.0"}. 154 * 155 * <li>If <i>m</i> is greater than or equal to 10<sup>-3</sup> but less 156 * than 10<sup>7</sup>, then it is represented as the integer part of 157 * <i>m</i>, in decimal form with no leading zeroes, followed by 158 * '{@code .}' (<code>'\u002E'</code>), followed by one or 159 * more decimal digits representing the fractional part of <i>m</i>. 160 * 161 * <li>If <i>m</i> is less than 10<sup>-3</sup> or greater than or 162 * equal to 10<sup>7</sup>, then it is represented in so-called 163 * "computerized scientific notation." Let <i>n</i> be the unique 164 * integer such that 10<sup><i>n</i></sup> ≤ <i>m</i> {@literal <} 165 * 10<sup><i>n</i>+1</sup>; then let <i>a</i> be the 166 * mathematically exact quotient of <i>m</i> and 167 * 10<sup><i>n</i></sup> so that 1 ≤ <i>a</i> {@literal <} 10. The 168 * magnitude is then represented as the integer part of <i>a</i>, 169 * as a single decimal digit, followed by '{@code .}' 170 * (<code>'\u002E'</code>), followed by decimal digits 171 * representing the fractional part of <i>a</i>, followed by the 172 * letter '{@code E}' (<code>'\u0045'</code>), followed 173 * by a representation of <i>n</i> as a decimal integer, as 174 * produced by the method {@link Integer#toString(int)}. 175 * </ul> 176 * </ul> 177 * How many digits must be printed for the fractional part of 178 * <i>m</i> or <i>a</i>? There must be at least one digit to represent 179 * the fractional part, and beyond that as many, but only as many, more 180 * digits as are needed to uniquely distinguish the argument value from 181 * adjacent values of type {@code double}. That is, suppose that 182 * <i>x</i> is the exact mathematical value represented by the decimal 183 * representation produced by this method for a finite nonzero argument 184 * <i>d</i>. Then <i>d</i> must be the {@code double} value nearest 185 * to <i>x</i>; or if two {@code double} values are equally close 186 * to <i>x</i>, then <i>d</i> must be one of them and the least 187 * significant bit of the significand of <i>d</i> must be {@code 0}. 188 * 189 * <p>To create localized string representations of a floating-point 190 * value, use subclasses of {@link java.text.NumberFormat}. 191 * 192 * @param d the {@code double} to be converted. 193 * @return a string representation of the argument. 194 */ 195 public static String toString(double d) { 196 return new FloatingDecimal(d).toJavaFormatString(); 197 } 198 199 /** 200 * Returns a hexadecimal string representation of the 201 * {@code double} argument. All characters mentioned below 202 * are ASCII characters. 203 * 204 * <ul> 205 * <li>If the argument is NaN, the result is the string 206 * "{@code NaN}". 207 * <li>Otherwise, the result is a string that represents the sign 208 * and magnitude of the argument. If the sign is negative, the 209 * first character of the result is '{@code -}' 210 * (<code>'\u002D'</code>); if the sign is positive, no sign 211 * character appears in the result. As for the magnitude <i>m</i>: 212 * 213 * <ul> 214 * <li>If <i>m</i> is infinity, it is represented by the string 215 * {@code "Infinity"}; thus, positive infinity produces the 216 * result {@code "Infinity"} and negative infinity produces 217 * the result {@code "-Infinity"}. 218 * 219 * <li>If <i>m</i> is zero, it is represented by the string 220 * {@code "0x0.0p0"}; thus, negative zero produces the result 221 * {@code "-0x0.0p0"} and positive zero produces the result 222 * {@code "0x0.0p0"}. 223 * 224 * <li>If <i>m</i> is a {@code double} value with a 225 * normalized representation, substrings are used to represent the 226 * significand and exponent fields. The significand is 227 * represented by the characters {@code "0x1."} 228 * followed by a lowercase hexadecimal representation of the rest 229 * of the significand as a fraction. Trailing zeros in the 230 * hexadecimal representation are removed unless all the digits 231 * are zero, in which case a single zero is used. Next, the 232 * exponent is represented by {@code "p"} followed 233 * by a decimal string of the unbiased exponent as if produced by 234 * a call to {@link Integer#toString(int) Integer.toString} on the 235 * exponent value. 236 * 237 * <li>If <i>m</i> is a {@code double} value with a subnormal 238 * representation, the significand is represented by the 239 * characters {@code "0x0."} followed by a 240 * hexadecimal representation of the rest of the significand as a 241 * fraction. Trailing zeros in the hexadecimal representation are 242 * removed. Next, the exponent is represented by 243 * {@code "p-1022"}. Note that there must be at 244 * least one nonzero digit in a subnormal significand. 245 * 246 * </ul> 247 * 248 * </ul> 249 * 250 * <table border> 251 * <caption><h3>Examples</h3></caption> 252 * <tr><th>Floating-point Value</th><th>Hexadecimal String</th> 253 * <tr><td>{@code 1.0}</td> <td>{@code 0x1.0p0}</td> 254 * <tr><td>{@code -1.0}</td> <td>{@code -0x1.0p0}</td> 255 * <tr><td>{@code 2.0}</td> <td>{@code 0x1.0p1}</td> 256 * <tr><td>{@code 3.0}</td> <td>{@code 0x1.8p1}</td> 257 * <tr><td>{@code 0.5}</td> <td>{@code 0x1.0p-1}</td> 258 * <tr><td>{@code 0.25}</td> <td>{@code 0x1.0p-2}</td> 259 * <tr><td>{@code Double.MAX_VALUE}</td> 260 * <td>{@code 0x1.fffffffffffffp1023}</td> 261 * <tr><td>{@code Minimum Normal Value}</td> 262 * <td>{@code 0x1.0p-1022}</td> 263 * <tr><td>{@code Maximum Subnormal Value}</td> 264 * <td>{@code 0x0.fffffffffffffp-1022}</td> 265 * <tr><td>{@code Double.MIN_VALUE}</td> 266 * <td>{@code 0x0.0000000000001p-1022}</td> 267 * </table> 268 * @param d the {@code double} to be converted. 269 * @return a hex string representation of the argument. 270 * @since 1.5 271 * @author Joseph D. Darcy 272 */ 273 public static String toHexString(double d) { 274 /* 275 * Modeled after the "a" conversion specifier in C99, section 276 * 7.19.6.1; however, the output of this method is more 277 * tightly specified. 278 */ 279 if (!isFinite(d) ) 280 // For infinity and NaN, use the decimal output. 281 return Double.toString(d); 282 else { 283 // Initialized to maximum size of output. 284 StringBuffer answer = new StringBuffer(24); 285 286 if (Math.copySign(1.0, d) == -1.0) // value is negative, 287 answer.append("-"); // so append sign info 288 289 answer.append("0x"); 290 291 d = Math.abs(d); 292 293 if(d == 0.0) { 294 answer.append("0.0p0"); 295 } 296 else { 297 boolean subnormal = (d < DoubleConsts.MIN_NORMAL); 298 299 // Isolate significand bits and OR in a high-order bit 300 // so that the string representation has a known 301 // length. 302 long signifBits = (Double.doubleToLongBits(d) 303 & DoubleConsts.SIGNIF_BIT_MASK) | 304 0x1000000000000000L; 305 306 // Subnormal values have a 0 implicit bit; normal 307 // values have a 1 implicit bit. 308 answer.append(subnormal ? "0." : "1."); 309 310 // Isolate the low-order 13 digits of the hex 311 // representation. If all the digits are zero, 312 // replace with a single 0; otherwise, remove all 313 // trailing zeros. 314 String signif = Long.toHexString(signifBits).substring(3,16); 315 answer.append(signif.equals("0000000000000") ? // 13 zeros 316 "0": 317 signif.replaceFirst("0{1,12}$", "")); 318 319 // If the value is subnormal, use the E_min exponent 320 // value for double; otherwise, extract and report d's 321 // exponent (the representation of a subnormal uses 322 // E_min -1). 323 answer.append("p" + (subnormal ? 324 DoubleConsts.MIN_EXPONENT: 325 Math.getExponent(d) )); 326 } 327 return answer.toString(); 328 } 329 } 330 331 /** 332 * Returns a {@code Double} object holding the 333 * {@code double} value represented by the argument string 334 * {@code s}. 335 * 336 * <p>If {@code s} is {@code null}, then a 337 * {@code NullPointerException} is thrown. 338 * 339 * <p>Leading and trailing whitespace characters in {@code s} 340 * are ignored. Whitespace is removed as if by the {@link 341 * String#trim} method; that is, both ASCII space and control 342 * characters are removed. The rest of {@code s} should 343 * constitute a <i>FloatValue</i> as described by the lexical 344 * syntax rules: 345 * 346 * <blockquote> 347 * <dl> 348 * <dt><i>FloatValue:</i> 349 * <dd><i>Sign<sub>opt</sub></i> {@code NaN} 350 * <dd><i>Sign<sub>opt</sub></i> {@code Infinity} 351 * <dd><i>Sign<sub>opt</sub> FloatingPointLiteral</i> 352 * <dd><i>Sign<sub>opt</sub> HexFloatingPointLiteral</i> 353 * <dd><i>SignedInteger</i> 354 * </dl> 355 * 356 * <p> 357 * 358 * <dl> 359 * <dt><i>HexFloatingPointLiteral</i>: 360 * <dd> <i>HexSignificand BinaryExponent FloatTypeSuffix<sub>opt</sub></i> 361 * </dl> 362 * 363 * <p> 364 * 365 * <dl> 366 * <dt><i>HexSignificand:</i> 367 * <dd><i>HexNumeral</i> 368 * <dd><i>HexNumeral</i> {@code .} 369 * <dd>{@code 0x} <i>HexDigits<sub>opt</sub> 370 * </i>{@code .}<i> HexDigits</i> 371 * <dd>{@code 0X}<i> HexDigits<sub>opt</sub> 372 * </i>{@code .} <i>HexDigits</i> 373 * </dl> 374 * 375 * <p> 376 * 377 * <dl> 378 * <dt><i>BinaryExponent:</i> 379 * <dd><i>BinaryExponentIndicator SignedInteger</i> 380 * </dl> 381 * 382 * <p> 383 * 384 * <dl> 385 * <dt><i>BinaryExponentIndicator:</i> 386 * <dd>{@code p} 387 * <dd>{@code P} 388 * </dl> 389 * 390 * </blockquote> 391 * 392 * where <i>Sign</i>, <i>FloatingPointLiteral</i>, 393 * <i>HexNumeral</i>, <i>HexDigits</i>, <i>SignedInteger</i> and 394 * <i>FloatTypeSuffix</i> are as defined in the lexical structure 395 * sections of 396 * <cite>The Java™ Language Specification</cite>, 397 * except that underscores are not accepted between digits. 398 * If {@code s} does not have the form of 399 * a <i>FloatValue</i>, then a {@code NumberFormatException} 400 * is thrown. Otherwise, {@code s} is regarded as 401 * representing an exact decimal value in the usual 402 * "computerized scientific notation" or as an exact 403 * hexadecimal value; this exact numerical value is then 404 * conceptually converted to an "infinitely precise" 405 * binary value that is then rounded to type {@code double} 406 * by the usual round-to-nearest rule of IEEE 754 floating-point 407 * arithmetic, which includes preserving the sign of a zero 408 * value. 409 * 410 * Note that the round-to-nearest rule also implies overflow and 411 * underflow behaviour; if the exact value of {@code s} is large 412 * enough in magnitude (greater than or equal to ({@link 413 * #MAX_VALUE} + {@link Math#ulp(double) ulp(MAX_VALUE)}/2), 414 * rounding to {@code double} will result in an infinity and if the 415 * exact value of {@code s} is small enough in magnitude (less 416 * than or equal to {@link #MIN_VALUE}/2), rounding to float will 417 * result in a zero. 418 * 419 * Finally, after rounding a {@code Double} object representing 420 * this {@code double} value is returned. 421 * 422 * <p> To interpret localized string representations of a 423 * floating-point value, use subclasses of {@link 424 * java.text.NumberFormat}. 425 * 426 * <p>Note that trailing format specifiers, specifiers that 427 * determine the type of a floating-point literal 428 * ({@code 1.0f} is a {@code float} value; 429 * {@code 1.0d} is a {@code double} value), do 430 * <em>not</em> influence the results of this method. In other 431 * words, the numerical value of the input string is converted 432 * directly to the target floating-point type. The two-step 433 * sequence of conversions, string to {@code float} followed 434 * by {@code float} to {@code double}, is <em>not</em> 435 * equivalent to converting a string directly to 436 * {@code double}. For example, the {@code float} 437 * literal {@code 0.1f} is equal to the {@code double} 438 * value {@code 0.10000000149011612}; the {@code float} 439 * literal {@code 0.1f} represents a different numerical 440 * value than the {@code double} literal 441 * {@code 0.1}. (The numerical value 0.1 cannot be exactly 442 * represented in a binary floating-point number.) 443 * 444 * <p>To avoid calling this method on an invalid string and having 445 * a {@code NumberFormatException} be thrown, the regular 446 * expression below can be used to screen the input string: 447 * 448 * <code> 449 * <pre> 450 * final String Digits = "(\\p{Digit}+)"; 451 * final String HexDigits = "(\\p{XDigit}+)"; 452 * // an exponent is 'e' or 'E' followed by an optionally 453 * // signed decimal integer. 454 * final String Exp = "[eE][+-]?"+Digits; 455 * final String fpRegex = 456 * ("[\\x00-\\x20]*"+ // Optional leading "whitespace" 457 * "[+-]?(" + // Optional sign character 458 * "NaN|" + // "NaN" string 459 * "Infinity|" + // "Infinity" string 460 * 461 * // A decimal floating-point string representing a finite positive 462 * // number without a leading sign has at most five basic pieces: 463 * // Digits . Digits ExponentPart FloatTypeSuffix 464 * // 465 * // Since this method allows integer-only strings as input 466 * // in addition to strings of floating-point literals, the 467 * // two sub-patterns below are simplifications of the grammar 468 * // productions from section 3.10.2 of 469 * // <cite>The Java™ Language Specification</cite>. 470 * 471 * // Digits ._opt Digits_opt ExponentPart_opt FloatTypeSuffix_opt 472 * "((("+Digits+"(\\.)?("+Digits+"?)("+Exp+")?)|"+ 473 * 474 * // . Digits ExponentPart_opt FloatTypeSuffix_opt 475 * "(\\.("+Digits+")("+Exp+")?)|"+ 476 * 477 * // Hexadecimal strings 478 * "((" + 479 * // 0[xX] HexDigits ._opt BinaryExponent FloatTypeSuffix_opt 480 * "(0[xX]" + HexDigits + "(\\.)?)|" + 481 * 482 * // 0[xX] HexDigits_opt . HexDigits BinaryExponent FloatTypeSuffix_opt 483 * "(0[xX]" + HexDigits + "?(\\.)" + HexDigits + ")" + 484 * 485 * ")[pP][+-]?" + Digits + "))" + 486 * "[fFdD]?))" + 487 * "[\\x00-\\x20]*");// Optional trailing "whitespace" 488 * 489 * if (Pattern.matches(fpRegex, myString)) 490 * Double.valueOf(myString); // Will not throw NumberFormatException 491 * else { 492 * // Perform suitable alternative action 493 * } 494 * </pre> 495 * </code> 496 * 497 * @param s the string to be parsed. 498 * @return a {@code Double} object holding the value 499 * represented by the {@code String} argument. 500 * @throws NumberFormatException if the string does not contain a 501 * parsable number. 502 */ 503 public static Double valueOf(String s) throws NumberFormatException { 504 return new Double(FloatingDecimal.readJavaFormatString(s).doubleValue()); 505 } 506 507 /** 508 * Returns a {@code Double} instance representing the specified 509 * {@code double} value. 510 * If a new {@code Double} instance is not required, this method 511 * should generally be used in preference to the constructor 512 * {@link #Double(double)}, as this method is likely to yield 513 * significantly better space and time performance by caching 514 * frequently requested values. 515 * 516 * @param d a double value. 517 * @return a {@code Double} instance representing {@code d}. 518 * @since 1.5 519 */ 520 public static Double valueOf(double d) { 521 return new Double(d); 522 } 523 524 /** 525 * Returns a new {@code double} initialized to the value 526 * represented by the specified {@code String}, as performed 527 * by the {@code valueOf} method of class 528 * {@code Double}. 529 * 530 * @param s the string to be parsed. 531 * @return the {@code double} value represented by the string 532 * argument. 533 * @throws NullPointerException if the string is null 534 * @throws NumberFormatException if the string does not contain 535 * a parsable {@code double}. 536 * @see java.lang.Double#valueOf(String) 537 * @since 1.2 538 */ 539 public static double parseDouble(String s) throws NumberFormatException { 540 return FloatingDecimal.readJavaFormatString(s).doubleValue(); 541 } 542 543 /** 544 * Returns {@code true} if the specified number is a 545 * Not-a-Number (NaN) value, {@code false} otherwise. 546 * 547 * @param v the value to be tested. 548 * @return {@code true} if the value of the argument is NaN; 549 * {@code false} otherwise. 550 */ 551 public static boolean isNaN(double v) { 552 return (v != v); 553 } 554 555 /** 556 * Returns {@code true} if the specified number is infinitely 557 * large in magnitude, {@code false} otherwise. 558 * 559 * @param v the value to be tested. 560 * @return {@code true} if the value of the argument is positive 561 * infinity or negative infinity; {@code false} otherwise. 562 */ 563 public static boolean isInfinite(double v) { 564 return (v == POSITIVE_INFINITY) || (v == NEGATIVE_INFINITY); 565 } 566 567 /** 568 * Returns {@code true} if the argument is a finite floating-point 569 * value; returns {@code false} otherwise (for NaN and infinity 570 * arguments). 571 * 572 * @param d the {@code double} value to be tested 573 * @return {@code true} if the argument is a finite 574 * floating-point value, {@code false} otherwise. 575 * @since 1.8 576 */ 577 public static boolean isFinite(double d) { 578 return Math.abs(d) <= DoubleConsts.MAX_VALUE; 579 } 580 581 /** 582 * The value of the Double. 583 * 584 * @serial 585 */ 586 private final double value; 587 588 /** 589 * Constructs a newly allocated {@code Double} object that 590 * represents the primitive {@code double} argument. 591 * 592 * @param value the value to be represented by the {@code Double}. 593 */ 594 public Double(double value) { 595 this.value = value; 596 } 597 598 /** 599 * Constructs a newly allocated {@code Double} object that 600 * represents the floating-point value of type {@code double} 601 * represented by the string. The string is converted to a 602 * {@code double} value as if by the {@code valueOf} method. 603 * 604 * @param s a string to be converted to a {@code Double}. 605 * @throws NumberFormatException if the string does not contain a 606 * parsable number. 607 * @see java.lang.Double#valueOf(java.lang.String) 608 */ 609 public Double(String s) throws NumberFormatException { 610 // REMIND: this is inefficient 611 this(valueOf(s).doubleValue()); 612 } 613 614 /** 615 * Returns {@code true} if this {@code Double} value is 616 * a Not-a-Number (NaN), {@code false} otherwise. 617 * 618 * @return {@code true} if the value represented by this object is 619 * NaN; {@code false} otherwise. 620 */ 621 public boolean isNaN() { 622 return isNaN(value); 623 } 624 625 /** 626 * Returns {@code true} if this {@code Double} value is 627 * infinitely large in magnitude, {@code false} otherwise. 628 * 629 * @return {@code true} if the value represented by this object is 630 * positive infinity or negative infinity; 631 * {@code false} otherwise. 632 */ 633 public boolean isInfinite() { 634 return isInfinite(value); 635 } 636 637 /** 638 * Returns a string representation of this {@code Double} object. 639 * The primitive {@code double} value represented by this 640 * object is converted to a string exactly as if by the method 641 * {@code toString} of one argument. 642 * 643 * @return a {@code String} representation of this object. 644 * @see java.lang.Double#toString(double) 645 */ 646 public String toString() { 647 return toString(value); 648 } 649 650 /** 651 * Returns the value of this {@code Double} as a {@code byte} 652 * after a narrowing primitive conversion. 653 * 654 * @return the {@code double} value represented by this object 655 * converted to type {@code byte} 656 * @jls 5.1.3 Narrowing Primitive Conversions 657 * @since JDK1.1 658 */ 659 public byte byteValue() { 660 return (byte)value; 661 } 662 663 /** 664 * Returns the value of this {@code Double} as a {@code short} 665 * after a narrowing primitive conversion. 666 * 667 * @return the {@code double} value represented by this object 668 * converted to type {@code short} 669 * @jls 5.1.3 Narrowing Primitive Conversions 670 * @since JDK1.1 671 */ 672 public short shortValue() { 673 return (short)value; 674 } 675 676 /** 677 * Returns the value of this {@code Double} as an {@code int} 678 * after a narrowing primitive conversion. 679 * @jls 5.1.3 Narrowing Primitive Conversions 680 * 681 * @return the {@code double} value represented by this object 682 * converted to type {@code int} 683 */ 684 public int intValue() { 685 return (int)value; 686 } 687 688 /** 689 * Returns the value of this {@code Double} as a {@code long} 690 * after a narrowing primitive conversion. 691 * 692 * @return the {@code double} value represented by this object 693 * converted to type {@code long} 694 * @jls 5.1.3 Narrowing Primitive Conversions 695 */ 696 public long longValue() { 697 return (long)value; 698 } 699 700 /** 701 * Returns the value of this {@code Double} as a {@code float} 702 * after a narrowing primitive conversion. 703 * 704 * @return the {@code double} value represented by this object 705 * converted to type {@code float} 706 * @jls 5.1.3 Narrowing Primitive Conversions 707 * @since JDK1.0 708 */ 709 public float floatValue() { 710 return (float)value; 711 } 712 713 /** 714 * Returns the {@code double} value of this {@code Double} object. 715 * 716 * @return the {@code double} value represented by this object 717 */ 718 public double doubleValue() { 719 return (double)value; 720 } 721 722 /** 723 * Returns a hash code for this {@code Double} object. The 724 * result is the exclusive OR of the two halves of the 725 * {@code long} integer bit representation, exactly as 726 * produced by the method {@link #doubleToLongBits(double)}, of 727 * the primitive {@code double} value represented by this 728 * {@code Double} object. That is, the hash code is the value 729 * of the expression: 730 * 731 * <blockquote> 732 * {@code (int)(v^(v>>>32))} 733 * </blockquote> 734 * 735 * where {@code v} is defined by: 736 * 737 * <blockquote> 738 * {@code long v = Double.doubleToLongBits(this.doubleValue());} 739 * </blockquote> 740 * 741 * @return a {@code hash code} value for this object. 742 */ 743 public int hashCode() { 744 long bits = doubleToLongBits(value); 745 return (int)(bits ^ (bits >>> 32)); 746 } 747 748 /** 749 * Compares this object against the specified object. The result 750 * is {@code true} if and only if the argument is not 751 * {@code null} and is a {@code Double} object that 752 * represents a {@code double} that has the same value as the 753 * {@code double} represented by this object. For this 754 * purpose, two {@code double} values are considered to be 755 * the same if and only if the method {@link 756 * #doubleToLongBits(double)} returns the identical 757 * {@code long} value when applied to each. 758 * 759 * <p>Note that in most cases, for two instances of class 760 * {@code Double}, {@code d1} and {@code d2}, the 761 * value of {@code d1.equals(d2)} is {@code true} if and 762 * only if 763 * 764 * <blockquote> 765 * {@code d1.doubleValue() == d2.doubleValue()} 766 * </blockquote> 767 * 768 * <p>also has the value {@code true}. However, there are two 769 * exceptions: 770 * <ul> 771 * <li>If {@code d1} and {@code d2} both represent 772 * {@code Double.NaN}, then the {@code equals} method 773 * returns {@code true}, even though 774 * {@code Double.NaN==Double.NaN} has the value 775 * {@code false}. 776 * <li>If {@code d1} represents {@code +0.0} while 777 * {@code d2} represents {@code -0.0}, or vice versa, 778 * the {@code equal} test has the value {@code false}, 779 * even though {@code +0.0==-0.0} has the value {@code true}. 780 * </ul> 781 * This definition allows hash tables to operate properly. 782 * @param obj the object to compare with. 783 * @return {@code true} if the objects are the same; 784 * {@code false} otherwise. 785 * @see java.lang.Double#doubleToLongBits(double) 786 */ 787 public boolean equals(Object obj) { 788 return (obj instanceof Double) 789 && (doubleToLongBits(((Double)obj).value) == 790 doubleToLongBits(value)); 791 } 792 793 /** 794 * Returns a representation of the specified floating-point value 795 * according to the IEEE 754 floating-point "double 796 * format" bit layout. 797 * 798 * <p>Bit 63 (the bit that is selected by the mask 799 * {@code 0x8000000000000000L}) represents the sign of the 800 * floating-point number. Bits 801 * 62-52 (the bits that are selected by the mask 802 * {@code 0x7ff0000000000000L}) represent the exponent. Bits 51-0 803 * (the bits that are selected by the mask 804 * {@code 0x000fffffffffffffL}) represent the significand 805 * (sometimes called the mantissa) of the floating-point number. 806 * 807 * <p>If the argument is positive infinity, the result is 808 * {@code 0x7ff0000000000000L}. 809 * 810 * <p>If the argument is negative infinity, the result is 811 * {@code 0xfff0000000000000L}. 812 * 813 * <p>If the argument is NaN, the result is 814 * {@code 0x7ff8000000000000L}. 815 * 816 * <p>In all cases, the result is a {@code long} integer that, when 817 * given to the {@link #longBitsToDouble(long)} method, will produce a 818 * floating-point value the same as the argument to 819 * {@code doubleToLongBits} (except all NaN values are 820 * collapsed to a single "canonical" NaN value). 821 * 822 * @param value a {@code double} precision floating-point number. 823 * @return the bits that represent the floating-point number. 824 */ 825 public static long doubleToLongBits(double value) { 826 long result = doubleToRawLongBits(value); 827 // Check for NaN based on values of bit fields, maximum 828 // exponent and nonzero significand. 829 if ( ((result & DoubleConsts.EXP_BIT_MASK) == 830 DoubleConsts.EXP_BIT_MASK) && 831 (result & DoubleConsts.SIGNIF_BIT_MASK) != 0L) 832 result = 0x7ff8000000000000L; 833 return result; 834 } 835 836 /** 837 * Returns a representation of the specified floating-point value 838 * according to the IEEE 754 floating-point "double 839 * format" bit layout, preserving Not-a-Number (NaN) values. 840 * 841 * <p>Bit 63 (the bit that is selected by the mask 842 * {@code 0x8000000000000000L}) represents the sign of the 843 * floating-point number. Bits 844 * 62-52 (the bits that are selected by the mask 845 * {@code 0x7ff0000000000000L}) represent the exponent. Bits 51-0 846 * (the bits that are selected by the mask 847 * {@code 0x000fffffffffffffL}) represent the significand 848 * (sometimes called the mantissa) of the floating-point number. 849 * 850 * <p>If the argument is positive infinity, the result is 851 * {@code 0x7ff0000000000000L}. 852 * 853 * <p>If the argument is negative infinity, the result is 854 * {@code 0xfff0000000000000L}. 855 * 856 * <p>If the argument is NaN, the result is the {@code long} 857 * integer representing the actual NaN value. Unlike the 858 * {@code doubleToLongBits} method, 859 * {@code doubleToRawLongBits} does not collapse all the bit 860 * patterns encoding a NaN to a single "canonical" NaN 861 * value. 862 * 863 * <p>In all cases, the result is a {@code long} integer that, 864 * when given to the {@link #longBitsToDouble(long)} method, will 865 * produce a floating-point value the same as the argument to 866 * {@code doubleToRawLongBits}. 867 * 868 * @param value a {@code double} precision floating-point number. 869 * @return the bits that represent the floating-point number. 870 * @since 1.3 871 */ 872 public static native long doubleToRawLongBits(double value); 873 874 /** 875 * Returns the {@code double} value corresponding to a given 876 * bit representation. 877 * The argument is considered to be a representation of a 878 * floating-point value according to the IEEE 754 floating-point 879 * "double format" bit layout. 880 * 881 * <p>If the argument is {@code 0x7ff0000000000000L}, the result 882 * is positive infinity. 883 * 884 * <p>If the argument is {@code 0xfff0000000000000L}, the result 885 * is negative infinity. 886 * 887 * <p>If the argument is any value in the range 888 * {@code 0x7ff0000000000001L} through 889 * {@code 0x7fffffffffffffffL} or in the range 890 * {@code 0xfff0000000000001L} through 891 * {@code 0xffffffffffffffffL}, the result is a NaN. No IEEE 892 * 754 floating-point operation provided by Java can distinguish 893 * between two NaN values of the same type with different bit 894 * patterns. Distinct values of NaN are only distinguishable by 895 * use of the {@code Double.doubleToRawLongBits} method. 896 * 897 * <p>In all other cases, let <i>s</i>, <i>e</i>, and <i>m</i> be three 898 * values that can be computed from the argument: 899 * 900 * <blockquote><pre> 901 * int s = ((bits >> 63) == 0) ? 1 : -1; 902 * int e = (int)((bits >> 52) & 0x7ffL); 903 * long m = (e == 0) ? 904 * (bits & 0xfffffffffffffL) << 1 : 905 * (bits & 0xfffffffffffffL) | 0x10000000000000L; 906 * </pre></blockquote> 907 * 908 * Then the floating-point result equals the value of the mathematical 909 * expression <i>s</i>·<i>m</i>·2<sup><i>e</i>-1075</sup>. 910 * 911 * <p>Note that this method may not be able to return a 912 * {@code double} NaN with exactly same bit pattern as the 913 * {@code long} argument. IEEE 754 distinguishes between two 914 * kinds of NaNs, quiet NaNs and <i>signaling NaNs</i>. The 915 * differences between the two kinds of NaN are generally not 916 * visible in Java. Arithmetic operations on signaling NaNs turn 917 * them into quiet NaNs with a different, but often similar, bit 918 * pattern. However, on some processors merely copying a 919 * signaling NaN also performs that conversion. In particular, 920 * copying a signaling NaN to return it to the calling method 921 * may perform this conversion. So {@code longBitsToDouble} 922 * may not be able to return a {@code double} with a 923 * signaling NaN bit pattern. Consequently, for some 924 * {@code long} values, 925 * {@code doubleToRawLongBits(longBitsToDouble(start))} may 926 * <i>not</i> equal {@code start}. Moreover, which 927 * particular bit patterns represent signaling NaNs is platform 928 * dependent; although all NaN bit patterns, quiet or signaling, 929 * must be in the NaN range identified above. 930 * 931 * @param bits any {@code long} integer. 932 * @return the {@code double} floating-point value with the same 933 * bit pattern. 934 */ 935 public static native double longBitsToDouble(long bits); 936 937 /** 938 * Compares two {@code Double} objects numerically. There 939 * are two ways in which comparisons performed by this method 940 * differ from those performed by the Java language numerical 941 * comparison operators ({@code <, <=, ==, >=, >}) 942 * when applied to primitive {@code double} values: 943 * <ul><li> 944 * {@code Double.NaN} is considered by this method 945 * to be equal to itself and greater than all other 946 * {@code double} values (including 947 * {@code Double.POSITIVE_INFINITY}). 948 * <li> 949 * {@code 0.0d} is considered by this method to be greater 950 * than {@code -0.0d}. 951 * </ul> 952 * This ensures that the <i>natural ordering</i> of 953 * {@code Double} objects imposed by this method is <i>consistent 954 * with equals</i>. 955 * 956 * @param anotherDouble the {@code Double} to be compared. 957 * @return the value {@code 0} if {@code anotherDouble} is 958 * numerically equal to this {@code Double}; a value 959 * less than {@code 0} if this {@code Double} 960 * is numerically less than {@code anotherDouble}; 961 * and a value greater than {@code 0} if this 962 * {@code Double} is numerically greater than 963 * {@code anotherDouble}. 964 * 965 * @since 1.2 966 */ 967 public int compareTo(Double anotherDouble) { 968 return Double.compare(value, anotherDouble.value); 969 } 970 971 /** 972 * Compares the two specified {@code double} values. The sign 973 * of the integer value returned is the same as that of the 974 * integer that would be returned by the call: 975 * <pre> 976 * new Double(d1).compareTo(new Double(d2)) 977 * </pre> 978 * 979 * @param d1 the first {@code double} to compare 980 * @param d2 the second {@code double} to compare 981 * @return the value {@code 0} if {@code d1} is 982 * numerically equal to {@code d2}; a value less than 983 * {@code 0} if {@code d1} is numerically less than 984 * {@code d2}; and a value greater than {@code 0} 985 * if {@code d1} is numerically greater than 986 * {@code d2}. 987 * @since 1.4 988 */ 989 public static int compare(double d1, double d2) { 990 if (d1 < d2) 991 return -1; // Neither val is NaN, thisVal is smaller 992 if (d1 > d2) 993 return 1; // Neither val is NaN, thisVal is larger 994 995 // Cannot use doubleToRawLongBits because of possibility of NaNs. 996 long thisBits = Double.doubleToLongBits(d1); 997 long anotherBits = Double.doubleToLongBits(d2); 998 999 return (thisBits == anotherBits ? 0 : // Values are equal 1000 (thisBits < anotherBits ? -1 : // (-0.0, 0.0) or (!NaN, NaN) 1001 1)); // (0.0, -0.0) or (NaN, !NaN) 1002 } 1003 1004 /** use serialVersionUID from JDK 1.0.2 for interoperability */ 1005 private static final long serialVersionUID = -9172774392245257468L; 1006 }