src/libstd/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 #![stable(feature = "rust1", since = "1.0.0")]
   9 #![allow(missing_docs)]
  10
  11 #[cfg(not(test))]
  12 use crate::intrinsics;
  13 #[cfg(not(test))]
  14 use crate::sys::cmath;
  15
  16 #[stable(feature = "rust1", since = "1.0.0")]
  17 pub use core::f64::{RADIX, MANTISSA_DIGITS, DIGITS, EPSILON};
  18 #[stable(feature = "rust1", since = "1.0.0")]
  19 pub use core::f64::{MIN_EXP, MAX_EXP, MIN_10_EXP};
  20 #[stable(feature = "rust1", since = "1.0.0")]
  21 pub use core::f64::{MAX_10_EXP, NAN, INFINITY, NEG_INFINITY};
  22 #[stable(feature = "rust1", since = "1.0.0")]
  23 pub use core::f64::{MIN, MIN_POSITIVE, MAX};
  24 #[stable(feature = "rust1", since = "1.0.0")]
  25 pub use core::f64::consts;
  26
  27 #[cfg(not(test))]
  28 #[lang = "f64_runtime"]
  29 impl f64 {
  30     /// Returns the largest integer less than or equal to a number.
  31     ///
  32     /// # Examples
  33     ///
  34     /// ```
  35     /// let f = 3.7_f64;
  36     /// let g = 3.0_f64;
  37     /// let h = -3.7_f64;
  38     ///
  39     /// assert_eq!(f.floor(), 3.0);
  40     /// assert_eq!(g.floor(), 3.0);
  41     /// assert_eq!(h.floor(), -4.0);
  42     /// ```
  43     #[stable(feature = "rust1", since = "1.0.0")]
  44     #[inline]
  45     pub fn floor(self) -> f64 {
  46         unsafe { intrinsics::floorf64(self) }
  47     }
  48
  49     /// Returns the smallest integer greater than or equal to a number.
  50     ///
  51     /// # Examples
  52     ///
  53     /// ```
  54     /// let f = 3.01_f64;
  55     /// let g = 4.0_f64;
  56     ///
  57     /// assert_eq!(f.ceil(), 4.0);
  58     /// assert_eq!(g.ceil(), 4.0);
  59     /// ```
  60     #[stable(feature = "rust1", since = "1.0.0")]
  61     #[inline]
  62     pub fn ceil(self) -> f64 {
  63         unsafe { intrinsics::ceilf64(self) }
  64     }
  65
  66     /// Returns the nearest integer to a number. Round half-way cases away from
  67     /// `0.0`.
  68     ///
  69     /// # Examples
  70     ///
  71     /// ```
  72     /// let f = 3.3_f64;
  73     /// let g = -3.3_f64;
  74     ///
  75     /// assert_eq!(f.round(), 3.0);
  76     /// assert_eq!(g.round(), -3.0);
  77     /// ```
  78     #[stable(feature = "rust1", since = "1.0.0")]
  79     #[inline]
  80     pub fn round(self) -> f64 {
  81         unsafe { intrinsics::roundf64(self) }
  82     }
  83
  84     /// Returns the integer part of a number.
  85     ///
  86     /// # Examples
  87     ///
  88     /// ```
  89     /// let f = 3.7_f64;
  90     /// let g = 3.0_f64;
  91     /// let h = -3.7_f64;
  92     ///
  93     /// assert_eq!(f.trunc(), 3.0);
  94     /// assert_eq!(g.trunc(), 3.0);
  95     /// assert_eq!(h.trunc(), -3.0);
  96     /// ```
  97     #[stable(feature = "rust1", since = "1.0.0")]
  98     #[inline]
  99     pub fn trunc(self) -> f64 {
 100         unsafe { intrinsics::truncf64(self) }
 101     }
 102
 103     /// Returns the fractional part of a number.
 104     ///
 105     /// # Examples
 106     ///
 107     /// ```
 108     /// let x = 3.5_f64;
 109     /// let y = -3.5_f64;
 110     /// let abs_difference_x = (x.fract() - 0.5).abs();
 111     /// let abs_difference_y = (y.fract() - (-0.5)).abs();
 112     ///
 113     /// assert!(abs_difference_x < 1e-10);
 114     /// assert!(abs_difference_y < 1e-10);
 115     /// ```
 116     #[stable(feature = "rust1", since = "1.0.0")]
 117     #[inline]
 118     pub fn fract(self) -> f64 { self - self.trunc() }
 119
 120     /// Computes the absolute value of `self`. Returns `NAN` if the
 121     /// number is `NAN`.
 122     ///
 123     /// # Examples
 124     ///
 125     /// ```
 126     /// use std::f64;
 127     ///
 128     /// let x = 3.5_f64;
 129     /// let y = -3.5_f64;
 130     ///
 131     /// let abs_difference_x = (x.abs() - x).abs();
 132     /// let abs_difference_y = (y.abs() - (-y)).abs();
 133     ///
 134     /// assert!(abs_difference_x < 1e-10);
 135     /// assert!(abs_difference_y < 1e-10);
 136     ///
 137     /// assert!(f64::NAN.abs().is_nan());
 138     /// ```
 139     #[stable(feature = "rust1", since = "1.0.0")]
 140     #[inline]
 141     pub fn abs(self) -> f64 {
 142         unsafe { intrinsics::fabsf64(self) }
 143     }
 144
 145     /// Returns a number that represents the sign of `self`.
 146     ///
 147     /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
 148     /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
 149     /// - `NAN` if the number is `NAN`
 150     ///
 151     /// # Examples
 152     ///
 153     /// ```
 154     /// use std::f64;
 155     ///
 156     /// let f = 3.5_f64;
 157     ///
 158     /// assert_eq!(f.signum(), 1.0);
 159     /// assert_eq!(f64::NEG_INFINITY.signum(), -1.0);
 160     ///
 161     /// assert!(f64::NAN.signum().is_nan());
 162     /// ```
 163     #[stable(feature = "rust1", since = "1.0.0")]
 164     #[inline]
 165     pub fn signum(self) -> f64 {
 166         if self.is_nan() {
 167             NAN
 168         } else {
 169             1.0_f64.copysign(self)
 170         }
 171     }
 172
 173     /// Returns a number composed of the magnitude of `self` and the sign of
 174     /// `sign`.
 175     ///
 176     /// Equal to `self` if the sign of `self` and `sign` are the same, otherwise
 177     /// equal to `-self`. If `self` is a `NAN`, then a `NAN` with the sign of
 178     /// `sign` is returned.
 179     ///
 180     /// # Examples
 181     ///
 182     /// ```
 183     /// use std::f64;
 184     ///
 185     /// let f = 3.5_f64;
 186     ///
 187     /// assert_eq!(f.copysign(0.42), 3.5_f64);
 188     /// assert_eq!(f.copysign(-0.42), -3.5_f64);
 189     /// assert_eq!((-f).copysign(0.42), 3.5_f64);
 190     /// assert_eq!((-f).copysign(-0.42), -3.5_f64);
 191     ///
 192     /// assert!(f64::NAN.copysign(1.0).is_nan());
 193     /// ```
 194     #[inline]
 195     #[must_use]
 196     #[stable(feature = "copysign", since = "1.35.0")]
 197     pub fn copysign(self, sign: f64) -> f64 {
 198         unsafe { intrinsics::copysignf64(self, sign) }
 199     }
 200
 201     /// Fused multiply-add. Computes `(self * a) + b` with only one rounding
 202     /// error, yielding a more accurate result than an unfused multiply-add.
 203     ///
 204     /// Using `mul_add` can be more performant than an unfused multiply-add if
 205     /// the target architecture has a dedicated `fma` CPU instruction.
 206     ///
 207     /// # Examples
 208     ///
 209     /// ```
 210     /// let m = 10.0_f64;
 211     /// let x = 4.0_f64;
 212     /// let b = 60.0_f64;
 213     ///
 214     /// // 100.0
 215     /// let abs_difference = (m.mul_add(x, b) - ((m * x) + b)).abs();
 216     ///
 217     /// assert!(abs_difference < 1e-10);
 218     /// ```
 219     #[stable(feature = "rust1", since = "1.0.0")]
 220     #[inline]
 221     pub fn mul_add(self, a: f64, b: f64) -> f64 {
 222         unsafe { intrinsics::fmaf64(self, a, b) }
 223     }
 224
 225     /// Calculates Euclidean division, the matching method for `rem_euclid`.
 226     ///
 227     /// This computes the integer `n` such that
 228     /// `self = n * rhs + self.rem_euclid(rhs)`.
 229     /// In other words, the result is `self / rhs` rounded to the integer `n`
 230     /// such that `self >= n * rhs`.
 231     ///
 232     /// # Examples
 233     ///
 234     /// ```
 235     /// let a: f64 = 7.0;
 236     /// let b = 4.0;
 237     /// assert_eq!(a.div_euclid(b), 1.0); // 7.0 > 4.0 * 1.0
 238     /// assert_eq!((-a).div_euclid(b), -2.0); // -7.0 >= 4.0 * -2.0
 239     /// assert_eq!(a.div_euclid(-b), -1.0); // 7.0 >= -4.0 * -1.0
 240     /// assert_eq!((-a).div_euclid(-b), 2.0); // -7.0 >= -4.0 * 2.0
 241     /// ```
 242     #[inline]
 243     #[stable(feature = "euclidean_division", since = "1.38.0")]
 244     pub fn div_euclid(self, rhs: f64) -> f64 {
 245         let q = (self / rhs).trunc();
 246         if self % rhs < 0.0 {
 247             return if rhs > 0.0 { q - 1.0 } else { q + 1.0 };
 248         }
 249         q
 250     }
 251
 252     /// Calculates the least nonnegative remainder of `self (mod rhs)`.
 253     ///
 254     /// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
 255     /// most cases. However, due to a floating point round-off error it can
 256     /// result in `r == rhs.abs()`, violating the mathematical definition, if
 257     /// `self` is much smaller than `rhs.abs()` in magnitude and `self < 0.0`.
 258     /// This result is not an element of the function's codomain, but it is the
 259     /// closest floating point number in the real numbers and thus fulfills the
 260     /// property `self == self.div_euclid(rhs) * rhs + self.rem_euclid(rhs)`
 261     /// approximatively.
 262     ///
 263     /// # Examples
 264     ///
 265     /// ```
 266     /// let a: f64 = 7.0;
 267     /// let b = 4.0;
 268     /// assert_eq!(a.rem_euclid(b), 3.0);
 269     /// assert_eq!((-a).rem_euclid(b), 1.0);
 270     /// assert_eq!(a.rem_euclid(-b), 3.0);
 271     /// assert_eq!((-a).rem_euclid(-b), 1.0);
 272     /// // limitation due to round-off error
 273     /// assert!((-std::f64::EPSILON).rem_euclid(3.0) != 0.0);
 274     /// ```
 275     #[inline]
 276     #[stable(feature = "euclidean_division", since = "1.38.0")]
 277     pub fn rem_euclid(self, rhs: f64) -> f64 {
 278         let r = self % rhs;
 279         if r < 0.0 {
 280             r + rhs.abs()
 281         } else {
 282             r
 283         }
 284     }
 285
 286     /// Raises a number to an integer power.
 287     ///
 288     /// Using this function is generally faster than using `powf`
 289     ///
 290     /// # Examples
 291     ///
 292     /// ```
 293     /// let x = 2.0_f64;
 294     /// let abs_difference = (x.powi(2) - (x * x)).abs();
 295     ///
 296     /// assert!(abs_difference < 1e-10);
 297     /// ```
 298     #[stable(feature = "rust1", since = "1.0.0")]
 299     #[inline]
 300     pub fn powi(self, n: i32) -> f64 {
 301         unsafe { intrinsics::powif64(self, n) }
 302     }
 303
 304     /// Raises a number to a floating point power.
 305     ///
 306     /// # Examples
 307     ///
 308     /// ```
 309     /// let x = 2.0_f64;
 310     /// let abs_difference = (x.powf(2.0) - (x * x)).abs();
 311     ///
 312     /// assert!(abs_difference < 1e-10);
 313     /// ```
 314     #[stable(feature = "rust1", since = "1.0.0")]
 315     #[inline]
 316     pub fn powf(self, n: f64) -> f64 {
 317         unsafe { intrinsics::powf64(self, n) }
 318     }
 319
 320     /// Takes the square root of a number.
 321     ///
 322     /// Returns NaN if `self` is a negative number.
 323     ///
 324     /// # Examples
 325     ///
 326     /// ```
 327     /// let positive = 4.0_f64;
 328     /// let negative = -4.0_f64;
 329     ///
 330     /// let abs_difference = (positive.sqrt() - 2.0).abs();
 331     ///
 332     /// assert!(abs_difference < 1e-10);
 333     /// assert!(negative.sqrt().is_nan());
 334     /// ```
 335     #[stable(feature = "rust1", since = "1.0.0")]
 336     #[inline]
 337     pub fn sqrt(self) -> f64 {
 338         if self < 0.0 {
 339             NAN
 340         } else {
 341             unsafe { intrinsics::sqrtf64(self) }
 342         }
 343     }
 344
 345     /// Returns `e^(self)`, (the exponential function).
 346     ///
 347     /// # Examples
 348     ///
 349     /// ```
 350     /// let one = 1.0_f64;
 351     /// // e^1
 352     /// let e = one.exp();
 353     ///
 354     /// // ln(e) - 1 == 0
 355     /// let abs_difference = (e.ln() - 1.0).abs();
 356     ///
 357     /// assert!(abs_difference < 1e-10);
 358     /// ```
 359     #[stable(feature = "rust1", since = "1.0.0")]
 360     #[inline]
 361     pub fn exp(self) -> f64 {
 362         unsafe { intrinsics::expf64(self) }
 363     }
 364
 365     /// Returns `2^(self)`.
 366     ///
 367     /// # Examples
 368     ///
 369     /// ```
 370     /// let f = 2.0_f64;
 371     ///
 372     /// // 2^2 - 4 == 0
 373     /// let abs_difference = (f.exp2() - 4.0).abs();
 374     ///
 375     /// assert!(abs_difference < 1e-10);
 376     /// ```
 377     #[stable(feature = "rust1", since = "1.0.0")]
 378     #[inline]
 379     pub fn exp2(self) -> f64 {
 380         unsafe { intrinsics::exp2f64(self) }
 381     }
 382
 383     /// Returns the natural logarithm of the number.
 384     ///
 385     /// # Examples
 386     ///
 387     /// ```
 388     /// let one = 1.0_f64;
 389     /// // e^1
 390     /// let e = one.exp();
 391     ///
 392     /// // ln(e) - 1 == 0
 393     /// let abs_difference = (e.ln() - 1.0).abs();
 394     ///
 395     /// assert!(abs_difference < 1e-10);
 396     /// ```
 397     #[stable(feature = "rust1", since = "1.0.0")]
 398     #[inline]
 399     pub fn ln(self) -> f64 {
 400         self.log_wrapper(|n| { unsafe { intrinsics::logf64(n) } })
 401     }
 402
 403     /// Returns the logarithm of the number with respect to an arbitrary base.
 404     ///
 405     /// The result may not be correctly rounded owing to implementation details;
 406     /// `self.log2()` can produce more accurate results for base 2, and
 407     /// `self.log10()` can produce more accurate results for base 10.
 408     ///
 409     /// # Examples
 410     ///
 411     /// ```
 412     /// let twenty_five = 25.0_f64;
 413     ///
 414     /// // log5(25) - 2 == 0
 415     /// let abs_difference = (twenty_five.log(5.0) - 2.0).abs();
 416     ///
 417     /// assert!(abs_difference < 1e-10);
 418     /// ```
 419     #[stable(feature = "rust1", since = "1.0.0")]
 420     #[inline]
 421     pub fn log(self, base: f64) -> f64 { self.ln() / base.ln() }
 422
 423     /// Returns the base 2 logarithm of the number.
 424     ///
 425     /// # Examples
 426     ///
 427     /// ```
 428     /// let four = 4.0_f64;
 429     ///
 430     /// // log2(4) - 2 == 0
 431     /// let abs_difference = (four.log2() - 2.0).abs();
 432     ///
 433     /// assert!(abs_difference < 1e-10);
 434     /// ```
 435     #[stable(feature = "rust1", since = "1.0.0")]
 436     #[inline]
 437     pub fn log2(self) -> f64 {
 438         self.log_wrapper(|n| {
 439             #[cfg(target_os = "android")]
 440                 return crate::sys::android::log2f64(n);
 441             #[cfg(not(target_os = "android"))]
 442                 return unsafe { intrinsics::log2f64(n) };
 443         })
 444     }
 445
 446     /// Returns the base 10 logarithm of the number.
 447     ///
 448     /// # Examples
 449     ///
 450     /// ```
 451     /// let hundred = 100.0_f64;
 452     ///
 453     /// // log10(100) - 2 == 0
 454     /// let abs_difference = (hundred.log10() - 2.0).abs();
 455     ///
 456     /// assert!(abs_difference < 1e-10);
 457     /// ```
 458     #[stable(feature = "rust1", since = "1.0.0")]
 459     #[inline]
 460     pub fn log10(self) -> f64 {
 461         self.log_wrapper(|n| { unsafe { intrinsics::log10f64(n) } })
 462     }
 463
 464     /// The positive difference of two numbers.
 465     ///
 466     /// * If `self <= other`: `0:0`
 467     /// * Else: `self - other`
 468     ///
 469     /// # Examples
 470     ///
 471     /// ```
 472     /// let x = 3.0_f64;
 473     /// let y = -3.0_f64;
 474     ///
 475     /// let abs_difference_x = (x.abs_sub(1.0) - 2.0).abs();
 476     /// let abs_difference_y = (y.abs_sub(1.0) - 0.0).abs();
 477     ///
 478     /// assert!(abs_difference_x < 1e-10);
 479     /// assert!(abs_difference_y < 1e-10);
 480     /// ```
 481     #[stable(feature = "rust1", since = "1.0.0")]
 482     #[inline]
 483     #[rustc_deprecated(since = "1.10.0",
 484     reason = "you probably meant `(self - other).abs()`: \
 485                                  this operation is `(self - other).max(0.0)` \
 486                                  except that `abs_sub` also propagates NaNs (also \
 487                                  known as `fdim` in C). If you truly need the positive \
 488                                  difference, consider using that expression or the C function \
 489                                  `fdim`, depending on how you wish to handle NaN (please consider \
 490                                  filing an issue describing your use-case too).")]
 491     pub fn abs_sub(self, other: f64) -> f64 {
 492         unsafe { cmath::fdim(self, other) }
 493     }
 494
 495     /// Takes the cubic root of a number.
 496     ///
 497     /// # Examples
 498     ///
 499     /// ```
 500     /// let x = 8.0_f64;
 501     ///
 502     /// // x^(1/3) - 2 == 0
 503     /// let abs_difference = (x.cbrt() - 2.0).abs();
 504     ///
 505     /// assert!(abs_difference < 1e-10);
 506     /// ```
 507     #[stable(feature = "rust1", since = "1.0.0")]
 508     #[inline]
 509     pub fn cbrt(self) -> f64 {
 510         unsafe { cmath::cbrt(self) }
 511     }
 512
 513     /// Calculates the length of the hypotenuse of a right-angle triangle given
 514     /// legs of length `x` and `y`.
 515     ///
 516     /// # Examples
 517     ///
 518     /// ```
 519     /// let x = 2.0_f64;
 520     /// let y = 3.0_f64;
 521     ///
 522     /// // sqrt(x^2 + y^2)
 523     /// let abs_difference = (x.hypot(y) - (x.powi(2) + y.powi(2)).sqrt()).abs();
 524     ///
 525     /// assert!(abs_difference < 1e-10);
 526     /// ```
 527     #[stable(feature = "rust1", since = "1.0.0")]
 528     #[inline]
 529     pub fn hypot(self, other: f64) -> f64 {
 530         unsafe { cmath::hypot(self, other) }
 531     }
 532
 533     /// Computes the sine of a number (in radians).
 534     ///
 535     /// # Examples
 536     ///
 537     /// ```
 538     /// use std::f64;
 539     ///
 540     /// let x = f64::consts::FRAC_PI_2;
 541     ///
 542     /// let abs_difference = (x.sin() - 1.0).abs();
 543     ///
 544     /// assert!(abs_difference < 1e-10);
 545     /// ```
 546     #[stable(feature = "rust1", since = "1.0.0")]
 547     #[inline]
 548     pub fn sin(self) -> f64 {
 549         unsafe { intrinsics::sinf64(self) }
 550     }
 551
 552     /// Computes the cosine of a number (in radians).
 553     ///
 554     /// # Examples
 555     ///
 556     /// ```
 557     /// use std::f64;
 558     ///
 559     /// let x = 2.0 * f64::consts::PI;
 560     ///
 561     /// let abs_difference = (x.cos() - 1.0).abs();
 562     ///
 563     /// assert!(abs_difference < 1e-10);
 564     /// ```
 565     #[stable(feature = "rust1", since = "1.0.0")]
 566     #[inline]
 567     pub fn cos(self) -> f64 {
 568         unsafe { intrinsics::cosf64(self) }
 569     }
 570
 571     /// Computes the tangent of a number (in radians).
 572     ///
 573     /// # Examples
 574     ///
 575     /// ```
 576     /// use std::f64;
 577     ///
 578     /// let x = f64::consts::FRAC_PI_4;
 579     /// let abs_difference = (x.tan() - 1.0).abs();
 580     ///
 581     /// assert!(abs_difference < 1e-14);
 582     /// ```
 583     #[stable(feature = "rust1", since = "1.0.0")]
 584     #[inline]
 585     pub fn tan(self) -> f64 {
 586         unsafe { cmath::tan(self) }
 587     }
 588
 589     /// Computes the arcsine of a number. Return value is in radians in
 590     /// the range [-pi/2, pi/2] or NaN if the number is outside the range
 591     /// [-1, 1].
 592     ///
 593     /// # Examples
 594     ///
 595     /// ```
 596     /// use std::f64;
 597     ///
 598     /// let f = f64::consts::FRAC_PI_2;
 599     ///
 600     /// // asin(sin(pi/2))
 601     /// let abs_difference = (f.sin().asin() - f64::consts::FRAC_PI_2).abs();
 602     ///
 603     /// assert!(abs_difference < 1e-10);
 604     /// ```
 605     #[stable(feature = "rust1", since = "1.0.0")]
 606     #[inline]
 607     pub fn asin(self) -> f64 {
 608         unsafe { cmath::asin(self) }
 609     }
 610
 611     /// Computes the arccosine of a number. Return value is in radians in
 612     /// the range [0, pi] or NaN if the number is outside the range
 613     /// [-1, 1].
 614     ///
 615     /// # Examples
 616     ///
 617     /// ```
 618     /// use std::f64;
 619     ///
 620     /// let f = f64::consts::FRAC_PI_4;
 621     ///
 622     /// // acos(cos(pi/4))
 623     /// let abs_difference = (f.cos().acos() - f64::consts::FRAC_PI_4).abs();
 624     ///
 625     /// assert!(abs_difference < 1e-10);
 626     /// ```
 627     #[stable(feature = "rust1", since = "1.0.0")]
 628     #[inline]
 629     pub fn acos(self) -> f64 {
 630         unsafe { cmath::acos(self) }
 631     }
 632
 633     /// Computes the arctangent of a number. Return value is in radians in the
 634     /// range [-pi/2, pi/2];
 635     ///
 636     /// # Examples
 637     ///
 638     /// ```
 639     /// let f = 1.0_f64;
 640     ///
 641     /// // atan(tan(1))
 642     /// let abs_difference = (f.tan().atan() - 1.0).abs();
 643     ///
 644     /// assert!(abs_difference < 1e-10);
 645     /// ```
 646     #[stable(feature = "rust1", since = "1.0.0")]
 647     #[inline]
 648     pub fn atan(self) -> f64 {
 649         unsafe { cmath::atan(self) }
 650     }
 651
 652     /// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`) in radians.
 653     ///
 654     /// * `x = 0`, `y = 0`: `0`
 655     /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
 656     /// * `y >= 0`: `arctan(y/x) + pi` -> `(pi/2, pi]`
 657     /// * `y < 0`: `arctan(y/x) - pi` -> `(-pi, -pi/2)`
 658     ///
 659     /// # Examples
 660     ///
 661     /// ```
 662     /// use std::f64;
 663     ///
 664     /// // Positive angles measured counter-clockwise
 665     /// // from positive x axis
 666     /// // -pi/4 radians (45 deg clockwise)
 667     /// let x1 = 3.0_f64;
 668     /// let y1 = -3.0_f64;
 669     ///
 670     /// // 3pi/4 radians (135 deg counter-clockwise)
 671     /// let x2 = -3.0_f64;
 672     /// let y2 = 3.0_f64;
 673     ///
 674     /// let abs_difference_1 = (y1.atan2(x1) - (-f64::consts::FRAC_PI_4)).abs();
 675     /// let abs_difference_2 = (y2.atan2(x2) - (3.0 * f64::consts::FRAC_PI_4)).abs();
 676     ///
 677     /// assert!(abs_difference_1 < 1e-10);
 678     /// assert!(abs_difference_2 < 1e-10);
 679     /// ```
 680     #[stable(feature = "rust1", since = "1.0.0")]
 681     #[inline]
 682     pub fn atan2(self, other: f64) -> f64 {
 683         unsafe { cmath::atan2(self, other) }
 684     }
 685
 686     /// Simultaneously computes the sine and cosine of the number, `x`. Returns
 687     /// `(sin(x), cos(x))`.
 688     ///
 689     /// # Examples
 690     ///
 691     /// ```
 692     /// use std::f64;
 693     ///
 694     /// let x = f64::consts::FRAC_PI_4;
 695     /// let f = x.sin_cos();
 696     ///
 697     /// let abs_difference_0 = (f.0 - x.sin()).abs();
 698     /// let abs_difference_1 = (f.1 - x.cos()).abs();
 699     ///
 700     /// assert!(abs_difference_0 < 1e-10);
 701     /// assert!(abs_difference_1 < 1e-10);
 702     /// ```
 703     #[stable(feature = "rust1", since = "1.0.0")]
 704     #[inline]
 705     pub fn sin_cos(self) -> (f64, f64) {
 706         (self.sin(), self.cos())
 707     }
 708
 709     /// Returns `e^(self) - 1` in a way that is accurate even if the
 710     /// number is close to zero.
 711     ///
 712     /// # Examples
 713     ///
 714     /// ```
 715     /// let x = 7.0_f64;
 716     ///
 717     /// // e^(ln(7)) - 1
 718     /// let abs_difference = (x.ln().exp_m1() - 6.0).abs();
 719     ///
 720     /// assert!(abs_difference < 1e-10);
 721     /// ```
 722     #[stable(feature = "rust1", since = "1.0.0")]
 723     #[inline]
 724     pub fn exp_m1(self) -> f64 {
 725         unsafe { cmath::expm1(self) }
 726     }
 727
 728     /// Returns `ln(1+n)` (natural logarithm) more accurately than if
 729     /// the operations were performed separately.
 730     ///
 731     /// # Examples
 732     ///
 733     /// ```
 734     /// use std::f64;
 735     ///
 736     /// let x = f64::consts::E - 1.0;
 737     ///
 738     /// // ln(1 + (e - 1)) == ln(e) == 1
 739     /// let abs_difference = (x.ln_1p() - 1.0).abs();
 740     ///
 741     /// assert!(abs_difference < 1e-10);
 742     /// ```
 743     #[stable(feature = "rust1", since = "1.0.0")]
 744     #[inline]
 745     pub fn ln_1p(self) -> f64 {
 746         unsafe { cmath::log1p(self) }
 747     }
 748
 749     /// Hyperbolic sine function.
 750     ///
 751     /// # Examples
 752     ///
 753     /// ```
 754     /// use std::f64;
 755     ///
 756     /// let e = f64::consts::E;
 757     /// let x = 1.0_f64;
 758     ///
 759     /// let f = x.sinh();
 760     /// // Solving sinh() at 1 gives `(e^2-1)/(2e)`
 761     /// let g = ((e * e) - 1.0) / (2.0 * e);
 762     /// let abs_difference = (f - g).abs();
 763     ///
 764     /// assert!(abs_difference < 1e-10);
 765     /// ```
 766     #[stable(feature = "rust1", since = "1.0.0")]
 767     #[inline]
 768     pub fn sinh(self) -> f64 {
 769         unsafe { cmath::sinh(self) }
 770     }
 771
 772     /// Hyperbolic cosine function.
 773     ///
 774     /// # Examples
 775     ///
 776     /// ```
 777     /// use std::f64;
 778     ///
 779     /// let e = f64::consts::E;
 780     /// let x = 1.0_f64;
 781     /// let f = x.cosh();
 782     /// // Solving cosh() at 1 gives this result
 783     /// let g = ((e * e) + 1.0) / (2.0 * e);
 784     /// let abs_difference = (f - g).abs();
 785     ///
 786     /// // Same result
 787     /// assert!(abs_difference < 1.0e-10);
 788     /// ```
 789     #[stable(feature = "rust1", since = "1.0.0")]
 790     #[inline]
 791     pub fn cosh(self) -> f64 {
 792         unsafe { cmath::cosh(self) }
 793     }
 794
 795     /// Hyperbolic tangent function.
 796     ///
 797     /// # Examples
 798     ///
 799     /// ```
 800     /// use std::f64;
 801     ///
 802     /// let e = f64::consts::E;
 803     /// let x = 1.0_f64;
 804     ///
 805     /// let f = x.tanh();
 806     /// // Solving tanh() at 1 gives `(1 - e^(-2))/(1 + e^(-2))`
 807     /// let g = (1.0 - e.powi(-2)) / (1.0 + e.powi(-2));
 808     /// let abs_difference = (f - g).abs();
 809     ///
 810     /// assert!(abs_difference < 1.0e-10);
 811     /// ```
 812     #[stable(feature = "rust1", since = "1.0.0")]
 813     #[inline]
 814     pub fn tanh(self) -> f64 {
 815         unsafe { cmath::tanh(self) }
 816     }
 817
 818     /// Inverse hyperbolic sine function.
 819     ///
 820     /// # Examples
 821     ///
 822     /// ```
 823     /// let x = 1.0_f64;
 824     /// let f = x.sinh().asinh();
 825     ///
 826     /// let abs_difference = (f - x).abs();
 827     ///
 828     /// assert!(abs_difference < 1.0e-10);
 829     /// ```
 830     #[stable(feature = "rust1", since = "1.0.0")]
 831     #[inline]
 832     pub fn asinh(self) -> f64 {
 833         if self == NEG_INFINITY {
 834             NEG_INFINITY
 835         } else {
 836             (self + ((self * self) + 1.0).sqrt()).ln().copysign(self)
 837         }
 838     }
 839
 840     /// Inverse hyperbolic cosine function.
 841     ///
 842     /// # Examples
 843     ///
 844     /// ```
 845     /// let x = 1.0_f64;
 846     /// let f = x.cosh().acosh();
 847     ///
 848     /// let abs_difference = (f - x).abs();
 849     ///
 850     /// assert!(abs_difference < 1.0e-10);
 851     /// ```
 852     #[stable(feature = "rust1", since = "1.0.0")]
 853     #[inline]
 854     pub fn acosh(self) -> f64 {
 855         if self < 1.0 {
 856             NAN
 857         } else {
 858             (self + ((self * self) - 1.0).sqrt()).ln()
 859         }
 860     }
 861
 862     /// Inverse hyperbolic tangent function.
 863     ///
 864     /// # Examples
 865     ///
 866     /// ```
 867     /// use std::f64;
 868     ///
 869     /// let e = f64::consts::E;
 870     /// let f = e.tanh().atanh();
 871     ///
 872     /// let abs_difference = (f - e).abs();
 873     ///
 874     /// assert!(abs_difference < 1.0e-10);
 875     /// ```
 876     #[stable(feature = "rust1", since = "1.0.0")]
 877     #[inline]
 878     pub fn atanh(self) -> f64 {
 879         0.5 * ((2.0 * self) / (1.0 - self)).ln_1p()
 880     }
 881
 882     /// Restrict a value to a certain interval unless it is NaN.
 883     ///
 884     /// Returns `max` if `self` is greater than `max`, and `min` if `self` is
 885     /// less than `min`. Otherwise this returns `self`.
 886     ///
 887     /// Not that this function returns NaN if the initial value was NaN as
 888     /// well.
 889     ///
 890     /// # Panics
 891     ///
 892     /// Panics if `min > max`, `min` is NaN, or `max` is NaN.
 893     ///
 894     /// # Examples
 895     ///
 896     /// ```
 897     /// #![feature(clamp)]
 898     /// assert!((-3.0f64).clamp(-2.0, 1.0) == -2.0);
 899     /// assert!((0.0f64).clamp(-2.0, 1.0) == 0.0);
 900     /// assert!((2.0f64).clamp(-2.0, 1.0) == 1.0);
 901     /// assert!((std::f64::NAN).clamp(-2.0, 1.0).is_nan());
 902     /// ```
 903     #[unstable(feature = "clamp", issue = "44095")]
 904     #[inline]
 905     pub fn clamp(self, min: f64, max: f64) -> f64 {
 906         assert!(min <= max);
 907         let mut x = self;
 908         if x < min { x = min; }
 909         if x > max { x = max; }
 910         x
 911     }
 912
 913     // Solaris/Illumos requires a wrapper around log, log2, and log10 functions
 914     // because of their non-standard behavior (e.g., log(-n) returns -Inf instead
 915     // of expected NaN).
 916     fn log_wrapper<F: Fn(f64) -> f64>(self, log_fn: F) -> f64 {
 917         if !cfg!(target_os = "solaris") {
 918             log_fn(self)
 919         } else {
 920             if self.is_finite() {
 921                 if self > 0.0 {
 922                     log_fn(self)
 923                 } else if self == 0.0 {
 924                     NEG_INFINITY // log(0) = -Inf
 925                 } else {
 926                     NAN // log(-n) = NaN
 927                 }
 928             } else if self.is_nan() {
 929                 self // log(NaN) = NaN
 930             } else if self > 0.0 {
 931                 self // log(Inf) = Inf
 932             } else {
 933                 NAN // log(-Inf) = NaN
 934             }
 935         }
 936     }
 937 }
 938
 939 #[cfg(test)]
 940 mod tests {
 941     use crate::f64;
 942     use crate::f64::*;
 943     use crate::num::*;
 944     use crate::num::FpCategory as Fp;
 945
 946     #[test]
 947     fn test_num_f64() {
 948         test_num(10f64, 2f64);
 949     }
 950
 951     #[test]
 952     fn test_min_nan() {
 953         assert_eq!(NAN.min(2.0), 2.0);
 954         assert_eq!(2.0f64.min(NAN), 2.0);
 955     }
 956
 957     #[test]
 958     fn test_max_nan() {
 959         assert_eq!(NAN.max(2.0), 2.0);
 960         assert_eq!(2.0f64.max(NAN), 2.0);
 961     }
 962
 963     #[test]
 964     fn test_nan() {
 965         let nan: f64 = NAN;
 966         assert!(nan.is_nan());
 967         assert!(!nan.is_infinite());
 968         assert!(!nan.is_finite());
 969         assert!(!nan.is_normal());
 970         assert!(nan.is_sign_positive());
 971         assert!(!nan.is_sign_negative());
 972         assert_eq!(Fp::Nan, nan.classify());
 973     }
 974
 975     #[test]
 976     fn test_infinity() {
 977         let inf: f64 = INFINITY;
 978         assert!(inf.is_infinite());
 979         assert!(!inf.is_finite());
 980         assert!(inf.is_sign_positive());
 981         assert!(!inf.is_sign_negative());
 982         assert!(!inf.is_nan());
 983         assert!(!inf.is_normal());
 984         assert_eq!(Fp::Infinite, inf.classify());
 985     }
 986
 987     #[test]
 988     fn test_neg_infinity() {
 989         let neg_inf: f64 = NEG_INFINITY;
 990         assert!(neg_inf.is_infinite());
 991         assert!(!neg_inf.is_finite());
 992         assert!(!neg_inf.is_sign_positive());
 993         assert!(neg_inf.is_sign_negative());
 994         assert!(!neg_inf.is_nan());
 995         assert!(!neg_inf.is_normal());
 996         assert_eq!(Fp::Infinite, neg_inf.classify());
 997     }
 998
 999     #[test]
1000     fn test_zero() {
1001         let zero: f64 = 0.0f64;
1002         assert_eq!(0.0, zero);
1003         assert!(!zero.is_infinite());
1004         assert!(zero.is_finite());
1005         assert!(zero.is_sign_positive());
1006         assert!(!zero.is_sign_negative());
1007         assert!(!zero.is_nan());
1008         assert!(!zero.is_normal());
1009         assert_eq!(Fp::Zero, zero.classify());
1010     }
1011
1012     #[test]
1013     fn test_neg_zero() {
1014         let neg_zero: f64 = -0.0;
1015         assert_eq!(0.0, neg_zero);
1016         assert!(!neg_zero.is_infinite());
1017         assert!(neg_zero.is_finite());
1018         assert!(!neg_zero.is_sign_positive());
1019         assert!(neg_zero.is_sign_negative());
1020         assert!(!neg_zero.is_nan());
1021         assert!(!neg_zero.is_normal());
1022         assert_eq!(Fp::Zero, neg_zero.classify());
1023     }
1024
1025     #[cfg_attr(all(target_arch = "wasm32", target_os = "emscripten"), ignore)] // issue 42630
1026     #[test]
1027     fn test_one() {
1028         let one: f64 = 1.0f64;
1029         assert_eq!(1.0, one);
1030         assert!(!one.is_infinite());
1031         assert!(one.is_finite());
1032         assert!(one.is_sign_positive());
1033         assert!(!one.is_sign_negative());
1034         assert!(!one.is_nan());
1035         assert!(one.is_normal());
1036         assert_eq!(Fp::Normal, one.classify());
1037     }
1038
1039     #[test]
1040     fn test_is_nan() {
1041         let nan: f64 = NAN;
1042         let inf: f64 = INFINITY;
1043         let neg_inf: f64 = NEG_INFINITY;
1044         assert!(nan.is_nan());
1045         assert!(!0.0f64.is_nan());
1046         assert!(!5.3f64.is_nan());
1047         assert!(!(-10.732f64).is_nan());
1048         assert!(!inf.is_nan());
1049         assert!(!neg_inf.is_nan());
1050     }
1051
1052     #[test]
1053     fn test_is_infinite() {
1054         let nan: f64 = NAN;
1055         let inf: f64 = INFINITY;
1056         let neg_inf: f64 = NEG_INFINITY;
1057         assert!(!nan.is_infinite());
1058         assert!(inf.is_infinite());
1059         assert!(neg_inf.is_infinite());
1060         assert!(!0.0f64.is_infinite());
1061         assert!(!42.8f64.is_infinite());
1062         assert!(!(-109.2f64).is_infinite());
1063     }
1064
1065     #[test]
1066     fn test_is_finite() {
1067         let nan: f64 = NAN;
1068         let inf: f64 = INFINITY;
1069         let neg_inf: f64 = NEG_INFINITY;
1070         assert!(!nan.is_finite());
1071         assert!(!inf.is_finite());
1072         assert!(!neg_inf.is_finite());
1073         assert!(0.0f64.is_finite());
1074         assert!(42.8f64.is_finite());
1075         assert!((-109.2f64).is_finite());
1076     }
1077
1078     #[cfg_attr(all(target_arch = "wasm32", target_os = "emscripten"), ignore)] // issue 42630
1079     #[test]
1080     fn test_is_normal() {
1081         let nan: f64 = NAN;
1082         let inf: f64 = INFINITY;
1083         let neg_inf: f64 = NEG_INFINITY;
1084         let zero: f64 = 0.0f64;
1085         let neg_zero: f64 = -0.0;
1086         assert!(!nan.is_normal());
1087         assert!(!inf.is_normal());
1088         assert!(!neg_inf.is_normal());
1089         assert!(!zero.is_normal());
1090         assert!(!neg_zero.is_normal());
1091         assert!(1f64.is_normal());
1092         assert!(1e-307f64.is_normal());
1093         assert!(!1e-308f64.is_normal());
1094     }
1095
1096     #[cfg_attr(all(target_arch = "wasm32", target_os = "emscripten"), ignore)] // issue 42630
1097     #[test]
1098     fn test_classify() {
1099         let nan: f64 = NAN;
1100         let inf: f64 = INFINITY;
1101         let neg_inf: f64 = NEG_INFINITY;
1102         let zero: f64 = 0.0f64;
1103         let neg_zero: f64 = -0.0;
1104         assert_eq!(nan.classify(), Fp::Nan);
1105         assert_eq!(inf.classify(), Fp::Infinite);
1106         assert_eq!(neg_inf.classify(), Fp::Infinite);
1107         assert_eq!(zero.classify(), Fp::Zero);
1108         assert_eq!(neg_zero.classify(), Fp::Zero);
1109         assert_eq!(1e-307f64.classify(), Fp::Normal);
1110         assert_eq!(1e-308f64.classify(), Fp::Subnormal);
1111     }
1112
1113     #[test]
1114     fn test_floor() {
1115         assert_approx_eq!(1.0f64.floor(), 1.0f64);
1116         assert_approx_eq!(1.3f64.floor(), 1.0f64);
1117         assert_approx_eq!(1.5f64.floor(), 1.0f64);
1118         assert_approx_eq!(1.7f64.floor(), 1.0f64);
1119         assert_approx_eq!(0.0f64.floor(), 0.0f64);
1120         assert_approx_eq!((-0.0f64).floor(), -0.0f64);
1121         assert_approx_eq!((-1.0f64).floor(), -1.0f64);
1122         assert_approx_eq!((-1.3f64).floor(), -2.0f64);
1123         assert_approx_eq!((-1.5f64).floor(), -2.0f64);
1124         assert_approx_eq!((-1.7f64).floor(), -2.0f64);
1125     }
1126
1127     #[test]
1128     fn test_ceil() {
1129         assert_approx_eq!(1.0f64.ceil(), 1.0f64);
1130         assert_approx_eq!(1.3f64.ceil(), 2.0f64);
1131         assert_approx_eq!(1.5f64.ceil(), 2.0f64);
1132         assert_approx_eq!(1.7f64.ceil(), 2.0f64);
1133         assert_approx_eq!(0.0f64.ceil(), 0.0f64);
1134         assert_approx_eq!((-0.0f64).ceil(), -0.0f64);
1135         assert_approx_eq!((-1.0f64).ceil(), -1.0f64);
1136         assert_approx_eq!((-1.3f64).ceil(), -1.0f64);
1137         assert_approx_eq!((-1.5f64).ceil(), -1.0f64);
1138         assert_approx_eq!((-1.7f64).ceil(), -1.0f64);
1139     }
1140
1141     #[test]
1142     fn test_round() {
1143         assert_approx_eq!(1.0f64.round(), 1.0f64);
1144         assert_approx_eq!(1.3f64.round(), 1.0f64);
1145         assert_approx_eq!(1.5f64.round(), 2.0f64);
1146         assert_approx_eq!(1.7f64.round(), 2.0f64);
1147         assert_approx_eq!(0.0f64.round(), 0.0f64);
1148         assert_approx_eq!((-0.0f64).round(), -0.0f64);
1149         assert_approx_eq!((-1.0f64).round(), -1.0f64);
1150         assert_approx_eq!((-1.3f64).round(), -1.0f64);
1151         assert_approx_eq!((-1.5f64).round(), -2.0f64);
1152         assert_approx_eq!((-1.7f64).round(), -2.0f64);
1153     }
1154
1155     #[test]
1156     fn test_trunc() {
1157         assert_approx_eq!(1.0f64.trunc(), 1.0f64);
1158         assert_approx_eq!(1.3f64.trunc(), 1.0f64);
1159         assert_approx_eq!(1.5f64.trunc(), 1.0f64);
1160         assert_approx_eq!(1.7f64.trunc(), 1.0f64);
1161         assert_approx_eq!(0.0f64.trunc(), 0.0f64);
1162         assert_approx_eq!((-0.0f64).trunc(), -0.0f64);
1163         assert_approx_eq!((-1.0f64).trunc(), -1.0f64);
1164         assert_approx_eq!((-1.3f64).trunc(), -1.0f64);
1165         assert_approx_eq!((-1.5f64).trunc(), -1.0f64);
1166         assert_approx_eq!((-1.7f64).trunc(), -1.0f64);
1167     }
1168
1169     #[test]
1170     fn test_fract() {
1171         assert_approx_eq!(1.0f64.fract(), 0.0f64);
1172         assert_approx_eq!(1.3f64.fract(), 0.3f64);
1173         assert_approx_eq!(1.5f64.fract(), 0.5f64);
1174         assert_approx_eq!(1.7f64.fract(), 0.7f64);
1175         assert_approx_eq!(0.0f64.fract(), 0.0f64);
1176         assert_approx_eq!((-0.0f64).fract(), -0.0f64);
1177         assert_approx_eq!((-1.0f64).fract(), -0.0f64);
1178         assert_approx_eq!((-1.3f64).fract(), -0.3f64);
1179         assert_approx_eq!((-1.5f64).fract(), -0.5f64);
1180         assert_approx_eq!((-1.7f64).fract(), -0.7f64);
1181     }
1182
1183     #[test]
1184     fn test_abs() {
1185         assert_eq!(INFINITY.abs(), INFINITY);
1186         assert_eq!(1f64.abs(), 1f64);
1187         assert_eq!(0f64.abs(), 0f64);
1188         assert_eq!((-0f64).abs(), 0f64);
1189         assert_eq!((-1f64).abs(), 1f64);
1190         assert_eq!(NEG_INFINITY.abs(), INFINITY);
1191         assert_eq!((1f64 / NEG_INFINITY).abs(), 0f64);
1192         assert!(NAN.abs().is_nan());
1193     }
1194
1195     #[test]
1196     fn test_signum() {
1197         assert_eq!(INFINITY.signum(), 1f64);
1198         assert_eq!(1f64.signum(), 1f64);
1199         assert_eq!(0f64.signum(), 1f64);
1200         assert_eq!((-0f64).signum(), -1f64);
1201         assert_eq!((-1f64).signum(), -1f64);
1202         assert_eq!(NEG_INFINITY.signum(), -1f64);
1203         assert_eq!((1f64 / NEG_INFINITY).signum(), -1f64);
1204         assert!(NAN.signum().is_nan());
1205     }
1206
1207     #[test]
1208     fn test_is_sign_positive() {
1209         assert!(INFINITY.is_sign_positive());
1210         assert!(1f64.is_sign_positive());
1211         assert!(0f64.is_sign_positive());
1212         assert!(!(-0f64).is_sign_positive());
1213         assert!(!(-1f64).is_sign_positive());
1214         assert!(!NEG_INFINITY.is_sign_positive());
1215         assert!(!(1f64 / NEG_INFINITY).is_sign_positive());
1216         assert!(NAN.is_sign_positive());
1217         assert!(!(-NAN).is_sign_positive());
1218     }
1219
1220     #[test]
1221     fn test_is_sign_negative() {
1222         assert!(!INFINITY.is_sign_negative());
1223         assert!(!1f64.is_sign_negative());
1224         assert!(!0f64.is_sign_negative());
1225         assert!((-0f64).is_sign_negative());
1226         assert!((-1f64).is_sign_negative());
1227         assert!(NEG_INFINITY.is_sign_negative());
1228         assert!((1f64 / NEG_INFINITY).is_sign_negative());
1229         assert!(!NAN.is_sign_negative());
1230         assert!((-NAN).is_sign_negative());
1231     }
1232
1233     #[test]
1234     fn test_mul_add() {
1235         let nan: f64 = NAN;
1236         let inf: f64 = INFINITY;
1237         let neg_inf: f64 = NEG_INFINITY;
1238         assert_approx_eq!(12.3f64.mul_add(4.5, 6.7), 62.05);
1239         assert_approx_eq!((-12.3f64).mul_add(-4.5, -6.7), 48.65);
1240         assert_approx_eq!(0.0f64.mul_add(8.9, 1.2), 1.2);
1241         assert_approx_eq!(3.4f64.mul_add(-0.0, 5.6), 5.6);
1242         assert!(nan.mul_add(7.8, 9.0).is_nan());
1243         assert_eq!(inf.mul_add(7.8, 9.0), inf);
1244         assert_eq!(neg_inf.mul_add(7.8, 9.0), neg_inf);
1245         assert_eq!(8.9f64.mul_add(inf, 3.2), inf);
1246         assert_eq!((-3.2f64).mul_add(2.4, neg_inf), neg_inf);
1247     }
1248
1249     #[test]
1250     fn test_recip() {
1251         let nan: f64 = NAN;
1252         let inf: f64 = INFINITY;
1253         let neg_inf: f64 = NEG_INFINITY;
1254         assert_eq!(1.0f64.recip(), 1.0);
1255         assert_eq!(2.0f64.recip(), 0.5);
1256         assert_eq!((-0.4f64).recip(), -2.5);
1257         assert_eq!(0.0f64.recip(), inf);
1258         assert!(nan.recip().is_nan());
1259         assert_eq!(inf.recip(), 0.0);
1260         assert_eq!(neg_inf.recip(), 0.0);
1261     }
1262
1263     #[test]
1264     fn test_powi() {
1265         let nan: f64 = NAN;
1266         let inf: f64 = INFINITY;
1267         let neg_inf: f64 = NEG_INFINITY;
1268         assert_eq!(1.0f64.powi(1), 1.0);
1269         assert_approx_eq!((-3.1f64).powi(2), 9.61);
1270         assert_approx_eq!(5.9f64.powi(-2), 0.028727);
1271         assert_eq!(8.3f64.powi(0), 1.0);
1272         assert!(nan.powi(2).is_nan());
1273         assert_eq!(inf.powi(3), inf);
1274         assert_eq!(neg_inf.powi(2), inf);
1275     }
1276
1277     #[test]
1278     fn test_powf() {
1279         let nan: f64 = NAN;
1280         let inf: f64 = INFINITY;
1281         let neg_inf: f64 = NEG_INFINITY;
1282         assert_eq!(1.0f64.powf(1.0), 1.0);
1283         assert_approx_eq!(3.4f64.powf(4.5), 246.408183);
1284         assert_approx_eq!(2.7f64.powf(-3.2), 0.041652);
1285         assert_approx_eq!((-3.1f64).powf(2.0), 9.61);
1286         assert_approx_eq!(5.9f64.powf(-2.0), 0.028727);
1287         assert_eq!(8.3f64.powf(0.0), 1.0);
1288         assert!(nan.powf(2.0).is_nan());
1289         assert_eq!(inf.powf(2.0), inf);
1290         assert_eq!(neg_inf.powf(3.0), neg_inf);
1291     }
1292
1293     #[test]
1294     fn test_sqrt_domain() {
1295         assert!(NAN.sqrt().is_nan());
1296         assert!(NEG_INFINITY.sqrt().is_nan());
1297         assert!((-1.0f64).sqrt().is_nan());
1298         assert_eq!((-0.0f64).sqrt(), -0.0);
1299         assert_eq!(0.0f64.sqrt(), 0.0);
1300         assert_eq!(1.0f64.sqrt(), 1.0);
1301         assert_eq!(INFINITY.sqrt(), INFINITY);
1302     }
1303
1304     #[test]
1305     fn test_exp() {
1306         assert_eq!(1.0, 0.0f64.exp());
1307         assert_approx_eq!(2.718282, 1.0f64.exp());
1308         assert_approx_eq!(148.413159, 5.0f64.exp());
1309
1310         let inf: f64 = INFINITY;
1311         let neg_inf: f64 = NEG_INFINITY;
1312         let nan: f64 = NAN;
1313         assert_eq!(inf, inf.exp());
1314         assert_eq!(0.0, neg_inf.exp());
1315         assert!(nan.exp().is_nan());
1316     }
1317
1318     #[test]
1319     fn test_exp2() {
1320         assert_eq!(32.0, 5.0f64.exp2());
1321         assert_eq!(1.0, 0.0f64.exp2());
1322
1323         let inf: f64 = INFINITY;
1324         let neg_inf: f64 = NEG_INFINITY;
1325         let nan: f64 = NAN;
1326         assert_eq!(inf, inf.exp2());
1327         assert_eq!(0.0, neg_inf.exp2());
1328         assert!(nan.exp2().is_nan());
1329     }
1330
1331     #[test]
1332     fn test_ln() {
1333         let nan: f64 = NAN;
1334         let inf: f64 = INFINITY;
1335         let neg_inf: f64 = NEG_INFINITY;
1336         assert_approx_eq!(1.0f64.exp().ln(), 1.0);
1337         assert!(nan.ln().is_nan());
1338         assert_eq!(inf.ln(), inf);
1339         assert!(neg_inf.ln().is_nan());
1340         assert!((-2.3f64).ln().is_nan());
1341         assert_eq!((-0.0f64).ln(), neg_inf);
1342         assert_eq!(0.0f64.ln(), neg_inf);
1343         assert_approx_eq!(4.0f64.ln(), 1.386294);
1344     }
1345
1346     #[test]
1347     fn test_log() {
1348         let nan: f64 = NAN;
1349         let inf: f64 = INFINITY;
1350         let neg_inf: f64 = NEG_INFINITY;
1351         assert_eq!(10.0f64.log(10.0), 1.0);
1352         assert_approx_eq!(2.3f64.log(3.5), 0.664858);
1353         assert_eq!(1.0f64.exp().log(1.0f64.exp()), 1.0);
1354         assert!(1.0f64.log(1.0).is_nan());
1355         assert!(1.0f64.log(-13.9).is_nan());
1356         assert!(nan.log(2.3).is_nan());
1357         assert_eq!(inf.log(10.0), inf);
1358         assert!(neg_inf.log(8.8).is_nan());
1359         assert!((-2.3f64).log(0.1).is_nan());
1360         assert_eq!((-0.0f64).log(2.0), neg_inf);
1361         assert_eq!(0.0f64.log(7.0), neg_inf);
1362     }
1363
1364     #[test]
1365     fn test_log2() {
1366         let nan: f64 = NAN;
1367         let inf: f64 = INFINITY;
1368         let neg_inf: f64 = NEG_INFINITY;
1369         assert_approx_eq!(10.0f64.log2(), 3.321928);
1370         assert_approx_eq!(2.3f64.log2(), 1.201634);
1371         assert_approx_eq!(1.0f64.exp().log2(), 1.442695);
1372         assert!(nan.log2().is_nan());
1373         assert_eq!(inf.log2(), inf);
1374         assert!(neg_inf.log2().is_nan());
1375         assert!((-2.3f64).log2().is_nan());
1376         assert_eq!((-0.0f64).log2(), neg_inf);
1377         assert_eq!(0.0f64.log2(), neg_inf);
1378     }
1379
1380     #[test]
1381     fn test_log10() {
1382         let nan: f64 = NAN;
1383         let inf: f64 = INFINITY;
1384         let neg_inf: f64 = NEG_INFINITY;
1385         assert_eq!(10.0f64.log10(), 1.0);
1386         assert_approx_eq!(2.3f64.log10(), 0.361728);
1387         assert_approx_eq!(1.0f64.exp().log10(), 0.434294);
1388         assert_eq!(1.0f64.log10(), 0.0);
1389         assert!(nan.log10().is_nan());
1390         assert_eq!(inf.log10(), inf);
1391         assert!(neg_inf.log10().is_nan());
1392         assert!((-2.3f64).log10().is_nan());
1393         assert_eq!((-0.0f64).log10(), neg_inf);
1394         assert_eq!(0.0f64.log10(), neg_inf);
1395     }
1396
1397     #[test]
1398     fn test_to_degrees() {
1399         let pi: f64 = consts::PI;
1400         let nan: f64 = NAN;
1401         let inf: f64 = INFINITY;
1402         let neg_inf: f64 = NEG_INFINITY;
1403         assert_eq!(0.0f64.to_degrees(), 0.0);
1404         assert_approx_eq!((-5.8f64).to_degrees(), -332.315521);
1405         assert_eq!(pi.to_degrees(), 180.0);
1406         assert!(nan.to_degrees().is_nan());
1407         assert_eq!(inf.to_degrees(), inf);
1408         assert_eq!(neg_inf.to_degrees(), neg_inf);
1409     }
1410
1411     #[test]
1412     fn test_to_radians() {
1413         let pi: f64 = consts::PI;
1414         let nan: f64 = NAN;
1415         let inf: f64 = INFINITY;
1416         let neg_inf: f64 = NEG_INFINITY;
1417         assert_eq!(0.0f64.to_radians(), 0.0);
1418         assert_approx_eq!(154.6f64.to_radians(), 2.698279);
1419         assert_approx_eq!((-332.31f64).to_radians(), -5.799903);
1420         assert_eq!(180.0f64.to_radians(), pi);
1421         assert!(nan.to_radians().is_nan());
1422         assert_eq!(inf.to_radians(), inf);
1423         assert_eq!(neg_inf.to_radians(), neg_inf);
1424     }
1425
1426     #[test]
1427     fn test_asinh() {
1428         assert_eq!(0.0f64.asinh(), 0.0f64);
1429         assert_eq!((-0.0f64).asinh(), -0.0f64);
1430
1431         let inf: f64 = INFINITY;
1432         let neg_inf: f64 = NEG_INFINITY;
1433         let nan: f64 = NAN;
1434         assert_eq!(inf.asinh(), inf);
1435         assert_eq!(neg_inf.asinh(), neg_inf);
1436         assert!(nan.asinh().is_nan());
1437         assert!((-0.0f64).asinh().is_sign_negative());
1438         // issue 63271
1439         assert_approx_eq!(2.0f64.asinh(), 1.443635475178810342493276740273105f64);
1440         assert_approx_eq!((-2.0f64).asinh(), -1.443635475178810342493276740273105f64);
1441     }
1442
1443     #[test]
1444     fn test_acosh() {
1445         assert_eq!(1.0f64.acosh(), 0.0f64);
1446         assert!(0.999f64.acosh().is_nan());
1447
1448         let inf: f64 = INFINITY;
1449         let neg_inf: f64 = NEG_INFINITY;
1450         let nan: f64 = NAN;
1451         assert_eq!(inf.acosh(), inf);
1452         assert!(neg_inf.acosh().is_nan());
1453         assert!(nan.acosh().is_nan());
1454         assert_approx_eq!(2.0f64.acosh(), 1.31695789692481670862504634730796844f64);
1455         assert_approx_eq!(3.0f64.acosh(), 1.76274717403908605046521864995958461f64);
1456     }
1457
1458     #[test]
1459     fn test_atanh() {
1460         assert_eq!(0.0f64.atanh(), 0.0f64);
1461         assert_eq!((-0.0f64).atanh(), -0.0f64);
1462
1463         let inf: f64 = INFINITY;
1464         let neg_inf: f64 = NEG_INFINITY;
1465         let nan: f64 = NAN;
1466         assert_eq!(1.0f64.atanh(), inf);
1467         assert_eq!((-1.0f64).atanh(), neg_inf);
1468         assert!(2f64.atanh().atanh().is_nan());
1469         assert!((-2f64).atanh().atanh().is_nan());
1470         assert!(inf.atanh().is_nan());
1471         assert!(neg_inf.atanh().is_nan());
1472         assert!(nan.atanh().is_nan());
1473         assert_approx_eq!(0.5f64.atanh(), 0.54930614433405484569762261846126285f64);
1474         assert_approx_eq!((-0.5f64).atanh(), -0.54930614433405484569762261846126285f64);
1475     }
1476
1477     #[test]
1478     fn test_real_consts() {
1479         use super::consts;
1480         let pi: f64 = consts::PI;
1481         let frac_pi_2: f64 = consts::FRAC_PI_2;
1482         let frac_pi_3: f64 = consts::FRAC_PI_3;
1483         let frac_pi_4: f64 = consts::FRAC_PI_4;
1484         let frac_pi_6: f64 = consts::FRAC_PI_6;
1485         let frac_pi_8: f64 = consts::FRAC_PI_8;
1486         let frac_1_pi: f64 = consts::FRAC_1_PI;
1487         let frac_2_pi: f64 = consts::FRAC_2_PI;
1488         let frac_2_sqrtpi: f64 = consts::FRAC_2_SQRT_PI;
1489         let sqrt2: f64 = consts::SQRT_2;
1490         let frac_1_sqrt2: f64 = consts::FRAC_1_SQRT_2;
1491         let e: f64 = consts::E;
1492         let log2_e: f64 = consts::LOG2_E;
1493         let log10_e: f64 = consts::LOG10_E;
1494         let ln_2: f64 = consts::LN_2;
1495         let ln_10: f64 = consts::LN_10;
1496
1497         assert_approx_eq!(frac_pi_2, pi / 2f64);
1498         assert_approx_eq!(frac_pi_3, pi / 3f64);
1499         assert_approx_eq!(frac_pi_4, pi / 4f64);
1500         assert_approx_eq!(frac_pi_6, pi / 6f64);
1501         assert_approx_eq!(frac_pi_8, pi / 8f64);
1502         assert_approx_eq!(frac_1_pi, 1f64 / pi);
1503         assert_approx_eq!(frac_2_pi, 2f64 / pi);
1504         assert_approx_eq!(frac_2_sqrtpi, 2f64 / pi.sqrt());
1505         assert_approx_eq!(sqrt2, 2f64.sqrt());
1506         assert_approx_eq!(frac_1_sqrt2, 1f64 / 2f64.sqrt());
1507         assert_approx_eq!(log2_e, e.log2());
1508         assert_approx_eq!(log10_e, e.log10());
1509         assert_approx_eq!(ln_2, 2f64.ln());
1510         assert_approx_eq!(ln_10, 10f64.ln());
1511     }
1512
1513     #[test]
1514     fn test_float_bits_conv() {
1515         assert_eq!((1f64).to_bits(), 0x3ff0000000000000);
1516         assert_eq!((12.5f64).to_bits(), 0x4029000000000000);
1517         assert_eq!((1337f64).to_bits(), 0x4094e40000000000);
1518         assert_eq!((-14.25f64).to_bits(), 0xc02c800000000000);
1519         assert_approx_eq!(f64::from_bits(0x3ff0000000000000), 1.0);
1520         assert_approx_eq!(f64::from_bits(0x4029000000000000), 12.5);
1521         assert_approx_eq!(f64::from_bits(0x4094e40000000000), 1337.0);
1522         assert_approx_eq!(f64::from_bits(0xc02c800000000000), -14.25);
1523
1524         // Check that NaNs roundtrip their bits regardless of signalingness
1525         // 0xA is 0b1010; 0x5 is 0b0101 -- so these two together clobbers all the mantissa bits
1526         let masked_nan1 = f64::NAN.to_bits() ^ 0x000A_AAAA_AAAA_AAAA;
1527         let masked_nan2 = f64::NAN.to_bits() ^ 0x0005_5555_5555_5555;
1528         assert!(f64::from_bits(masked_nan1).is_nan());
1529         assert!(f64::from_bits(masked_nan2).is_nan());
1530
1531         assert_eq!(f64::from_bits(masked_nan1).to_bits(), masked_nan1);
1532         assert_eq!(f64::from_bits(masked_nan2).to_bits(), masked_nan2);
1533     }
1534
1535     #[test]
1536     #[should_panic]
1537     fn test_clamp_min_greater_than_max() {
1538         1.0f64.clamp(3.0, 1.0);
1539     }
1540
1541     #[test]
1542     #[should_panic]
1543     fn test_clamp_min_is_nan() {
1544         1.0f64.clamp(NAN, 1.0);
1545     }
1546
1547     #[test]
1548     #[should_panic]
1549     fn test_clamp_max_is_nan() {
1550         1.0f64.clamp(3.0, NAN);
1551     }
1552 }