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