src/libstd/f32.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! This module provides constants which are specific to the implementation
  12 //! of the `f32` floating point data type. Mathematically significant
  13 //! numbers are provided in the `consts` sub-module.
  14 //!
  15 //! *[See also the `f32` primitive type](../primitive.f32.html).*
  16
  17 #![stable(feature = "rust1", since = "1.0.0")]
  18 #![allow(missing_docs)]
  19
  20 #[cfg(not(test))]
  21 use core::num;
  22 #[cfg(not(test))]
  23 use intrinsics;
  24 #[cfg(not(test))]
  25 use num::FpCategory;
  26
  27
  28 #[stable(feature = "rust1", since = "1.0.0")]
  29 pub use core::f32::{RADIX, MANTISSA_DIGITS, DIGITS, EPSILON};
  30 #[stable(feature = "rust1", since = "1.0.0")]
  31 pub use core::f32::{MIN_EXP, MAX_EXP, MIN_10_EXP};
  32 #[stable(feature = "rust1", since = "1.0.0")]
  33 pub use core::f32::{MAX_10_EXP, NAN, INFINITY, NEG_INFINITY};
  34 #[stable(feature = "rust1", since = "1.0.0")]
  35 pub use core::f32::{MIN, MIN_POSITIVE, MAX};
  36 #[stable(feature = "rust1", since = "1.0.0")]
  37 pub use core::f32::consts;
  38
  39 #[allow(dead_code)]
  40 mod cmath {
  41     use libc::{c_float, c_int};
  42
  43     extern {
  44         pub fn cbrtf(n: c_float) -> c_float;
  45         pub fn erff(n: c_float) -> c_float;
  46         pub fn erfcf(n: c_float) -> c_float;
  47         pub fn expm1f(n: c_float) -> c_float;
  48         pub fn fdimf(a: c_float, b: c_float) -> c_float;
  49         pub fn fmaxf(a: c_float, b: c_float) -> c_float;
  50         pub fn fminf(a: c_float, b: c_float) -> c_float;
  51         pub fn fmodf(a: c_float, b: c_float) -> c_float;
  52         pub fn ilogbf(n: c_float) -> c_int;
  53         pub fn logbf(n: c_float) -> c_float;
  54         pub fn log1pf(n: c_float) -> c_float;
  55         pub fn modff(n: c_float, iptr: &mut c_float) -> c_float;
  56         pub fn nextafterf(x: c_float, y: c_float) -> c_float;
  57         pub fn tgammaf(n: c_float) -> c_float;
  58
  59         #[cfg_attr(all(windows, target_env = "msvc"), link_name = "__lgammaf_r")]
  60         pub fn lgammaf_r(n: c_float, sign: &mut c_int) -> c_float;
  61         #[cfg_attr(all(windows, target_env = "msvc"), link_name = "_hypotf")]
  62         pub fn hypotf(x: c_float, y: c_float) -> c_float;
  63     }
  64
  65     // See the comments in the `floor` function for why MSVC is special
  66     // here.
  67     #[cfg(not(target_env = "msvc"))]
  68     extern {
  69         pub fn acosf(n: c_float) -> c_float;
  70         pub fn asinf(n: c_float) -> c_float;
  71         pub fn atan2f(a: c_float, b: c_float) -> c_float;
  72         pub fn atanf(n: c_float) -> c_float;
  73         pub fn coshf(n: c_float) -> c_float;
  74         pub fn sinhf(n: c_float) -> c_float;
  75         pub fn tanf(n: c_float) -> c_float;
  76         pub fn tanhf(n: c_float) -> c_float;
  77     }
  78
  79     #[cfg(target_env = "msvc")]
  80     pub use self::shims::*;
  81     #[cfg(target_env = "msvc")]
  82     mod shims {
  83         use libc::c_float;
  84
  85         #[inline]
  86         pub unsafe fn acosf(n: c_float) -> c_float {
  87             f64::acos(n as f64) as c_float
  88         }
  89
  90         #[inline]
  91         pub unsafe fn asinf(n: c_float) -> c_float {
  92             f64::asin(n as f64) as c_float
  93         }
  94
  95         #[inline]
  96         pub unsafe fn atan2f(n: c_float, b: c_float) -> c_float {
  97             f64::atan2(n as f64, b as f64) as c_float
  98         }
  99
 100         #[inline]
 101         pub unsafe fn atanf(n: c_float) -> c_float {
 102             f64::atan(n as f64) as c_float
 103         }
 104
 105         #[inline]
 106         pub unsafe fn coshf(n: c_float) -> c_float {
 107             f64::cosh(n as f64) as c_float
 108         }
 109
 110         #[inline]
 111         pub unsafe fn sinhf(n: c_float) -> c_float {
 112             f64::sinh(n as f64) as c_float
 113         }
 114
 115         #[inline]
 116         pub unsafe fn tanf(n: c_float) -> c_float {
 117             f64::tan(n as f64) as c_float
 118         }
 119
 120         #[inline]
 121         pub unsafe fn tanhf(n: c_float) -> c_float {
 122             f64::tanh(n as f64) as c_float
 123         }
 124     }
 125 }
 126
 127 #[cfg(not(test))]
 128 #[lang = "f32"]
 129 impl f32 {
 130     /// Returns `true` if this value is `NaN` and false otherwise.
 131     ///
 132     /// ```
 133     /// use std::f32;
 134     ///
 135     /// let nan = f32::NAN;
 136     /// let f = 7.0_f32;
 137     ///
 138     /// assert!(nan.is_nan());
 139     /// assert!(!f.is_nan());
 140     /// ```
 141     #[stable(feature = "rust1", since = "1.0.0")]
 142     #[inline]
 143     pub fn is_nan(self) -> bool { num::Float::is_nan(self) }
 144
 145     /// Returns `true` if this value is positive infinity or negative infinity and
 146     /// false otherwise.
 147     ///
 148     /// ```
 149     /// use std::f32;
 150     ///
 151     /// let f = 7.0f32;
 152     /// let inf = f32::INFINITY;
 153     /// let neg_inf = f32::NEG_INFINITY;
 154     /// let nan = f32::NAN;
 155     ///
 156     /// assert!(!f.is_infinite());
 157     /// assert!(!nan.is_infinite());
 158     ///
 159     /// assert!(inf.is_infinite());
 160     /// assert!(neg_inf.is_infinite());
 161     /// ```
 162     #[stable(feature = "rust1", since = "1.0.0")]
 163     #[inline]
 164     pub fn is_infinite(self) -> bool { num::Float::is_infinite(self) }
 165
 166     /// Returns `true` if this number is neither infinite nor `NaN`.
 167     ///
 168     /// ```
 169     /// use std::f32;
 170     ///
 171     /// let f = 7.0f32;
 172     /// let inf = f32::INFINITY;
 173     /// let neg_inf = f32::NEG_INFINITY;
 174     /// let nan = f32::NAN;
 175     ///
 176     /// assert!(f.is_finite());
 177     ///
 178     /// assert!(!nan.is_finite());
 179     /// assert!(!inf.is_finite());
 180     /// assert!(!neg_inf.is_finite());
 181     /// ```
 182     #[stable(feature = "rust1", since = "1.0.0")]
 183     #[inline]
 184     pub fn is_finite(self) -> bool { num::Float::is_finite(self) }
 185
 186     /// Returns `true` if the number is neither zero, infinite,
 187     /// [subnormal][subnormal], or `NaN`.
 188     ///
 189     /// ```
 190     /// use std::f32;
 191     ///
 192     /// let min = f32::MIN_POSITIVE; // 1.17549435e-38f32
 193     /// let max = f32::MAX;
 194     /// let lower_than_min = 1.0e-40_f32;
 195     /// let zero = 0.0_f32;
 196     ///
 197     /// assert!(min.is_normal());
 198     /// assert!(max.is_normal());
 199     ///
 200     /// assert!(!zero.is_normal());
 201     /// assert!(!f32::NAN.is_normal());
 202     /// assert!(!f32::INFINITY.is_normal());
 203     /// // Values between `0` and `min` are Subnormal.
 204     /// assert!(!lower_than_min.is_normal());
 205     /// ```
 206     /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
 207     #[stable(feature = "rust1", since = "1.0.0")]
 208     #[inline]
 209     pub fn is_normal(self) -> bool { num::Float::is_normal(self) }
 210
 211     /// Returns the floating point category of the number. If only one property
 212     /// is going to be tested, it is generally faster to use the specific
 213     /// predicate instead.
 214     ///
 215     /// ```
 216     /// use std::num::FpCategory;
 217     /// use std::f32;
 218     ///
 219     /// let num = 12.4_f32;
 220     /// let inf = f32::INFINITY;
 221     ///
 222     /// assert_eq!(num.classify(), FpCategory::Normal);
 223     /// assert_eq!(inf.classify(), FpCategory::Infinite);
 224     /// ```
 225     #[stable(feature = "rust1", since = "1.0.0")]
 226     #[inline]
 227     pub fn classify(self) -> FpCategory { num::Float::classify(self) }
 228
 229     /// Returns the largest integer less than or equal to a number.
 230     ///
 231     /// ```
 232     /// let f = 3.99_f32;
 233     /// let g = 3.0_f32;
 234     ///
 235     /// assert_eq!(f.floor(), 3.0);
 236     /// assert_eq!(g.floor(), 3.0);
 237     /// ```
 238     #[stable(feature = "rust1", since = "1.0.0")]
 239     #[inline]
 240     pub fn floor(self) -> f32 {
 241         // On MSVC LLVM will lower many math intrinsics to a call to the
 242         // corresponding function. On MSVC, however, many of these functions
 243         // aren't actually available as symbols to call, but rather they are all
 244         // `static inline` functions in header files. This means that from a C
 245         // perspective it's "compatible", but not so much from an ABI
 246         // perspective (which we're worried about).
 247         //
 248         // The inline header functions always just cast to a f64 and do their
 249         // operation, so we do that here as well, but only for MSVC targets.
 250         //
 251         // Note that there are many MSVC-specific float operations which
 252         // redirect to this comment, so `floorf` is just one case of a missing
 253         // function on MSVC, but there are many others elsewhere.
 254         #[cfg(target_env = "msvc")]
 255         return (self as f64).floor() as f32;
 256         #[cfg(not(target_env = "msvc"))]
 257         return unsafe { intrinsics::floorf32(self) };
 258     }
 259
 260     /// Returns the smallest integer greater than or equal to a number.
 261     ///
 262     /// ```
 263     /// let f = 3.01_f32;
 264     /// let g = 4.0_f32;
 265     ///
 266     /// assert_eq!(f.ceil(), 4.0);
 267     /// assert_eq!(g.ceil(), 4.0);
 268     /// ```
 269     #[stable(feature = "rust1", since = "1.0.0")]
 270     #[inline]
 271     pub fn ceil(self) -> f32 {
 272         // see notes above in `floor`
 273         #[cfg(target_env = "msvc")]
 274         return (self as f64).ceil() as f32;
 275         #[cfg(not(target_env = "msvc"))]
 276         return unsafe { intrinsics::ceilf32(self) };
 277     }
 278
 279     /// Returns the nearest integer to a number. Round half-way cases away from
 280     /// `0.0`.
 281     ///
 282     /// ```
 283     /// let f = 3.3_f32;
 284     /// let g = -3.3_f32;
 285     ///
 286     /// assert_eq!(f.round(), 3.0);
 287     /// assert_eq!(g.round(), -3.0);
 288     /// ```
 289     #[stable(feature = "rust1", since = "1.0.0")]
 290     #[inline]
 291     pub fn round(self) -> f32 {
 292         unsafe { intrinsics::roundf32(self) }
 293     }
 294
 295     /// Returns the integer part of a number.
 296     ///
 297     /// ```
 298     /// let f = 3.3_f32;
 299     /// let g = -3.7_f32;
 300     ///
 301     /// assert_eq!(f.trunc(), 3.0);
 302     /// assert_eq!(g.trunc(), -3.0);
 303     /// ```
 304     #[stable(feature = "rust1", since = "1.0.0")]
 305     #[inline]
 306     pub fn trunc(self) -> f32 {
 307         unsafe { intrinsics::truncf32(self) }
 308     }
 309
 310     /// Returns the fractional part of a number.
 311     ///
 312     /// ```
 313     /// use std::f32;
 314     ///
 315     /// let x = 3.5_f32;
 316     /// let y = -3.5_f32;
 317     /// let abs_difference_x = (x.fract() - 0.5).abs();
 318     /// let abs_difference_y = (y.fract() - (-0.5)).abs();
 319     ///
 320     /// assert!(abs_difference_x <= f32::EPSILON);
 321     /// assert!(abs_difference_y <= f32::EPSILON);
 322     /// ```
 323     #[stable(feature = "rust1", since = "1.0.0")]
 324     #[inline]
 325     pub fn fract(self) -> f32 { self - self.trunc() }
 326
 327     /// Computes the absolute value of `self`. Returns `NAN` if the
 328     /// number is `NAN`.
 329     ///
 330     /// ```
 331     /// use std::f32;
 332     ///
 333     /// let x = 3.5_f32;
 334     /// let y = -3.5_f32;
 335     ///
 336     /// let abs_difference_x = (x.abs() - x).abs();
 337     /// let abs_difference_y = (y.abs() - (-y)).abs();
 338     ///
 339     /// assert!(abs_difference_x <= f32::EPSILON);
 340     /// assert!(abs_difference_y <= f32::EPSILON);
 341     ///
 342     /// assert!(f32::NAN.abs().is_nan());
 343     /// ```
 344     #[stable(feature = "rust1", since = "1.0.0")]
 345     #[inline]
 346     pub fn abs(self) -> f32 { num::Float::abs(self) }
 347
 348     /// Returns a number that represents the sign of `self`.
 349     ///
 350     /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
 351     /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
 352     /// - `NAN` if the number is `NAN`
 353     ///
 354     /// ```
 355     /// use std::f32;
 356     ///
 357     /// let f = 3.5_f32;
 358     ///
 359     /// assert_eq!(f.signum(), 1.0);
 360     /// assert_eq!(f32::NEG_INFINITY.signum(), -1.0);
 361     ///
 362     /// assert!(f32::NAN.signum().is_nan());
 363     /// ```
 364     #[stable(feature = "rust1", since = "1.0.0")]
 365     #[inline]
 366     pub fn signum(self) -> f32 { num::Float::signum(self) }
 367
 368     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 369     /// positive sign bit and positive infinity.
 370     ///
 371     /// ```
 372     /// let f = 7.0_f32;
 373     /// let g = -7.0_f32;
 374     ///
 375     /// assert!(f.is_sign_positive());
 376     /// assert!(!g.is_sign_positive());
 377     /// ```
 378     #[stable(feature = "rust1", since = "1.0.0")]
 379     #[inline]
 380     pub fn is_sign_positive(self) -> bool { num::Float::is_sign_positive(self) }
 381
 382     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 383     /// negative sign bit and negative infinity.
 384     ///
 385     /// ```
 386     /// let f = 7.0f32;
 387     /// let g = -7.0f32;
 388     ///
 389     /// assert!(!f.is_sign_negative());
 390     /// assert!(g.is_sign_negative());
 391     /// ```
 392     #[stable(feature = "rust1", since = "1.0.0")]
 393     #[inline]
 394     pub fn is_sign_negative(self) -> bool { num::Float::is_sign_negative(self) }
 395
 396     /// Fused multiply-add. Computes `(self * a) + b` with only one rounding
 397     /// error. This produces a more accurate result with better performance than
 398     /// a separate multiplication operation followed by an add.
 399     ///
 400     /// ```
 401     /// use std::f32;
 402     ///
 403     /// let m = 10.0_f32;
 404     /// let x = 4.0_f32;
 405     /// let b = 60.0_f32;
 406     ///
 407     /// // 100.0
 408     /// let abs_difference = (m.mul_add(x, b) - (m*x + b)).abs();
 409     ///
 410     /// assert!(abs_difference <= f32::EPSILON);
 411     /// ```
 412     #[stable(feature = "rust1", since = "1.0.0")]
 413     #[inline]
 414     pub fn mul_add(self, a: f32, b: f32) -> f32 {
 415         unsafe { intrinsics::fmaf32(self, a, b) }
 416     }
 417
 418     /// Takes the reciprocal (inverse) of a number, `1/x`.
 419     ///
 420     /// ```
 421     /// use std::f32;
 422     ///
 423     /// let x = 2.0_f32;
 424     /// let abs_difference = (x.recip() - (1.0/x)).abs();
 425     ///
 426     /// assert!(abs_difference <= f32::EPSILON);
 427     /// ```
 428     #[stable(feature = "rust1", since = "1.0.0")]
 429     #[inline]
 430     pub fn recip(self) -> f32 { num::Float::recip(self) }
 431
 432     /// Raises a number to an integer power.
 433     ///
 434     /// Using this function is generally faster than using `powf`
 435     ///
 436     /// ```
 437     /// use std::f32;
 438     ///
 439     /// let x = 2.0_f32;
 440     /// let abs_difference = (x.powi(2) - x*x).abs();
 441     ///
 442     /// assert!(abs_difference <= f32::EPSILON);
 443     /// ```
 444     #[stable(feature = "rust1", since = "1.0.0")]
 445     #[inline]
 446     pub fn powi(self, n: i32) -> f32 { num::Float::powi(self, n) }
 447
 448     /// Raises a number to a floating point power.
 449     ///
 450     /// ```
 451     /// use std::f32;
 452     ///
 453     /// let x = 2.0_f32;
 454     /// let abs_difference = (x.powf(2.0) - x*x).abs();
 455     ///
 456     /// assert!(abs_difference <= f32::EPSILON);
 457     /// ```
 458     #[stable(feature = "rust1", since = "1.0.0")]
 459     #[inline]
 460     pub fn powf(self, n: f32) -> f32 {
 461         // see notes above in `floor`
 462         #[cfg(target_env = "msvc")]
 463         return (self as f64).powf(n as f64) as f32;
 464         #[cfg(not(target_env = "msvc"))]
 465         return unsafe { intrinsics::powf32(self, n) };
 466     }
 467
 468     /// Takes the square root of a number.
 469     ///
 470     /// Returns NaN if `self` is a negative number.
 471     ///
 472     /// ```
 473     /// use std::f32;
 474     ///
 475     /// let positive = 4.0_f32;
 476     /// let negative = -4.0_f32;
 477     ///
 478     /// let abs_difference = (positive.sqrt() - 2.0).abs();
 479     ///
 480     /// assert!(abs_difference <= f32::EPSILON);
 481     /// assert!(negative.sqrt().is_nan());
 482     /// ```
 483     #[stable(feature = "rust1", since = "1.0.0")]
 484     #[inline]
 485     pub fn sqrt(self) -> f32 {
 486         if self < 0.0 {
 487             NAN
 488         } else {
 489             unsafe { intrinsics::sqrtf32(self) }
 490         }
 491     }
 492
 493     /// Returns `e^(self)`, (the exponential function).
 494     ///
 495     /// ```
 496     /// use std::f32;
 497     ///
 498     /// let one = 1.0f32;
 499     /// // e^1
 500     /// let e = one.exp();
 501     ///
 502     /// // ln(e) - 1 == 0
 503     /// let abs_difference = (e.ln() - 1.0).abs();
 504     ///
 505     /// assert!(abs_difference <= f32::EPSILON);
 506     /// ```
 507     #[stable(feature = "rust1", since = "1.0.0")]
 508     #[inline]
 509     pub fn exp(self) -> f32 {
 510         // see notes above in `floor`
 511         #[cfg(target_env = "msvc")]
 512         return (self as f64).exp() as f32;
 513         #[cfg(not(target_env = "msvc"))]
 514         return unsafe { intrinsics::expf32(self) };
 515     }
 516
 517     /// Returns `2^(self)`.
 518     ///
 519     /// ```
 520     /// use std::f32;
 521     ///
 522     /// let f = 2.0f32;
 523     ///
 524     /// // 2^2 - 4 == 0
 525     /// let abs_difference = (f.exp2() - 4.0).abs();
 526     ///
 527     /// assert!(abs_difference <= f32::EPSILON);
 528     /// ```
 529     #[stable(feature = "rust1", since = "1.0.0")]
 530     #[inline]
 531     pub fn exp2(self) -> f32 {
 532         unsafe { intrinsics::exp2f32(self) }
 533     }
 534
 535     /// Returns the natural logarithm of the number.
 536     ///
 537     /// ```
 538     /// use std::f32;
 539     ///
 540     /// let one = 1.0f32;
 541     /// // e^1
 542     /// let e = one.exp();
 543     ///
 544     /// // ln(e) - 1 == 0
 545     /// let abs_difference = (e.ln() - 1.0).abs();
 546     ///
 547     /// assert!(abs_difference <= f32::EPSILON);
 548     /// ```
 549     #[stable(feature = "rust1", since = "1.0.0")]
 550     #[inline]
 551     pub fn ln(self) -> f32 {
 552         // see notes above in `floor`
 553         #[cfg(target_env = "msvc")]
 554         return (self as f64).ln() as f32;
 555         #[cfg(not(target_env = "msvc"))]
 556         return unsafe { intrinsics::logf32(self) };
 557     }
 558
 559     /// Returns the logarithm of the number with respect to an arbitrary base.
 560     ///
 561     /// ```
 562     /// use std::f32;
 563     ///
 564     /// let ten = 10.0f32;
 565     /// let two = 2.0f32;
 566     ///
 567     /// // log10(10) - 1 == 0
 568     /// let abs_difference_10 = (ten.log(10.0) - 1.0).abs();
 569     ///
 570     /// // log2(2) - 1 == 0
 571     /// let abs_difference_2 = (two.log(2.0) - 1.0).abs();
 572     ///
 573     /// assert!(abs_difference_10 <= f32::EPSILON);
 574     /// assert!(abs_difference_2 <= f32::EPSILON);
 575     /// ```
 576     #[stable(feature = "rust1", since = "1.0.0")]
 577     #[inline]
 578     pub fn log(self, base: f32) -> f32 { self.ln() / base.ln() }
 579
 580     /// Returns the base 2 logarithm of the number.
 581     ///
 582     /// ```
 583     /// use std::f32;
 584     ///
 585     /// let two = 2.0f32;
 586     ///
 587     /// // log2(2) - 1 == 0
 588     /// let abs_difference = (two.log2() - 1.0).abs();
 589     ///
 590     /// assert!(abs_difference <= f32::EPSILON);
 591     /// ```
 592     #[stable(feature = "rust1", since = "1.0.0")]
 593     #[inline]
 594     pub fn log2(self) -> f32 {
 595         #[cfg(target_os = "android")]
 596         return ::sys::android::log2f32(self);
 597         #[cfg(not(target_os = "android"))]
 598         return unsafe { intrinsics::log2f32(self) };
 599     }
 600
 601     /// Returns the base 10 logarithm of the number.
 602     ///
 603     /// ```
 604     /// use std::f32;
 605     ///
 606     /// let ten = 10.0f32;
 607     ///
 608     /// // log10(10) - 1 == 0
 609     /// let abs_difference = (ten.log10() - 1.0).abs();
 610     ///
 611     /// assert!(abs_difference <= f32::EPSILON);
 612     /// ```
 613     #[stable(feature = "rust1", since = "1.0.0")]
 614     #[inline]
 615     pub fn log10(self) -> f32 {
 616         // see notes above in `floor`
 617         #[cfg(target_env = "msvc")]
 618         return (self as f64).log10() as f32;
 619         #[cfg(not(target_env = "msvc"))]
 620         return unsafe { intrinsics::log10f32(self) };
 621     }
 622
 623     /// Converts radians to degrees.
 624     ///
 625     /// ```
 626     /// use std::f32::{self, consts};
 627     ///
 628     /// let angle = consts::PI;
 629     ///
 630     /// let abs_difference = (angle.to_degrees() - 180.0).abs();
 631     ///
 632     /// assert!(abs_difference <= f32::EPSILON);
 633     /// ```
 634     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 635     #[inline]
 636     pub fn to_degrees(self) -> f32 { num::Float::to_degrees(self) }
 637
 638     /// Converts degrees to radians.
 639     ///
 640     /// ```
 641     /// use std::f32::{self, consts};
 642     ///
 643     /// let angle = 180.0f32;
 644     ///
 645     /// let abs_difference = (angle.to_radians() - consts::PI).abs();
 646     ///
 647     /// assert!(abs_difference <= f32::EPSILON);
 648     /// ```
 649     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 650     #[inline]
 651     pub fn to_radians(self) -> f32 { num::Float::to_radians(self) }
 652
 653     /// Returns the maximum of the two numbers.
 654     ///
 655     /// ```
 656     /// let x = 1.0f32;
 657     /// let y = 2.0f32;
 658     ///
 659     /// assert_eq!(x.max(y), y);
 660     /// ```
 661     ///
 662     /// If one of the arguments is NaN, then the other argument is returned.
 663     #[stable(feature = "rust1", since = "1.0.0")]
 664     #[inline]
 665     pub fn max(self, other: f32) -> f32 {
 666         unsafe { cmath::fmaxf(self, other) }
 667     }
 668
 669     /// Returns the minimum of the two numbers.
 670     ///
 671     /// ```
 672     /// let x = 1.0f32;
 673     /// let y = 2.0f32;
 674     ///
 675     /// assert_eq!(x.min(y), x);
 676     /// ```
 677     ///
 678     /// If one of the arguments is NaN, then the other argument is returned.
 679     #[stable(feature = "rust1", since = "1.0.0")]
 680     #[inline]
 681     pub fn min(self, other: f32) -> f32 {
 682         unsafe { cmath::fminf(self, other) }
 683     }
 684
 685     /// The positive difference of two numbers.
 686     ///
 687     /// * If `self <= other`: `0:0`
 688     /// * Else: `self - other`
 689     ///
 690     /// ```
 691     /// use std::f32;
 692     ///
 693     /// let x = 3.0f32;
 694     /// let y = -3.0f32;
 695     ///
 696     /// let abs_difference_x = (x.abs_sub(1.0) - 2.0).abs();
 697     /// let abs_difference_y = (y.abs_sub(1.0) - 0.0).abs();
 698     ///
 699     /// assert!(abs_difference_x <= f32::EPSILON);
 700     /// assert!(abs_difference_y <= f32::EPSILON);
 701     /// ```
 702     #[stable(feature = "rust1", since = "1.0.0")]
 703     #[inline]
 704     #[rustc_deprecated(since = "1.10.0",
 705                        reason = "you probably meant `(self - other).abs()`: \
 706                                  this operation is `(self - other).max(0.0)` (also \
 707                                  known as `fdimf` in C). If you truly need the positive \
 708                                  difference, consider using that expression or the C function \
 709                                  `fdimf`, depending on how you wish to handle NaN (please consider \
 710                                  filing an issue describing your use-case too).")]
 711     pub fn abs_sub(self, other: f32) -> f32 {
 712         unsafe { cmath::fdimf(self, other) }
 713     }
 714
 715     /// Takes the cubic root of a number.
 716     ///
 717     /// ```
 718     /// use std::f32;
 719     ///
 720     /// let x = 8.0f32;
 721     ///
 722     /// // x^(1/3) - 2 == 0
 723     /// let abs_difference = (x.cbrt() - 2.0).abs();
 724     ///
 725     /// assert!(abs_difference <= f32::EPSILON);
 726     /// ```
 727     #[stable(feature = "rust1", since = "1.0.0")]
 728     #[inline]
 729     pub fn cbrt(self) -> f32 {
 730         unsafe { cmath::cbrtf(self) }
 731     }
 732
 733     /// Calculates the length of the hypotenuse of a right-angle triangle given
 734     /// legs of length `x` and `y`.
 735     ///
 736     /// ```
 737     /// use std::f32;
 738     ///
 739     /// let x = 2.0f32;
 740     /// let y = 3.0f32;
 741     ///
 742     /// // sqrt(x^2 + y^2)
 743     /// let abs_difference = (x.hypot(y) - (x.powi(2) + y.powi(2)).sqrt()).abs();
 744     ///
 745     /// assert!(abs_difference <= f32::EPSILON);
 746     /// ```
 747     #[stable(feature = "rust1", since = "1.0.0")]
 748     #[inline]
 749     pub fn hypot(self, other: f32) -> f32 {
 750         unsafe { cmath::hypotf(self, other) }
 751     }
 752
 753     /// Computes the sine of a number (in radians).
 754     ///
 755     /// ```
 756     /// use std::f32;
 757     ///
 758     /// let x = f32::consts::PI/2.0;
 759     ///
 760     /// let abs_difference = (x.sin() - 1.0).abs();
 761     ///
 762     /// assert!(abs_difference <= f32::EPSILON);
 763     /// ```
 764     #[stable(feature = "rust1", since = "1.0.0")]
 765     #[inline]
 766     pub fn sin(self) -> f32 {
 767         // see notes in `core::f32::Float::floor`
 768         #[cfg(target_env = "msvc")]
 769         return (self as f64).sin() as f32;
 770         #[cfg(not(target_env = "msvc"))]
 771         return unsafe { intrinsics::sinf32(self) };
 772     }
 773
 774     /// Computes the cosine of a number (in radians).
 775     ///
 776     /// ```
 777     /// use std::f32;
 778     ///
 779     /// let x = 2.0*f32::consts::PI;
 780     ///
 781     /// let abs_difference = (x.cos() - 1.0).abs();
 782     ///
 783     /// assert!(abs_difference <= f32::EPSILON);
 784     /// ```
 785     #[stable(feature = "rust1", since = "1.0.0")]
 786     #[inline]
 787     pub fn cos(self) -> f32 {
 788         // see notes in `core::f32::Float::floor`
 789         #[cfg(target_env = "msvc")]
 790         return (self as f64).cos() as f32;
 791         #[cfg(not(target_env = "msvc"))]
 792         return unsafe { intrinsics::cosf32(self) };
 793     }
 794
 795     /// Computes the tangent of a number (in radians).
 796     ///
 797     /// ```
 798     /// use std::f32;
 799     ///
 800     /// let x = f32::consts::PI / 4.0;
 801     /// let abs_difference = (x.tan() - 1.0).abs();
 802     ///
 803     /// assert!(abs_difference <= f32::EPSILON);
 804     /// ```
 805     #[stable(feature = "rust1", since = "1.0.0")]
 806     #[inline]
 807     pub fn tan(self) -> f32 {
 808         unsafe { cmath::tanf(self) }
 809     }
 810
 811     /// Computes the arcsine of a number. Return value is in radians in
 812     /// the range [-pi/2, pi/2] or NaN if the number is outside the range
 813     /// [-1, 1].
 814     ///
 815     /// ```
 816     /// use std::f32;
 817     ///
 818     /// let f = f32::consts::PI / 2.0;
 819     ///
 820     /// // asin(sin(pi/2))
 821     /// let abs_difference = (f.sin().asin() - f32::consts::PI / 2.0).abs();
 822     ///
 823     /// assert!(abs_difference <= f32::EPSILON);
 824     /// ```
 825     #[stable(feature = "rust1", since = "1.0.0")]
 826     #[inline]
 827     pub fn asin(self) -> f32 {
 828         unsafe { cmath::asinf(self) }
 829     }
 830
 831     /// Computes the arccosine of a number. Return value is in radians in
 832     /// the range [0, pi] or NaN if the number is outside the range
 833     /// [-1, 1].
 834     ///
 835     /// ```
 836     /// use std::f32;
 837     ///
 838     /// let f = f32::consts::PI / 4.0;
 839     ///
 840     /// // acos(cos(pi/4))
 841     /// let abs_difference = (f.cos().acos() - f32::consts::PI / 4.0).abs();
 842     ///
 843     /// assert!(abs_difference <= f32::EPSILON);
 844     /// ```
 845     #[stable(feature = "rust1", since = "1.0.0")]
 846     #[inline]
 847     pub fn acos(self) -> f32 {
 848         unsafe { cmath::acosf(self) }
 849     }
 850
 851     /// Computes the arctangent of a number. Return value is in radians in the
 852     /// range [-pi/2, pi/2];
 853     ///
 854     /// ```
 855     /// use std::f32;
 856     ///
 857     /// let f = 1.0f32;
 858     ///
 859     /// // atan(tan(1))
 860     /// let abs_difference = (f.tan().atan() - 1.0).abs();
 861     ///
 862     /// assert!(abs_difference <= f32::EPSILON);
 863     /// ```
 864     #[stable(feature = "rust1", since = "1.0.0")]
 865     #[inline]
 866     pub fn atan(self) -> f32 {
 867         unsafe { cmath::atanf(self) }
 868     }
 869
 870     /// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`).
 871     ///
 872     /// * `x = 0`, `y = 0`: `0`
 873     /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
 874     /// * `y >= 0`: `arctan(y/x) + pi` -> `(pi/2, pi]`
 875     /// * `y < 0`: `arctan(y/x) - pi` -> `(-pi, -pi/2)`
 876     ///
 877     /// ```
 878     /// use std::f32;
 879     ///
 880     /// let pi = f32::consts::PI;
 881     /// // All angles from horizontal right (+x)
 882     /// // 45 deg counter-clockwise
 883     /// let x1 = 3.0f32;
 884     /// let y1 = -3.0f32;
 885     ///
 886     /// // 135 deg clockwise
 887     /// let x2 = -3.0f32;
 888     /// let y2 = 3.0f32;
 889     ///
 890     /// let abs_difference_1 = (y1.atan2(x1) - (-pi/4.0)).abs();
 891     /// let abs_difference_2 = (y2.atan2(x2) - 3.0*pi/4.0).abs();
 892     ///
 893     /// assert!(abs_difference_1 <= f32::EPSILON);
 894     /// assert!(abs_difference_2 <= f32::EPSILON);
 895     /// ```
 896     #[stable(feature = "rust1", since = "1.0.0")]
 897     #[inline]
 898     pub fn atan2(self, other: f32) -> f32 {
 899         unsafe { cmath::atan2f(self, other) }
 900     }
 901
 902     /// Simultaneously computes the sine and cosine of the number, `x`. Returns
 903     /// `(sin(x), cos(x))`.
 904     ///
 905     /// ```
 906     /// use std::f32;
 907     ///
 908     /// let x = f32::consts::PI/4.0;
 909     /// let f = x.sin_cos();
 910     ///
 911     /// let abs_difference_0 = (f.0 - x.sin()).abs();
 912     /// let abs_difference_1 = (f.1 - x.cos()).abs();
 913     ///
 914     /// assert!(abs_difference_0 <= f32::EPSILON);
 915     /// assert!(abs_difference_1 <= f32::EPSILON);
 916     /// ```
 917     #[stable(feature = "rust1", since = "1.0.0")]
 918     #[inline]
 919     pub fn sin_cos(self) -> (f32, f32) {
 920         (self.sin(), self.cos())
 921     }
 922
 923     /// Returns `e^(self) - 1` in a way that is accurate even if the
 924     /// number is close to zero.
 925     ///
 926     /// ```
 927     /// use std::f32;
 928     ///
 929     /// let x = 6.0f32;
 930     ///
 931     /// // e^(ln(6)) - 1
 932     /// let abs_difference = (x.ln().exp_m1() - 5.0).abs();
 933     ///
 934     /// assert!(abs_difference <= f32::EPSILON);
 935     /// ```
 936     #[stable(feature = "rust1", since = "1.0.0")]
 937     #[inline]
 938     pub fn exp_m1(self) -> f32 {
 939         unsafe { cmath::expm1f(self) }
 940     }
 941
 942     /// Returns `ln(1+n)` (natural logarithm) more accurately than if
 943     /// the operations were performed separately.
 944     ///
 945     /// ```
 946     /// use std::f32;
 947     ///
 948     /// let x = f32::consts::E - 1.0;
 949     ///
 950     /// // ln(1 + (e - 1)) == ln(e) == 1
 951     /// let abs_difference = (x.ln_1p() - 1.0).abs();
 952     ///
 953     /// assert!(abs_difference <= f32::EPSILON);
 954     /// ```
 955     #[stable(feature = "rust1", since = "1.0.0")]
 956     #[inline]
 957     pub fn ln_1p(self) -> f32 {
 958         unsafe { cmath::log1pf(self) }
 959     }
 960
 961     /// Hyperbolic sine function.
 962     ///
 963     /// ```
 964     /// use std::f32;
 965     ///
 966     /// let e = f32::consts::E;
 967     /// let x = 1.0f32;
 968     ///
 969     /// let f = x.sinh();
 970     /// // Solving sinh() at 1 gives `(e^2-1)/(2e)`
 971     /// let g = (e*e - 1.0)/(2.0*e);
 972     /// let abs_difference = (f - g).abs();
 973     ///
 974     /// assert!(abs_difference <= f32::EPSILON);
 975     /// ```
 976     #[stable(feature = "rust1", since = "1.0.0")]
 977     #[inline]
 978     pub fn sinh(self) -> f32 {
 979         unsafe { cmath::sinhf(self) }
 980     }
 981
 982     /// Hyperbolic cosine function.
 983     ///
 984     /// ```
 985     /// use std::f32;
 986     ///
 987     /// let e = f32::consts::E;
 988     /// let x = 1.0f32;
 989     /// let f = x.cosh();
 990     /// // Solving cosh() at 1 gives this result
 991     /// let g = (e*e + 1.0)/(2.0*e);
 992     /// let abs_difference = (f - g).abs();
 993     ///
 994     /// // Same result
 995     /// assert!(abs_difference <= f32::EPSILON);
 996     /// ```
 997     #[stable(feature = "rust1", since = "1.0.0")]
 998     #[inline]
 999     pub fn cosh(self) -> f32 {
1000         unsafe { cmath::coshf(self) }
1001     }
1002
1003     /// Hyperbolic tangent function.
1004     ///
1005     /// ```
1006     /// use std::f32;
1007     ///
1008     /// let e = f32::consts::E;
1009     /// let x = 1.0f32;
1010     ///
1011     /// let f = x.tanh();
1012     /// // Solving tanh() at 1 gives `(1 - e^(-2))/(1 + e^(-2))`
1013     /// let g = (1.0 - e.powi(-2))/(1.0 + e.powi(-2));
1014     /// let abs_difference = (f - g).abs();
1015     ///
1016     /// assert!(abs_difference <= f32::EPSILON);
1017     /// ```
1018     #[stable(feature = "rust1", since = "1.0.0")]
1019     #[inline]
1020     pub fn tanh(self) -> f32 {
1021         unsafe { cmath::tanhf(self) }
1022     }
1023
1024     /// Inverse hyperbolic sine function.
1025     ///
1026     /// ```
1027     /// use std::f32;
1028     ///
1029     /// let x = 1.0f32;
1030     /// let f = x.sinh().asinh();
1031     ///
1032     /// let abs_difference = (f - x).abs();
1033     ///
1034     /// assert!(abs_difference <= f32::EPSILON);
1035     /// ```
1036     #[stable(feature = "rust1", since = "1.0.0")]
1037     #[inline]
1038     pub fn asinh(self) -> f32 {
1039         if self == NEG_INFINITY {
1040             NEG_INFINITY
1041         } else {
1042             (self + ((self * self) + 1.0).sqrt()).ln()
1043         }
1044     }
1045
1046     /// Inverse hyperbolic cosine function.
1047     ///
1048     /// ```
1049     /// use std::f32;
1050     ///
1051     /// let x = 1.0f32;
1052     /// let f = x.cosh().acosh();
1053     ///
1054     /// let abs_difference = (f - x).abs();
1055     ///
1056     /// assert!(abs_difference <= f32::EPSILON);
1057     /// ```
1058     #[stable(feature = "rust1", since = "1.0.0")]
1059     #[inline]
1060     pub fn acosh(self) -> f32 {
1061         match self {
1062             x if x < 1.0 => ::f32::NAN,
1063             x => (x + ((x * x) - 1.0).sqrt()).ln(),
1064         }
1065     }
1066
1067     /// Inverse hyperbolic tangent function.
1068     ///
1069     /// ```
1070     /// use std::f32;
1071     ///
1072     /// let e = f32::consts::E;
1073     /// let f = e.tanh().atanh();
1074     ///
1075     /// let abs_difference = (f - e).abs();
1076     ///
1077     /// assert!(abs_difference <= 1e-5);
1078     /// ```
1079     #[stable(feature = "rust1", since = "1.0.0")]
1080     #[inline]
1081     pub fn atanh(self) -> f32 {
1082         0.5 * ((2.0 * self) / (1.0 - self)).ln_1p()
1083     }
1084
1085     /// Raw transmutation to `u32`.
1086     ///
1087     /// Converts the `f32` into its raw memory representation,
1088     /// similar to the `transmute` function.
1089     ///
1090     /// Note that this function is distinct from casting.
1091     ///
1092     /// # Examples
1093     ///
1094     /// ```
1095     /// #![feature(float_bits_conv)]
1096     /// assert_ne!((1f32).to_bits(), 1f32 as u32); // to_bits() is not casting!
1097     /// assert_eq!((12.5f32).to_bits(), 0x41480000);
1098     ///
1099     /// ```
1100     #[unstable(feature = "float_bits_conv", reason = "recently added", issue = "40470")]
1101     #[inline]
1102     pub fn to_bits(self) -> u32 {
1103         unsafe { ::mem::transmute(self) }
1104     }
1105
1106     /// Raw transmutation from `u32`.
1107     ///
1108     /// Converts the given `u32` containing the float's raw memory
1109     /// representation into the `f32` type, similar to the
1110     /// `transmute` function.
1111     ///
1112     /// There is only one difference to a bare `transmute`:
1113     /// Due to the implications onto Rust's safety promises being
1114     /// uncertain, if the representation of a signaling NaN "sNaN" float
1115     /// is passed to the function, the implementation is allowed to
1116     /// return a quiet NaN instead.
1117     ///
1118     /// Note that this function is distinct from casting.
1119     ///
1120     /// # Examples
1121     ///
1122     /// ```
1123     /// #![feature(float_bits_conv)]
1124     /// use std::f32;
1125     /// let v = f32::from_bits(0x41480000);
1126     /// let difference = (v - 12.5).abs();
1127     /// assert!(difference <= 1e-5);
1128     /// // Example for a signaling NaN value:
1129     /// let snan = 0x7F800001;
1130     /// assert_ne!(f32::from_bits(snan).to_bits(), snan);
1131     /// ```
1132     #[unstable(feature = "float_bits_conv", reason = "recently added", issue = "40470")]
1133     #[inline]
1134     pub fn from_bits(mut v: u32) -> Self {
1135         const EXP_MASK: u32   = 0x7F800000;
1136         const QNAN_MASK: u32  = 0x00400000;
1137         const FRACT_MASK: u32 = 0x007FFFFF;
1138         if v & EXP_MASK == EXP_MASK && v & FRACT_MASK != 0 {
1139             // If we have a NaN value, we
1140             // convert signaling NaN values to quiet NaN
1141             // by setting the the highest bit of the fraction
1142             v |= QNAN_MASK;
1143         }
1144         unsafe { ::mem::transmute(v) }
1145     }
1146 }
1147
1148 #[cfg(test)]
1149 mod tests {
1150     use f32;
1151     use f32::*;
1152     use num::*;
1153     use num::FpCategory as Fp;
1154
1155     #[test]
1156     fn test_num_f32() {
1157         test_num(10f32, 2f32);
1158     }
1159
1160     #[test]
1161     fn test_min_nan() {
1162         assert_eq!(NAN.min(2.0), 2.0);
1163         assert_eq!(2.0f32.min(NAN), 2.0);
1164     }
1165
1166     #[test]
1167     fn test_max_nan() {
1168         assert_eq!(NAN.max(2.0), 2.0);
1169         assert_eq!(2.0f32.max(NAN), 2.0);
1170     }
1171
1172     #[test]
1173     fn test_nan() {
1174         let nan: f32 = f32::NAN;
1175         assert!(nan.is_nan());
1176         assert!(!nan.is_infinite());
1177         assert!(!nan.is_finite());
1178         assert!(!nan.is_normal());
1179         assert!(nan.is_sign_positive());
1180         assert!(!nan.is_sign_negative());
1181         assert_eq!(Fp::Nan, nan.classify());
1182     }
1183
1184     #[test]
1185     fn test_infinity() {
1186         let inf: f32 = f32::INFINITY;
1187         assert!(inf.is_infinite());
1188         assert!(!inf.is_finite());
1189         assert!(inf.is_sign_positive());
1190         assert!(!inf.is_sign_negative());
1191         assert!(!inf.is_nan());
1192         assert!(!inf.is_normal());
1193         assert_eq!(Fp::Infinite, inf.classify());
1194     }
1195
1196     #[test]
1197     fn test_neg_infinity() {
1198         let neg_inf: f32 = f32::NEG_INFINITY;
1199         assert!(neg_inf.is_infinite());
1200         assert!(!neg_inf.is_finite());
1201         assert!(!neg_inf.is_sign_positive());
1202         assert!(neg_inf.is_sign_negative());
1203         assert!(!neg_inf.is_nan());
1204         assert!(!neg_inf.is_normal());
1205         assert_eq!(Fp::Infinite, neg_inf.classify());
1206     }
1207
1208     #[test]
1209     fn test_zero() {
1210         let zero: f32 = 0.0f32;
1211         assert_eq!(0.0, zero);
1212         assert!(!zero.is_infinite());
1213         assert!(zero.is_finite());
1214         assert!(zero.is_sign_positive());
1215         assert!(!zero.is_sign_negative());
1216         assert!(!zero.is_nan());
1217         assert!(!zero.is_normal());
1218         assert_eq!(Fp::Zero, zero.classify());
1219     }
1220
1221     #[test]
1222     fn test_neg_zero() {
1223         let neg_zero: f32 = -0.0;
1224         assert_eq!(0.0, neg_zero);
1225         assert!(!neg_zero.is_infinite());
1226         assert!(neg_zero.is_finite());
1227         assert!(!neg_zero.is_sign_positive());
1228         assert!(neg_zero.is_sign_negative());
1229         assert!(!neg_zero.is_nan());
1230         assert!(!neg_zero.is_normal());
1231         assert_eq!(Fp::Zero, neg_zero.classify());
1232     }
1233
1234     #[test]
1235     fn test_one() {
1236         let one: f32 = 1.0f32;
1237         assert_eq!(1.0, one);
1238         assert!(!one.is_infinite());
1239         assert!(one.is_finite());
1240         assert!(one.is_sign_positive());
1241         assert!(!one.is_sign_negative());
1242         assert!(!one.is_nan());
1243         assert!(one.is_normal());
1244         assert_eq!(Fp::Normal, one.classify());
1245     }
1246
1247     #[test]
1248     fn test_is_nan() {
1249         let nan: f32 = f32::NAN;
1250         let inf: f32 = f32::INFINITY;
1251         let neg_inf: f32 = f32::NEG_INFINITY;
1252         assert!(nan.is_nan());
1253         assert!(!0.0f32.is_nan());
1254         assert!(!5.3f32.is_nan());
1255         assert!(!(-10.732f32).is_nan());
1256         assert!(!inf.is_nan());
1257         assert!(!neg_inf.is_nan());
1258     }
1259
1260     #[test]
1261     fn test_is_infinite() {
1262         let nan: f32 = f32::NAN;
1263         let inf: f32 = f32::INFINITY;
1264         let neg_inf: f32 = f32::NEG_INFINITY;
1265         assert!(!nan.is_infinite());
1266         assert!(inf.is_infinite());
1267         assert!(neg_inf.is_infinite());
1268         assert!(!0.0f32.is_infinite());
1269         assert!(!42.8f32.is_infinite());
1270         assert!(!(-109.2f32).is_infinite());
1271     }
1272
1273     #[test]
1274     fn test_is_finite() {
1275         let nan: f32 = f32::NAN;
1276         let inf: f32 = f32::INFINITY;
1277         let neg_inf: f32 = f32::NEG_INFINITY;
1278         assert!(!nan.is_finite());
1279         assert!(!inf.is_finite());
1280         assert!(!neg_inf.is_finite());
1281         assert!(0.0f32.is_finite());
1282         assert!(42.8f32.is_finite());
1283         assert!((-109.2f32).is_finite());
1284     }
1285
1286     #[test]
1287     fn test_is_normal() {
1288         let nan: f32 = f32::NAN;
1289         let inf: f32 = f32::INFINITY;
1290         let neg_inf: f32 = f32::NEG_INFINITY;
1291         let zero: f32 = 0.0f32;
1292         let neg_zero: f32 = -0.0;
1293         assert!(!nan.is_normal());
1294         assert!(!inf.is_normal());
1295         assert!(!neg_inf.is_normal());
1296         assert!(!zero.is_normal());
1297         assert!(!neg_zero.is_normal());
1298         assert!(1f32.is_normal());
1299         assert!(1e-37f32.is_normal());
1300         assert!(!1e-38f32.is_normal());
1301     }
1302
1303     #[test]
1304     fn test_classify() {
1305         let nan: f32 = f32::NAN;
1306         let inf: f32 = f32::INFINITY;
1307         let neg_inf: f32 = f32::NEG_INFINITY;
1308         let zero: f32 = 0.0f32;
1309         let neg_zero: f32 = -0.0;
1310         assert_eq!(nan.classify(), Fp::Nan);
1311         assert_eq!(inf.classify(), Fp::Infinite);
1312         assert_eq!(neg_inf.classify(), Fp::Infinite);
1313         assert_eq!(zero.classify(), Fp::Zero);
1314         assert_eq!(neg_zero.classify(), Fp::Zero);
1315         assert_eq!(1f32.classify(), Fp::Normal);
1316         assert_eq!(1e-37f32.classify(), Fp::Normal);
1317         assert_eq!(1e-38f32.classify(), Fp::Subnormal);
1318     }
1319
1320     #[test]
1321     fn test_floor() {
1322         assert_approx_eq!(1.0f32.floor(), 1.0f32);
1323         assert_approx_eq!(1.3f32.floor(), 1.0f32);
1324         assert_approx_eq!(1.5f32.floor(), 1.0f32);
1325         assert_approx_eq!(1.7f32.floor(), 1.0f32);
1326         assert_approx_eq!(0.0f32.floor(), 0.0f32);
1327         assert_approx_eq!((-0.0f32).floor(), -0.0f32);
1328         assert_approx_eq!((-1.0f32).floor(), -1.0f32);
1329         assert_approx_eq!((-1.3f32).floor(), -2.0f32);
1330         assert_approx_eq!((-1.5f32).floor(), -2.0f32);
1331         assert_approx_eq!((-1.7f32).floor(), -2.0f32);
1332     }
1333
1334     #[test]
1335     fn test_ceil() {
1336         assert_approx_eq!(1.0f32.ceil(), 1.0f32);
1337         assert_approx_eq!(1.3f32.ceil(), 2.0f32);
1338         assert_approx_eq!(1.5f32.ceil(), 2.0f32);
1339         assert_approx_eq!(1.7f32.ceil(), 2.0f32);
1340         assert_approx_eq!(0.0f32.ceil(), 0.0f32);
1341         assert_approx_eq!((-0.0f32).ceil(), -0.0f32);
1342         assert_approx_eq!((-1.0f32).ceil(), -1.0f32);
1343         assert_approx_eq!((-1.3f32).ceil(), -1.0f32);
1344         assert_approx_eq!((-1.5f32).ceil(), -1.0f32);
1345         assert_approx_eq!((-1.7f32).ceil(), -1.0f32);
1346     }
1347
1348     #[test]
1349     fn test_round() {
1350         assert_approx_eq!(1.0f32.round(), 1.0f32);
1351         assert_approx_eq!(1.3f32.round(), 1.0f32);
1352         assert_approx_eq!(1.5f32.round(), 2.0f32);
1353         assert_approx_eq!(1.7f32.round(), 2.0f32);
1354         assert_approx_eq!(0.0f32.round(), 0.0f32);
1355         assert_approx_eq!((-0.0f32).round(), -0.0f32);
1356         assert_approx_eq!((-1.0f32).round(), -1.0f32);
1357         assert_approx_eq!((-1.3f32).round(), -1.0f32);
1358         assert_approx_eq!((-1.5f32).round(), -2.0f32);
1359         assert_approx_eq!((-1.7f32).round(), -2.0f32);
1360     }
1361
1362     #[test]
1363     fn test_trunc() {
1364         assert_approx_eq!(1.0f32.trunc(), 1.0f32);
1365         assert_approx_eq!(1.3f32.trunc(), 1.0f32);
1366         assert_approx_eq!(1.5f32.trunc(), 1.0f32);
1367         assert_approx_eq!(1.7f32.trunc(), 1.0f32);
1368         assert_approx_eq!(0.0f32.trunc(), 0.0f32);
1369         assert_approx_eq!((-0.0f32).trunc(), -0.0f32);
1370         assert_approx_eq!((-1.0f32).trunc(), -1.0f32);
1371         assert_approx_eq!((-1.3f32).trunc(), -1.0f32);
1372         assert_approx_eq!((-1.5f32).trunc(), -1.0f32);
1373         assert_approx_eq!((-1.7f32).trunc(), -1.0f32);
1374     }
1375
1376     #[test]
1377     fn test_fract() {
1378         assert_approx_eq!(1.0f32.fract(), 0.0f32);
1379         assert_approx_eq!(1.3f32.fract(), 0.3f32);
1380         assert_approx_eq!(1.5f32.fract(), 0.5f32);
1381         assert_approx_eq!(1.7f32.fract(), 0.7f32);
1382         assert_approx_eq!(0.0f32.fract(), 0.0f32);
1383         assert_approx_eq!((-0.0f32).fract(), -0.0f32);
1384         assert_approx_eq!((-1.0f32).fract(), -0.0f32);
1385         assert_approx_eq!((-1.3f32).fract(), -0.3f32);
1386         assert_approx_eq!((-1.5f32).fract(), -0.5f32);
1387         assert_approx_eq!((-1.7f32).fract(), -0.7f32);
1388     }
1389
1390     #[test]
1391     fn test_abs() {
1392         assert_eq!(INFINITY.abs(), INFINITY);
1393         assert_eq!(1f32.abs(), 1f32);
1394         assert_eq!(0f32.abs(), 0f32);
1395         assert_eq!((-0f32).abs(), 0f32);
1396         assert_eq!((-1f32).abs(), 1f32);
1397         assert_eq!(NEG_INFINITY.abs(), INFINITY);
1398         assert_eq!((1f32/NEG_INFINITY).abs(), 0f32);
1399         assert!(NAN.abs().is_nan());
1400     }
1401
1402     #[test]
1403     fn test_signum() {
1404         assert_eq!(INFINITY.signum(), 1f32);
1405         assert_eq!(1f32.signum(), 1f32);
1406         assert_eq!(0f32.signum(), 1f32);
1407         assert_eq!((-0f32).signum(), -1f32);
1408         assert_eq!((-1f32).signum(), -1f32);
1409         assert_eq!(NEG_INFINITY.signum(), -1f32);
1410         assert_eq!((1f32/NEG_INFINITY).signum(), -1f32);
1411         assert!(NAN.signum().is_nan());
1412     }
1413
1414     #[test]
1415     fn test_is_sign_positive() {
1416         assert!(INFINITY.is_sign_positive());
1417         assert!(1f32.is_sign_positive());
1418         assert!(0f32.is_sign_positive());
1419         assert!(!(-0f32).is_sign_positive());
1420         assert!(!(-1f32).is_sign_positive());
1421         assert!(!NEG_INFINITY.is_sign_positive());
1422         assert!(!(1f32/NEG_INFINITY).is_sign_positive());
1423         assert!(NAN.is_sign_positive());
1424         assert!(!(-NAN).is_sign_positive());
1425     }
1426
1427     #[test]
1428     fn test_is_sign_negative() {
1429         assert!(!INFINITY.is_sign_negative());
1430         assert!(!1f32.is_sign_negative());
1431         assert!(!0f32.is_sign_negative());
1432         assert!((-0f32).is_sign_negative());
1433         assert!((-1f32).is_sign_negative());
1434         assert!(NEG_INFINITY.is_sign_negative());
1435         assert!((1f32/NEG_INFINITY).is_sign_negative());
1436         assert!(!NAN.is_sign_negative());
1437         assert!((-NAN).is_sign_negative());
1438     }
1439
1440     #[test]
1441     fn test_mul_add() {
1442         let nan: f32 = f32::NAN;
1443         let inf: f32 = f32::INFINITY;
1444         let neg_inf: f32 = f32::NEG_INFINITY;
1445         assert_approx_eq!(12.3f32.mul_add(4.5, 6.7), 62.05);
1446         assert_approx_eq!((-12.3f32).mul_add(-4.5, -6.7), 48.65);
1447         assert_approx_eq!(0.0f32.mul_add(8.9, 1.2), 1.2);
1448         assert_approx_eq!(3.4f32.mul_add(-0.0, 5.6), 5.6);
1449         assert!(nan.mul_add(7.8, 9.0).is_nan());
1450         assert_eq!(inf.mul_add(7.8, 9.0), inf);
1451         assert_eq!(neg_inf.mul_add(7.8, 9.0), neg_inf);
1452         assert_eq!(8.9f32.mul_add(inf, 3.2), inf);
1453         assert_eq!((-3.2f32).mul_add(2.4, neg_inf), neg_inf);
1454     }
1455
1456     #[test]
1457     fn test_recip() {
1458         let nan: f32 = f32::NAN;
1459         let inf: f32 = f32::INFINITY;
1460         let neg_inf: f32 = f32::NEG_INFINITY;
1461         assert_eq!(1.0f32.recip(), 1.0);
1462         assert_eq!(2.0f32.recip(), 0.5);
1463         assert_eq!((-0.4f32).recip(), -2.5);
1464         assert_eq!(0.0f32.recip(), inf);
1465         assert!(nan.recip().is_nan());
1466         assert_eq!(inf.recip(), 0.0);
1467         assert_eq!(neg_inf.recip(), 0.0);
1468     }
1469
1470     #[test]
1471     fn test_powi() {
1472         let nan: f32 = f32::NAN;
1473         let inf: f32 = f32::INFINITY;
1474         let neg_inf: f32 = f32::NEG_INFINITY;
1475         assert_eq!(1.0f32.powi(1), 1.0);
1476         assert_approx_eq!((-3.1f32).powi(2), 9.61);
1477         assert_approx_eq!(5.9f32.powi(-2), 0.028727);
1478         assert_eq!(8.3f32.powi(0), 1.0);
1479         assert!(nan.powi(2).is_nan());
1480         assert_eq!(inf.powi(3), inf);
1481         assert_eq!(neg_inf.powi(2), inf);
1482     }
1483
1484     #[test]
1485     fn test_powf() {
1486         let nan: f32 = f32::NAN;
1487         let inf: f32 = f32::INFINITY;
1488         let neg_inf: f32 = f32::NEG_INFINITY;
1489         assert_eq!(1.0f32.powf(1.0), 1.0);
1490         assert_approx_eq!(3.4f32.powf(4.5), 246.408218);
1491         assert_approx_eq!(2.7f32.powf(-3.2), 0.041652);
1492         assert_approx_eq!((-3.1f32).powf(2.0), 9.61);
1493         assert_approx_eq!(5.9f32.powf(-2.0), 0.028727);
1494         assert_eq!(8.3f32.powf(0.0), 1.0);
1495         assert!(nan.powf(2.0).is_nan());
1496         assert_eq!(inf.powf(2.0), inf);
1497         assert_eq!(neg_inf.powf(3.0), neg_inf);
1498     }
1499
1500     #[test]
1501     fn test_sqrt_domain() {
1502         assert!(NAN.sqrt().is_nan());
1503         assert!(NEG_INFINITY.sqrt().is_nan());
1504         assert!((-1.0f32).sqrt().is_nan());
1505         assert_eq!((-0.0f32).sqrt(), -0.0);
1506         assert_eq!(0.0f32.sqrt(), 0.0);
1507         assert_eq!(1.0f32.sqrt(), 1.0);
1508         assert_eq!(INFINITY.sqrt(), INFINITY);
1509     }
1510
1511     #[test]
1512     fn test_exp() {
1513         assert_eq!(1.0, 0.0f32.exp());
1514         assert_approx_eq!(2.718282, 1.0f32.exp());
1515         assert_approx_eq!(148.413162, 5.0f32.exp());
1516
1517         let inf: f32 = f32::INFINITY;
1518         let neg_inf: f32 = f32::NEG_INFINITY;
1519         let nan: f32 = f32::NAN;
1520         assert_eq!(inf, inf.exp());
1521         assert_eq!(0.0, neg_inf.exp());
1522         assert!(nan.exp().is_nan());
1523     }
1524
1525     #[test]
1526     fn test_exp2() {
1527         assert_eq!(32.0, 5.0f32.exp2());
1528         assert_eq!(1.0, 0.0f32.exp2());
1529
1530         let inf: f32 = f32::INFINITY;
1531         let neg_inf: f32 = f32::NEG_INFINITY;
1532         let nan: f32 = f32::NAN;
1533         assert_eq!(inf, inf.exp2());
1534         assert_eq!(0.0, neg_inf.exp2());
1535         assert!(nan.exp2().is_nan());
1536     }
1537
1538     #[test]
1539     fn test_ln() {
1540         let nan: f32 = f32::NAN;
1541         let inf: f32 = f32::INFINITY;
1542         let neg_inf: f32 = f32::NEG_INFINITY;
1543         assert_approx_eq!(1.0f32.exp().ln(), 1.0);
1544         assert!(nan.ln().is_nan());
1545         assert_eq!(inf.ln(), inf);
1546         assert!(neg_inf.ln().is_nan());
1547         assert!((-2.3f32).ln().is_nan());
1548         assert_eq!((-0.0f32).ln(), neg_inf);
1549         assert_eq!(0.0f32.ln(), neg_inf);
1550         assert_approx_eq!(4.0f32.ln(), 1.386294);
1551     }
1552
1553     #[test]
1554     fn test_log() {
1555         let nan: f32 = f32::NAN;
1556         let inf: f32 = f32::INFINITY;
1557         let neg_inf: f32 = f32::NEG_INFINITY;
1558         assert_eq!(10.0f32.log(10.0), 1.0);
1559         assert_approx_eq!(2.3f32.log(3.5), 0.664858);
1560         assert_eq!(1.0f32.exp().log(1.0f32.exp()), 1.0);
1561         assert!(1.0f32.log(1.0).is_nan());
1562         assert!(1.0f32.log(-13.9).is_nan());
1563         assert!(nan.log(2.3).is_nan());
1564         assert_eq!(inf.log(10.0), inf);
1565         assert!(neg_inf.log(8.8).is_nan());
1566         assert!((-2.3f32).log(0.1).is_nan());
1567         assert_eq!((-0.0f32).log(2.0), neg_inf);
1568         assert_eq!(0.0f32.log(7.0), neg_inf);
1569     }
1570
1571     #[test]
1572     fn test_log2() {
1573         let nan: f32 = f32::NAN;
1574         let inf: f32 = f32::INFINITY;
1575         let neg_inf: f32 = f32::NEG_INFINITY;
1576         assert_approx_eq!(10.0f32.log2(), 3.321928);
1577         assert_approx_eq!(2.3f32.log2(), 1.201634);
1578         assert_approx_eq!(1.0f32.exp().log2(), 1.442695);
1579         assert!(nan.log2().is_nan());
1580         assert_eq!(inf.log2(), inf);
1581         assert!(neg_inf.log2().is_nan());
1582         assert!((-2.3f32).log2().is_nan());
1583         assert_eq!((-0.0f32).log2(), neg_inf);
1584         assert_eq!(0.0f32.log2(), neg_inf);
1585     }
1586
1587     #[test]
1588     fn test_log10() {
1589         let nan: f32 = f32::NAN;
1590         let inf: f32 = f32::INFINITY;
1591         let neg_inf: f32 = f32::NEG_INFINITY;
1592         assert_eq!(10.0f32.log10(), 1.0);
1593         assert_approx_eq!(2.3f32.log10(), 0.361728);
1594         assert_approx_eq!(1.0f32.exp().log10(), 0.434294);
1595         assert_eq!(1.0f32.log10(), 0.0);
1596         assert!(nan.log10().is_nan());
1597         assert_eq!(inf.log10(), inf);
1598         assert!(neg_inf.log10().is_nan());
1599         assert!((-2.3f32).log10().is_nan());
1600         assert_eq!((-0.0f32).log10(), neg_inf);
1601         assert_eq!(0.0f32.log10(), neg_inf);
1602     }
1603
1604     #[test]
1605     fn test_to_degrees() {
1606         let pi: f32 = consts::PI;
1607         let nan: f32 = f32::NAN;
1608         let inf: f32 = f32::INFINITY;
1609         let neg_inf: f32 = f32::NEG_INFINITY;
1610         assert_eq!(0.0f32.to_degrees(), 0.0);
1611         assert_approx_eq!((-5.8f32).to_degrees(), -332.315521);
1612         assert_eq!(pi.to_degrees(), 180.0);
1613         assert!(nan.to_degrees().is_nan());
1614         assert_eq!(inf.to_degrees(), inf);
1615         assert_eq!(neg_inf.to_degrees(), neg_inf);
1616     }
1617
1618     #[test]
1619     fn test_to_radians() {
1620         let pi: f32 = consts::PI;
1621         let nan: f32 = f32::NAN;
1622         let inf: f32 = f32::INFINITY;
1623         let neg_inf: f32 = f32::NEG_INFINITY;
1624         assert_eq!(0.0f32.to_radians(), 0.0);
1625         assert_approx_eq!(154.6f32.to_radians(), 2.698279);
1626         assert_approx_eq!((-332.31f32).to_radians(), -5.799903);
1627         assert_eq!(180.0f32.to_radians(), pi);
1628         assert!(nan.to_radians().is_nan());
1629         assert_eq!(inf.to_radians(), inf);
1630         assert_eq!(neg_inf.to_radians(), neg_inf);
1631     }
1632
1633     #[test]
1634     fn test_asinh() {
1635         assert_eq!(0.0f32.asinh(), 0.0f32);
1636         assert_eq!((-0.0f32).asinh(), -0.0f32);
1637
1638         let inf: f32 = f32::INFINITY;
1639         let neg_inf: f32 = f32::NEG_INFINITY;
1640         let nan: f32 = f32::NAN;
1641         assert_eq!(inf.asinh(), inf);
1642         assert_eq!(neg_inf.asinh(), neg_inf);
1643         assert!(nan.asinh().is_nan());
1644         assert_approx_eq!(2.0f32.asinh(), 1.443635475178810342493276740273105f32);
1645         assert_approx_eq!((-2.0f32).asinh(), -1.443635475178810342493276740273105f32);
1646     }
1647
1648     #[test]
1649     fn test_acosh() {
1650         assert_eq!(1.0f32.acosh(), 0.0f32);
1651         assert!(0.999f32.acosh().is_nan());
1652
1653         let inf: f32 = f32::INFINITY;
1654         let neg_inf: f32 = f32::NEG_INFINITY;
1655         let nan: f32 = f32::NAN;
1656         assert_eq!(inf.acosh(), inf);
1657         assert!(neg_inf.acosh().is_nan());
1658         assert!(nan.acosh().is_nan());
1659         assert_approx_eq!(2.0f32.acosh(), 1.31695789692481670862504634730796844f32);
1660         assert_approx_eq!(3.0f32.acosh(), 1.76274717403908605046521864995958461f32);
1661     }
1662
1663     #[test]
1664     fn test_atanh() {
1665         assert_eq!(0.0f32.atanh(), 0.0f32);
1666         assert_eq!((-0.0f32).atanh(), -0.0f32);
1667
1668         let inf32: f32 = f32::INFINITY;
1669         let neg_inf32: f32 = f32::NEG_INFINITY;
1670         assert_eq!(1.0f32.atanh(), inf32);
1671         assert_eq!((-1.0f32).atanh(), neg_inf32);
1672
1673         assert!(2f64.atanh().atanh().is_nan());
1674         assert!((-2f64).atanh().atanh().is_nan());
1675
1676         let inf64: f32 = f32::INFINITY;
1677         let neg_inf64: f32 = f32::NEG_INFINITY;
1678         let nan32: f32 = f32::NAN;
1679         assert!(inf64.atanh().is_nan());
1680         assert!(neg_inf64.atanh().is_nan());
1681         assert!(nan32.atanh().is_nan());
1682
1683         assert_approx_eq!(0.5f32.atanh(), 0.54930614433405484569762261846126285f32);
1684         assert_approx_eq!((-0.5f32).atanh(), -0.54930614433405484569762261846126285f32);
1685     }
1686
1687     #[test]
1688     fn test_real_consts() {
1689         use super::consts;
1690
1691         let pi: f32 = consts::PI;
1692         let frac_pi_2: f32 = consts::FRAC_PI_2;
1693         let frac_pi_3: f32 = consts::FRAC_PI_3;
1694         let frac_pi_4: f32 = consts::FRAC_PI_4;
1695         let frac_pi_6: f32 = consts::FRAC_PI_6;
1696         let frac_pi_8: f32 = consts::FRAC_PI_8;
1697         let frac_1_pi: f32 = consts::FRAC_1_PI;
1698         let frac_2_pi: f32 = consts::FRAC_2_PI;
1699         let frac_2_sqrtpi: f32 = consts::FRAC_2_SQRT_PI;
1700         let sqrt2: f32 = consts::SQRT_2;
1701         let frac_1_sqrt2: f32 = consts::FRAC_1_SQRT_2;
1702         let e: f32 = consts::E;
1703         let log2_e: f32 = consts::LOG2_E;
1704         let log10_e: f32 = consts::LOG10_E;
1705         let ln_2: f32 = consts::LN_2;
1706         let ln_10: f32 = consts::LN_10;
1707
1708         assert_approx_eq!(frac_pi_2, pi / 2f32);
1709         assert_approx_eq!(frac_pi_3, pi / 3f32);
1710         assert_approx_eq!(frac_pi_4, pi / 4f32);
1711         assert_approx_eq!(frac_pi_6, pi / 6f32);
1712         assert_approx_eq!(frac_pi_8, pi / 8f32);
1713         assert_approx_eq!(frac_1_pi, 1f32 / pi);
1714         assert_approx_eq!(frac_2_pi, 2f32 / pi);
1715         assert_approx_eq!(frac_2_sqrtpi, 2f32 / pi.sqrt());
1716         assert_approx_eq!(sqrt2, 2f32.sqrt());
1717         assert_approx_eq!(frac_1_sqrt2, 1f32 / 2f32.sqrt());
1718         assert_approx_eq!(log2_e, e.log2());
1719         assert_approx_eq!(log10_e, e.log10());
1720         assert_approx_eq!(ln_2, 2f32.ln());
1721         assert_approx_eq!(ln_10, 10f32.ln());
1722     }
1723
1724     #[test]
1725     fn test_float_bits_conv() {
1726         assert_eq!((1f32).to_bits(), 0x3f800000);
1727         assert_eq!((12.5f32).to_bits(), 0x41480000);
1728         assert_eq!((1337f32).to_bits(), 0x44a72000);
1729         assert_eq!((-14.25f32).to_bits(), 0xc1640000);
1730         assert_approx_eq!(f32::from_bits(0x3f800000), 1.0);
1731         assert_approx_eq!(f32::from_bits(0x41480000), 12.5);
1732         assert_approx_eq!(f32::from_bits(0x44a72000), 1337.0);
1733         assert_approx_eq!(f32::from_bits(0xc1640000), -14.25);
1734     }
1735     #[test]
1736     fn test_snan_masking() {
1737         let snan: u32 = 0x7F801337;
1738         const PAYLOAD_MASK: u32 = 0x003FFFFF;
1739         const QNAN_MASK: u32  = 0x00400000;
1740         let nan_masked_fl = f32::from_bits(snan);
1741         let nan_masked = nan_masked_fl.to_bits();
1742         // Ensure that signaling NaNs don't stay the same
1743         assert_ne!(nan_masked, snan);
1744         // Ensure that we have a quiet NaN
1745         assert_ne!(nan_masked & QNAN_MASK, 0);
1746         assert!(nan_masked_fl.is_nan());
1747         // Ensure the payload wasn't touched during conversion
1748         assert_eq!(nan_masked & PAYLOAD_MASK, snan & PAYLOAD_MASK);
1749     }
1750 }