src/libcore/num/f64.rs

   1 //! This module provides constants which are specific to the implementation
   2 //! of the `f64` floating point data type.
   3 //!
   4 //! *[See also the `f64` primitive type](../../std/primitive.f64.html).*
   5 //!
   6 //! Mathematically significant numbers are provided in the `consts` sub-module.
   7 //!
   8 //! Although using these constants won’t cause compilation warnings,
   9 //! new code should use the associated constants directly on the primitive type.
  10
  11 #![stable(feature = "rust1", since = "1.0.0")]
  12
  13 use crate::convert::FloatToInt;
  14 #[cfg(not(test))]
  15 use crate::intrinsics;
  16 use crate::mem;
  17 use crate::num::FpCategory;
  18
  19 /// The radix or base of the internal representation of `f64`.
  20 /// Use [`f64::RADIX`](../../std/primitive.f64.html#associatedconstant.RADIX) instead.
  21 ///
  22 /// # Examples
  23 ///
  24 /// ```rust
  25 /// // deprecated way
  26 /// let r = std::f64::RADIX;
  27 ///
  28 /// // intended way
  29 /// let r = f64::RADIX;
  30 /// ```
  31 #[stable(feature = "rust1", since = "1.0.0")]
  32 pub const RADIX: u32 = f64::RADIX;
  33
  34 /// Number of significant digits in base 2.
  35 /// Use [`f64::MANTISSA_DIGITS`](../../std/primitive.f64.html#associatedconstant.MANTISSA_DIGITS) instead.
  36 ///
  37 /// # Examples
  38 ///
  39 /// ```rust
  40 /// // deprecated way
  41 /// let d = std::f64::MANTISSA_DIGITS;
  42 ///
  43 /// // intended way
  44 /// let d = f64::MANTISSA_DIGITS;
  45 /// ```
  46 #[stable(feature = "rust1", since = "1.0.0")]
  47 pub const MANTISSA_DIGITS: u32 = f64::MANTISSA_DIGITS;
  48
  49 /// Approximate number of significant digits in base 10.
  50 /// Use [`f64::DIGITS`](../../std/primitive.f64.html#associatedconstant.DIGITS) instead.
  51 ///
  52 /// # Examples
  53 ///
  54 /// ```rust
  55 /// // deprecated way
  56 /// let d = std::f64::DIGITS;
  57 ///
  58 /// // intended way
  59 /// let d = f64::DIGITS;
  60 /// ```
  61 #[stable(feature = "rust1", since = "1.0.0")]
  62 pub const DIGITS: u32 = f64::DIGITS;
  63
  64 /// [Machine epsilon] value for `f64`.
  65 /// Use [`f64::EPSILON`](../../std/primitive.f64.html#associatedconstant.EPSILON) instead.
  66 ///
  67 /// This is the difference between `1.0` and the next larger representable number.
  68 ///
  69 /// [Machine epsilon]: https://en.wikipedia.org/wiki/Machine_epsilon
  70 ///
  71 /// # Examples
  72 ///
  73 /// ```rust
  74 /// // deprecated way
  75 /// let e = std::f64::EPSILON;
  76 ///
  77 /// // intended way
  78 /// let e = f64::EPSILON;
  79 /// ```
  80 #[stable(feature = "rust1", since = "1.0.0")]
  81 pub const EPSILON: f64 = f64::EPSILON;
  82
  83 /// Smallest finite `f64` value.
  84 /// Use [`f64::MIN`](../../std/primitive.f64.html#associatedconstant.MIN) instead.
  85 ///
  86 /// # Examples
  87 ///
  88 /// ```rust
  89 /// // deprecated way
  90 /// let min = std::f64::MIN;
  91 ///
  92 /// // intended way
  93 /// let min = f64::MIN;
  94 /// ```
  95 #[stable(feature = "rust1", since = "1.0.0")]
  96 pub const MIN: f64 = f64::MIN;
  97
  98 /// Smallest positive normal `f64` value.
  99 /// Use [`f64::MIN_POSITIVE`](../../std/primitive.f64.html#associatedconstant.MIN_POSITIVE) instead.
 100 ///
 101 /// # Examples
 102 ///
 103 /// ```rust
 104 /// // deprecated way
 105 /// let min = std::f64::MIN_POSITIVE;
 106 ///
 107 /// // intended way
 108 /// let min = f64::MIN_POSITIVE;
 109 /// ```
 110 #[stable(feature = "rust1", since = "1.0.0")]
 111 pub const MIN_POSITIVE: f64 = f64::MIN_POSITIVE;
 112
 113 /// Largest finite `f64` value.
 114 /// Use [`f64::MAX`](../../std/primitive.f64.html#associatedconstant.MAX) instead.
 115 ///
 116 /// # Examples
 117 ///
 118 /// ```rust
 119 /// // deprecated way
 120 /// let max = std::f64::MAX;
 121 ///
 122 /// // intended way
 123 /// let max = f64::MAX;
 124 /// ```
 125 #[stable(feature = "rust1", since = "1.0.0")]
 126 pub const MAX: f64 = f64::MAX;
 127
 128 /// One greater than the minimum possible normal power of 2 exponent.
 129 /// Use [`f64::MIN_EXP`](../../std/primitive.f64.html#associatedconstant.MIN_EXP) instead.
 130 ///
 131 /// # Examples
 132 ///
 133 /// ```rust
 134 /// // deprecated way
 135 /// let min = std::f64::MIN_EXP;
 136 ///
 137 /// // intended way
 138 /// let min = f64::MIN_EXP;
 139 /// ```
 140 #[stable(feature = "rust1", since = "1.0.0")]
 141 pub const MIN_EXP: i32 = f64::MIN_EXP;
 142
 143 /// Maximum possible power of 2 exponent.
 144 /// Use [`f64::MAX_EXP`](../../std/primitive.f64.html#associatedconstant.MAX_EXP) instead.
 145 ///
 146 /// # Examples
 147 ///
 148 /// ```rust
 149 /// // deprecated way
 150 /// let max = std::f64::MAX_EXP;
 151 ///
 152 /// // intended way
 153 /// let max = f64::MAX_EXP;
 154 /// ```
 155 #[stable(feature = "rust1", since = "1.0.0")]
 156 pub const MAX_EXP: i32 = f64::MAX_EXP;
 157
 158 /// Minimum possible normal power of 10 exponent.
 159 /// Use [`f64::MIN_10_EXP`](../../std/primitive.f64.html#associatedconstant.MIN_10_EXP) instead.
 160 ///
 161 /// # Examples
 162 ///
 163 /// ```rust
 164 /// // deprecated way
 165 /// let min = std::f64::MIN_10_EXP;
 166 ///
 167 /// // intended way
 168 /// let min = f64::MIN_10_EXP;
 169 /// ```
 170 #[stable(feature = "rust1", since = "1.0.0")]
 171 pub const MIN_10_EXP: i32 = f64::MIN_10_EXP;
 172
 173 /// Maximum possible power of 10 exponent.
 174 /// Use [`f64::MAX_10_EXP`](../../std/primitive.f64.html#associatedconstant.MAX_10_EXP) instead.
 175 ///
 176 /// # Examples
 177 ///
 178 /// ```rust
 179 /// // deprecated way
 180 /// let max = std::f64::MAX_10_EXP;
 181 ///
 182 /// // intended way
 183 /// let max = f64::MAX_10_EXP;
 184 /// ```
 185 #[stable(feature = "rust1", since = "1.0.0")]
 186 pub const MAX_10_EXP: i32 = f64::MAX_10_EXP;
 187
 188 /// Not a Number (NaN).
 189 /// Use [`f64::NAN`](../../std/primitive.f64.html#associatedconstant.NAN) instead.
 190 ///
 191 /// # Examples
 192 ///
 193 /// ```rust
 194 /// // deprecated way
 195 /// let nan = std::f64::NAN;
 196 ///
 197 /// // intended way
 198 /// let nan = f64::NAN;
 199 /// ```
 200 #[stable(feature = "rust1", since = "1.0.0")]
 201 pub const NAN: f64 = f64::NAN;
 202
 203 /// Infinity (∞).
 204 /// Use [`f64::INFINITY`](../../std/primitive.f64.html#associatedconstant.INFINITY) instead.
 205 ///
 206 /// # Examples
 207 ///
 208 /// ```rust
 209 /// // deprecated way
 210 /// let inf = std::f64::INFINITY;
 211 ///
 212 /// // intended way
 213 /// let inf = f64::INFINITY;
 214 /// ```
 215 #[stable(feature = "rust1", since = "1.0.0")]
 216 pub const INFINITY: f64 = f64::INFINITY;
 217
 218 /// Negative infinity (−∞).
 219 /// Use [`f64::NEG_INFINITY`](../../std/primitive.f64.html#associatedconstant.NEG_INFINITY) instead.
 220 ///
 221 /// # Examples
 222 ///
 223 /// ```rust
 224 /// // deprecated way
 225 /// let ninf = std::f64::NEG_INFINITY;
 226 ///
 227 /// // intended way
 228 /// let ninf = f64::NEG_INFINITY;
 229 /// ```
 230 #[stable(feature = "rust1", since = "1.0.0")]
 231 pub const NEG_INFINITY: f64 = f64::NEG_INFINITY;
 232
 233 /// Basic mathematical constants.
 234 #[stable(feature = "rust1", since = "1.0.0")]
 235 pub mod consts {
 236     // FIXME: replace with mathematical constants from cmath.
 237
 238     /// Archimedes' constant (π)
 239     #[stable(feature = "rust1", since = "1.0.0")]
 240     pub const PI: f64 = 3.14159265358979323846264338327950288_f64;
 241
 242     /// The full circle constant (τ)
 243     ///
 244     /// Equal to 2π.
 245     #[unstable(feature = "tau_constant", issue = "66770")]
 246     pub const TAU: f64 = 6.28318530717958647692528676655900577_f64;
 247
 248     /// π/2
 249     #[stable(feature = "rust1", since = "1.0.0")]
 250     pub const FRAC_PI_2: f64 = 1.57079632679489661923132169163975144_f64;
 251
 252     /// π/3
 253     #[stable(feature = "rust1", since = "1.0.0")]
 254     pub const FRAC_PI_3: f64 = 1.04719755119659774615421446109316763_f64;
 255
 256     /// π/4
 257     #[stable(feature = "rust1", since = "1.0.0")]
 258     pub const FRAC_PI_4: f64 = 0.785398163397448309615660845819875721_f64;
 259
 260     /// π/6
 261     #[stable(feature = "rust1", since = "1.0.0")]
 262     pub const FRAC_PI_6: f64 = 0.52359877559829887307710723054658381_f64;
 263
 264     /// π/8
 265     #[stable(feature = "rust1", since = "1.0.0")]
 266     pub const FRAC_PI_8: f64 = 0.39269908169872415480783042290993786_f64;
 267
 268     /// 1/π
 269     #[stable(feature = "rust1", since = "1.0.0")]
 270     pub const FRAC_1_PI: f64 = 0.318309886183790671537767526745028724_f64;
 271
 272     /// 2/π
 273     #[stable(feature = "rust1", since = "1.0.0")]
 274     pub const FRAC_2_PI: f64 = 0.636619772367581343075535053490057448_f64;
 275
 276     /// 2/sqrt(π)
 277     #[stable(feature = "rust1", since = "1.0.0")]
 278     pub const FRAC_2_SQRT_PI: f64 = 1.12837916709551257389615890312154517_f64;
 279
 280     /// sqrt(2)
 281     #[stable(feature = "rust1", since = "1.0.0")]
 282     pub const SQRT_2: f64 = 1.41421356237309504880168872420969808_f64;
 283
 284     /// 1/sqrt(2)
 285     #[stable(feature = "rust1", since = "1.0.0")]
 286     pub const FRAC_1_SQRT_2: f64 = 0.707106781186547524400844362104849039_f64;
 287
 288     /// Euler's number (e)
 289     #[stable(feature = "rust1", since = "1.0.0")]
 290     pub const E: f64 = 2.71828182845904523536028747135266250_f64;
 291
 292     /// log<sub>2</sub>(10)
 293     #[stable(feature = "extra_log_consts", since = "1.43.0")]
 294     pub const LOG2_10: f64 = 3.32192809488736234787031942948939018_f64;
 295
 296     /// log<sub>2</sub>(e)
 297     #[stable(feature = "rust1", since = "1.0.0")]
 298     pub const LOG2_E: f64 = 1.44269504088896340735992468100189214_f64;
 299
 300     /// log<sub>10</sub>(2)
 301     #[stable(feature = "extra_log_consts", since = "1.43.0")]
 302     pub const LOG10_2: f64 = 0.301029995663981195213738894724493027_f64;
 303
 304     /// log<sub>10</sub>(e)
 305     #[stable(feature = "rust1", since = "1.0.0")]
 306     pub const LOG10_E: f64 = 0.434294481903251827651128918916605082_f64;
 307
 308     /// ln(2)
 309     #[stable(feature = "rust1", since = "1.0.0")]
 310     pub const LN_2: f64 = 0.693147180559945309417232121458176568_f64;
 311
 312     /// ln(10)
 313     #[stable(feature = "rust1", since = "1.0.0")]
 314     pub const LN_10: f64 = 2.30258509299404568401799145468436421_f64;
 315 }
 316
 317 #[lang = "f64"]
 318 #[cfg(not(test))]
 319 impl f64 {
 320     /// The radix or base of the internal representation of `f64`.
 321     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 322     pub const RADIX: u32 = 2;
 323
 324     /// Number of significant digits in base 2.
 325     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 326     pub const MANTISSA_DIGITS: u32 = 53;
 327     /// Approximate number of significant digits in base 10.
 328     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 329     pub const DIGITS: u32 = 15;
 330
 331     /// [Machine epsilon] value for `f64`.
 332     ///
 333     /// This is the difference between `1.0` and the next larger representable number.
 334     ///
 335     /// [Machine epsilon]: https://en.wikipedia.org/wiki/Machine_epsilon
 336     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 337     pub const EPSILON: f64 = 2.2204460492503131e-16_f64;
 338
 339     /// Smallest finite `f64` value.
 340     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 341     pub const MIN: f64 = -1.7976931348623157e+308_f64;
 342     /// Smallest positive normal `f64` value.
 343     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 344     pub const MIN_POSITIVE: f64 = 2.2250738585072014e-308_f64;
 345     /// Largest finite `f64` value.
 346     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 347     pub const MAX: f64 = 1.7976931348623157e+308_f64;
 348
 349     /// One greater than the minimum possible normal power of 2 exponent.
 350     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 351     pub const MIN_EXP: i32 = -1021;
 352     /// Maximum possible power of 2 exponent.
 353     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 354     pub const MAX_EXP: i32 = 1024;
 355
 356     /// Minimum possible normal power of 10 exponent.
 357     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 358     pub const MIN_10_EXP: i32 = -307;
 359     /// Maximum possible power of 10 exponent.
 360     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 361     pub const MAX_10_EXP: i32 = 308;
 362
 363     /// Not a Number (NaN).
 364     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 365     pub const NAN: f64 = 0.0_f64 / 0.0_f64;
 366     /// Infinity (∞).
 367     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 368     pub const INFINITY: f64 = 1.0_f64 / 0.0_f64;
 369     /// Negative infinity (−∞).
 370     #[stable(feature = "assoc_int_consts", since = "1.43.0")]
 371     pub const NEG_INFINITY: f64 = -1.0_f64 / 0.0_f64;
 372
 373     /// Returns `true` if this value is `NaN`.
 374     ///
 375     /// ```
 376     /// let nan = f64::NAN;
 377     /// let f = 7.0_f64;
 378     ///
 379     /// assert!(nan.is_nan());
 380     /// assert!(!f.is_nan());
 381     /// ```
 382     #[stable(feature = "rust1", since = "1.0.0")]
 383     #[inline]
 384     pub fn is_nan(self) -> bool {
 385         self != self
 386     }
 387
 388     // FIXME(#50145): `abs` is publicly unavailable in libcore due to
 389     // concerns about portability, so this implementation is for
 390     // private use internally.
 391     #[inline]
 392     fn abs_private(self) -> f64 {
 393         f64::from_bits(self.to_bits() & 0x7fff_ffff_ffff_ffff)
 394     }
 395
 396     /// Returns `true` if this value is positive infinity or negative infinity, and
 397     /// `false` otherwise.
 398     ///
 399     /// ```
 400     /// let f = 7.0f64;
 401     /// let inf = f64::INFINITY;
 402     /// let neg_inf = f64::NEG_INFINITY;
 403     /// let nan = f64::NAN;
 404     ///
 405     /// assert!(!f.is_infinite());
 406     /// assert!(!nan.is_infinite());
 407     ///
 408     /// assert!(inf.is_infinite());
 409     /// assert!(neg_inf.is_infinite());
 410     /// ```
 411     #[stable(feature = "rust1", since = "1.0.0")]
 412     #[inline]
 413     pub fn is_infinite(self) -> bool {
 414         self.abs_private() == Self::INFINITY
 415     }
 416
 417     /// Returns `true` if this number is neither infinite nor `NaN`.
 418     ///
 419     /// ```
 420     /// let f = 7.0f64;
 421     /// let inf: f64 = f64::INFINITY;
 422     /// let neg_inf: f64 = f64::NEG_INFINITY;
 423     /// let nan: f64 = f64::NAN;
 424     ///
 425     /// assert!(f.is_finite());
 426     ///
 427     /// assert!(!nan.is_finite());
 428     /// assert!(!inf.is_finite());
 429     /// assert!(!neg_inf.is_finite());
 430     /// ```
 431     #[stable(feature = "rust1", since = "1.0.0")]
 432     #[inline]
 433     pub fn is_finite(self) -> bool {
 434         // There's no need to handle NaN separately: if self is NaN,
 435         // the comparison is not true, exactly as desired.
 436         self.abs_private() < Self::INFINITY
 437     }
 438
 439     /// Returns `true` if the number is neither zero, infinite,
 440     /// [subnormal], or `NaN`.
 441     ///
 442     /// ```
 443     /// let min = f64::MIN_POSITIVE; // 2.2250738585072014e-308f64
 444     /// let max = f64::MAX;
 445     /// let lower_than_min = 1.0e-308_f64;
 446     /// let zero = 0.0f64;
 447     ///
 448     /// assert!(min.is_normal());
 449     /// assert!(max.is_normal());
 450     ///
 451     /// assert!(!zero.is_normal());
 452     /// assert!(!f64::NAN.is_normal());
 453     /// assert!(!f64::INFINITY.is_normal());
 454     /// // Values between `0` and `min` are Subnormal.
 455     /// assert!(!lower_than_min.is_normal());
 456     /// ```
 457     /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
 458     #[stable(feature = "rust1", since = "1.0.0")]
 459     #[inline]
 460     pub fn is_normal(self) -> bool {
 461         self.classify() == FpCategory::Normal
 462     }
 463
 464     /// Returns the floating point category of the number. If only one property
 465     /// is going to be tested, it is generally faster to use the specific
 466     /// predicate instead.
 467     ///
 468     /// ```
 469     /// use std::num::FpCategory;
 470     ///
 471     /// let num = 12.4_f64;
 472     /// let inf = f64::INFINITY;
 473     ///
 474     /// assert_eq!(num.classify(), FpCategory::Normal);
 475     /// assert_eq!(inf.classify(), FpCategory::Infinite);
 476     /// ```
 477     #[stable(feature = "rust1", since = "1.0.0")]
 478     pub fn classify(self) -> FpCategory {
 479         const EXP_MASK: u64 = 0x7ff0000000000000;
 480         const MAN_MASK: u64 = 0x000fffffffffffff;
 481
 482         let bits = self.to_bits();
 483         match (bits & MAN_MASK, bits & EXP_MASK) {
 484             (0, 0) => FpCategory::Zero,
 485             (_, 0) => FpCategory::Subnormal,
 486             (0, EXP_MASK) => FpCategory::Infinite,
 487             (_, EXP_MASK) => FpCategory::Nan,
 488             _ => FpCategory::Normal,
 489         }
 490     }
 491
 492     /// Returns `true` if `self` has a positive sign, including `+0.0`, `NaN`s with
 493     /// positive sign bit and positive infinity.
 494     ///
 495     /// ```
 496     /// let f = 7.0_f64;
 497     /// let g = -7.0_f64;
 498     ///
 499     /// assert!(f.is_sign_positive());
 500     /// assert!(!g.is_sign_positive());
 501     /// ```
 502     #[stable(feature = "rust1", since = "1.0.0")]
 503     #[inline]
 504     pub fn is_sign_positive(self) -> bool {
 505         !self.is_sign_negative()
 506     }
 507
 508     #[stable(feature = "rust1", since = "1.0.0")]
 509     #[rustc_deprecated(since = "1.0.0", reason = "renamed to is_sign_positive")]
 510     #[inline]
 511     #[doc(hidden)]
 512     pub fn is_positive(self) -> bool {
 513         self.is_sign_positive()
 514     }
 515
 516     /// Returns `true` if `self` has a negative sign, including `-0.0`, `NaN`s with
 517     /// negative sign bit and negative infinity.
 518     ///
 519     /// ```
 520     /// let f = 7.0_f64;
 521     /// let g = -7.0_f64;
 522     ///
 523     /// assert!(!f.is_sign_negative());
 524     /// assert!(g.is_sign_negative());
 525     /// ```
 526     #[stable(feature = "rust1", since = "1.0.0")]
 527     #[inline]
 528     pub fn is_sign_negative(self) -> bool {
 529         self.to_bits() & 0x8000_0000_0000_0000 != 0
 530     }
 531
 532     #[stable(feature = "rust1", since = "1.0.0")]
 533     #[rustc_deprecated(since = "1.0.0", reason = "renamed to is_sign_negative")]
 534     #[inline]
 535     #[doc(hidden)]
 536     pub fn is_negative(self) -> bool {
 537         self.is_sign_negative()
 538     }
 539
 540     /// Takes the reciprocal (inverse) of a number, `1/x`.
 541     ///
 542     /// ```
 543     /// let x = 2.0_f64;
 544     /// let abs_difference = (x.recip() - (1.0 / x)).abs();
 545     ///
 546     /// assert!(abs_difference < 1e-10);
 547     /// ```
 548     #[stable(feature = "rust1", since = "1.0.0")]
 549     #[inline]
 550     pub fn recip(self) -> f64 {
 551         1.0 / self
 552     }
 553
 554     /// Converts radians to degrees.
 555     ///
 556     /// ```
 557     /// let angle = std::f64::consts::PI;
 558     ///
 559     /// let abs_difference = (angle.to_degrees() - 180.0).abs();
 560     ///
 561     /// assert!(abs_difference < 1e-10);
 562     /// ```
 563     #[stable(feature = "rust1", since = "1.0.0")]
 564     #[inline]
 565     pub fn to_degrees(self) -> f64 {
 566         // The division here is correctly rounded with respect to the true
 567         // value of 180/π. (This differs from f32, where a constant must be
 568         // used to ensure a correctly rounded result.)
 569         self * (180.0f64 / consts::PI)
 570     }
 571
 572     /// Converts degrees to radians.
 573     ///
 574     /// ```
 575     /// let angle = 180.0_f64;
 576     ///
 577     /// let abs_difference = (angle.to_radians() - std::f64::consts::PI).abs();
 578     ///
 579     /// assert!(abs_difference < 1e-10);
 580     /// ```
 581     #[stable(feature = "rust1", since = "1.0.0")]
 582     #[inline]
 583     pub fn to_radians(self) -> f64 {
 584         let value: f64 = consts::PI;
 585         self * (value / 180.0)
 586     }
 587
 588     /// Returns the maximum of the two numbers.
 589     ///
 590     /// ```
 591     /// let x = 1.0_f64;
 592     /// let y = 2.0_f64;
 593     ///
 594     /// assert_eq!(x.max(y), y);
 595     /// ```
 596     ///
 597     /// If one of the arguments is NaN, then the other argument is returned.
 598     #[stable(feature = "rust1", since = "1.0.0")]
 599     #[inline]
 600     pub fn max(self, other: f64) -> f64 {
 601         intrinsics::maxnumf64(self, other)
 602     }
 603
 604     /// Returns the minimum of the two numbers.
 605     ///
 606     /// ```
 607     /// let x = 1.0_f64;
 608     /// let y = 2.0_f64;
 609     ///
 610     /// assert_eq!(x.min(y), x);
 611     /// ```
 612     ///
 613     /// If one of the arguments is NaN, then the other argument is returned.
 614     #[stable(feature = "rust1", since = "1.0.0")]
 615     #[inline]
 616     pub fn min(self, other: f64) -> f64 {
 617         intrinsics::minnumf64(self, other)
 618     }
 619
 620     /// Rounds toward zero and converts to any primitive integer type,
 621     /// assuming that the value is finite and fits in that type.
 622     ///
 623     /// ```
 624     /// let value = 4.6_f64;
 625     /// let rounded = unsafe { value.to_int_unchecked::<u16>() };
 626     /// assert_eq!(rounded, 4);
 627     ///
 628     /// let value = -128.9_f64;
 629     /// let rounded = unsafe { value.to_int_unchecked::<i8>() };
 630     /// assert_eq!(rounded, i8::MIN);
 631     /// ```
 632     ///
 633     /// # Safety
 634     ///
 635     /// The value must:
 636     ///
 637     /// * Not be `NaN`
 638     /// * Not be infinite
 639     /// * Be representable in the return type `Int`, after truncating off its fractional part
 640     #[stable(feature = "float_approx_unchecked_to", since = "1.44.0")]
 641     #[inline]
 642     pub unsafe fn to_int_unchecked<Int>(self) -> Int
 643     where
 644         Self: FloatToInt<Int>,
 645     {
 646         // SAFETY: the caller must uphold the safety contract for
 647         // `FloatToInt::to_int_unchecked`.
 648         unsafe { FloatToInt::<Int>::to_int_unchecked(self) }
 649     }
 650
 651     /// Raw transmutation to `u64`.
 652     ///
 653     /// This is currently identical to `transmute::<f64, u64>(self)` on all platforms.
 654     ///
 655     /// See `from_bits` for some discussion of the portability of this operation
 656     /// (there are almost no issues).
 657     ///
 658     /// Note that this function is distinct from `as` casting, which attempts to
 659     /// preserve the *numeric* value, and not the bitwise value.
 660     ///
 661     /// # Examples
 662     ///
 663     /// ```
 664     /// assert!((1f64).to_bits() != 1f64 as u64); // to_bits() is not casting!
 665     /// assert_eq!((12.5f64).to_bits(), 0x4029000000000000);
 666     ///
 667     /// ```
 668     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 669     #[inline]
 670     pub fn to_bits(self) -> u64 {
 671         // SAFETY: `u64` is a plain old datatype so we can always transmute to it
 672         unsafe { mem::transmute(self) }
 673     }
 674
 675     /// Raw transmutation from `u64`.
 676     ///
 677     /// This is currently identical to `transmute::<u64, f64>(v)` on all platforms.
 678     /// It turns out this is incredibly portable, for two reasons:
 679     ///
 680     /// * Floats and Ints have the same endianness on all supported platforms.
 681     /// * IEEE-754 very precisely specifies the bit layout of floats.
 682     ///
 683     /// However there is one caveat: prior to the 2008 version of IEEE-754, how
 684     /// to interpret the NaN signaling bit wasn't actually specified. Most platforms
 685     /// (notably x86 and ARM) picked the interpretation that was ultimately
 686     /// standardized in 2008, but some didn't (notably MIPS). As a result, all
 687     /// signaling NaNs on MIPS are quiet NaNs on x86, and vice-versa.
 688     ///
 689     /// Rather than trying to preserve signaling-ness cross-platform, this
 690     /// implementation favours preserving the exact bits. This means that
 691     /// any payloads encoded in NaNs will be preserved even if the result of
 692     /// this method is sent over the network from an x86 machine to a MIPS one.
 693     ///
 694     /// If the results of this method are only manipulated by the same
 695     /// architecture that produced them, then there is no portability concern.
 696     ///
 697     /// If the input isn't NaN, then there is no portability concern.
 698     ///
 699     /// If you don't care about signalingness (very likely), then there is no
 700     /// portability concern.
 701     ///
 702     /// Note that this function is distinct from `as` casting, which attempts to
 703     /// preserve the *numeric* value, and not the bitwise value.
 704     ///
 705     /// # Examples
 706     ///
 707     /// ```
 708     /// let v = f64::from_bits(0x4029000000000000);
 709     /// assert_eq!(v, 12.5);
 710     /// ```
 711     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 712     #[inline]
 713     pub fn from_bits(v: u64) -> Self {
 714         // SAFETY: `u64` is a plain old datatype so we can always transmute from it
 715         // It turns out the safety issues with sNaN were overblown! Hooray!
 716         unsafe { mem::transmute(v) }
 717     }
 718
 719     /// Return the memory representation of this floating point number as a byte array in
 720     /// big-endian (network) byte order.
 721     ///
 722     /// # Examples
 723     ///
 724     /// ```
 725     /// let bytes = 12.5f64.to_be_bytes();
 726     /// assert_eq!(bytes, [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
 727     /// ```
 728     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 729     #[inline]
 730     pub fn to_be_bytes(self) -> [u8; 8] {
 731         self.to_bits().to_be_bytes()
 732     }
 733
 734     /// Return the memory representation of this floating point number as a byte array in
 735     /// little-endian byte order.
 736     ///
 737     /// # Examples
 738     ///
 739     /// ```
 740     /// let bytes = 12.5f64.to_le_bytes();
 741     /// assert_eq!(bytes, [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]);
 742     /// ```
 743     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 744     #[inline]
 745     pub fn to_le_bytes(self) -> [u8; 8] {
 746         self.to_bits().to_le_bytes()
 747     }
 748
 749     /// Return the memory representation of this floating point number as a byte array in
 750     /// native byte order.
 751     ///
 752     /// As the target platform's native endianness is used, portable code
 753     /// should use [`to_be_bytes`] or [`to_le_bytes`], as appropriate, instead.
 754     ///
 755     /// [`to_be_bytes`]: #method.to_be_bytes
 756     /// [`to_le_bytes`]: #method.to_le_bytes
 757     ///
 758     /// # Examples
 759     ///
 760     /// ```
 761     /// let bytes = 12.5f64.to_ne_bytes();
 762     /// assert_eq!(
 763     ///     bytes,
 764     ///     if cfg!(target_endian = "big") {
 765     ///         [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
 766     ///     } else {
 767     ///         [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]
 768     ///     }
 769     /// );
 770     /// ```
 771     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 772     #[inline]
 773     pub fn to_ne_bytes(self) -> [u8; 8] {
 774         self.to_bits().to_ne_bytes()
 775     }
 776
 777     /// Create a floating point value from its representation as a byte array in big endian.
 778     ///
 779     /// # Examples
 780     ///
 781     /// ```
 782     /// let value = f64::from_be_bytes([0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
 783     /// assert_eq!(value, 12.5);
 784     /// ```
 785     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 786     #[inline]
 787     pub fn from_be_bytes(bytes: [u8; 8]) -> Self {
 788         Self::from_bits(u64::from_be_bytes(bytes))
 789     }
 790
 791     /// Create a floating point value from its representation as a byte array in little endian.
 792     ///
 793     /// # Examples
 794     ///
 795     /// ```
 796     /// let value = f64::from_le_bytes([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]);
 797     /// assert_eq!(value, 12.5);
 798     /// ```
 799     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 800     #[inline]
 801     pub fn from_le_bytes(bytes: [u8; 8]) -> Self {
 802         Self::from_bits(u64::from_le_bytes(bytes))
 803     }
 804
 805     /// Create a floating point value from its representation as a byte array in native endian.
 806     ///
 807     /// As the target platform's native endianness is used, portable code
 808     /// likely wants to use [`from_be_bytes`] or [`from_le_bytes`], as
 809     /// appropriate instead.
 810     ///
 811     /// [`from_be_bytes`]: #method.from_be_bytes
 812     /// [`from_le_bytes`]: #method.from_le_bytes
 813     ///
 814     /// # Examples
 815     ///
 816     /// ```
 817     /// let value = f64::from_ne_bytes(if cfg!(target_endian = "big") {
 818     ///     [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
 819     /// } else {
 820     ///     [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]
 821     /// });
 822     /// assert_eq!(value, 12.5);
 823     /// ```
 824     #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
 825     #[inline]
 826     pub fn from_ne_bytes(bytes: [u8; 8]) -> Self {
 827         Self::from_bits(u64::from_ne_bytes(bytes))
 828     }
 829
 830     /// Returns an ordering between self and other values.
 831     /// Unlike the standard partial comparison between floating point numbers,
 832     /// this comparison always produces an ordering in accordance to
 833     /// the totalOrder predicate as defined in IEEE 754 (2008 revision)
 834     /// floating point standard. The values are ordered in following order:
 835     /// - Negative quiet NaN
 836     /// - Negative signaling NaN
 837     /// - Negative infinity
 838     /// - Negative numbers
 839     /// - Negative subnormal numbers
 840     /// - Negative zero
 841     /// - Positive zero
 842     /// - Positive subnormal numbers
 843     /// - Positive numbers
 844     /// - Positive infinity
 845     /// - Positive signaling NaN
 846     /// - Positive quiet NaN
 847     ///
 848     /// # Example
 849     /// ```
 850     /// #![feature(total_cmp)]
 851     /// struct GoodBoy {
 852     ///     name: String,
 853     ///     weight: f64,
 854     /// }
 855     ///
 856     /// let mut bois = vec![
 857     ///     GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
 858     ///     GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
 859     ///     GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
 860     ///     GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
 861     ///     GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
 862     ///     GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
 863     /// ];
 864     ///
 865     /// bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));
 866     /// # assert!(bois.into_iter().map(|b| b.weight)
 867     /// #     .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
 868     /// #     .all(|(a, b)| a.to_bits() == b.to_bits()))
 869     /// ```
 870     #[unstable(feature = "total_cmp", issue = "72599")]
 871     #[inline]
 872     pub fn total_cmp(&self, other: &Self) -> crate::cmp::Ordering {
 873         let mut left = self.to_bits() as i64;
 874         let mut right = other.to_bits() as i64;
 875
 876         // In case of negatives, flip all the bits except the sign
 877         // to achieve a similar layout as two's complement integers
 878         //
 879         // Why does this work? IEEE 754 floats consist of three fields:
 880         // Sign bit, exponent and mantissa. The set of exponent and mantissa
 881         // fields as a whole have the property that their bitwise order is
 882         // equal to the numeric magnitude where the magnitude is defined.
 883         // The magnitude is not normally defined on NaN values, but
 884         // IEEE 754 totalOrder defines the NaN values also to follow the
 885         // bitwise order. This leads to order explained in the doc comment.
 886         // However, the representation of magnitude is the same for negative
 887         // and positive numbers – only the sign bit is different.
 888         // To easily compare the floats as signed integers, we need to
 889         // flip the exponent and mantissa bits in case of negative numbers.
 890         // We effectively convert the numbers to "two's complement" form.
 891         //
 892         // To do the flipping, we construct a mask and XOR against it.
 893         // We branchlessly calculate an "all-ones except for the sign bit"
 894         // mask from negative-signed values: right shifting sign-extends
 895         // the integer, so we "fill" the mask with sign bits, and then
 896         // convert to unsigned to push one more zero bit.
 897         // On positive values, the mask is all zeros, so it's a no-op.
 898         left ^= (((left >> 63) as u64) >> 1) as i64;
 899         right ^= (((right >> 63) as u64) >> 1) as i64;
 900
 901         left.cmp(&right)
 902     }
 903 }