library/core/src/num/f32.rs

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