src/libcore/num/f32.rs

   1 // Copyright 2012-2014 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.
  13 //!
  14 //! Mathematically significant numbers are provided in the `consts` sub-module.
  15 //!
  16 //! *[See also the `f32` primitive type](../../std/primitive.f32.html).*
  17
  18 #![stable(feature = "rust1", since = "1.0.0")]
  19
  20 use mem;
  21 use num::Float;
  22 #[cfg(not(stage0))] use num::FpCategory;
  23 use num::FpCategory as Fp;
  24
  25 /// The radix or base of the internal representation of `f32`.
  26 #[stable(feature = "rust1", since = "1.0.0")]
  27 pub const RADIX: u32 = 2;
  28
  29 /// Number of significant digits in base 2.
  30 #[stable(feature = "rust1", since = "1.0.0")]
  31 pub const MANTISSA_DIGITS: u32 = 24;
  32 /// Approximate number of significant digits in base 10.
  33 #[stable(feature = "rust1", since = "1.0.0")]
  34 pub const DIGITS: u32 = 6;
  35
  36 /// Difference between `1.0` and the next largest representable number.
  37 #[stable(feature = "rust1", since = "1.0.0")]
  38 pub const EPSILON: f32 = 1.19209290e-07_f32;
  39
  40 /// Smallest finite `f32` value.
  41 #[stable(feature = "rust1", since = "1.0.0")]
  42 pub const MIN: f32 = -3.40282347e+38_f32;
  43 /// Smallest positive normal `f32` value.
  44 #[stable(feature = "rust1", since = "1.0.0")]
  45 pub const MIN_POSITIVE: f32 = 1.17549435e-38_f32;
  46 /// Largest finite `f32` value.
  47 #[stable(feature = "rust1", since = "1.0.0")]
  48 pub const MAX: f32 = 3.40282347e+38_f32;
  49
  50 /// One greater than the minimum possible normal power of 2 exponent.
  51 #[stable(feature = "rust1", since = "1.0.0")]
  52 pub const MIN_EXP: i32 = -125;
  53 /// Maximum possible power of 2 exponent.
  54 #[stable(feature = "rust1", since = "1.0.0")]
  55 pub const MAX_EXP: i32 = 128;
  56
  57 /// Minimum possible normal power of 10 exponent.
  58 #[stable(feature = "rust1", since = "1.0.0")]
  59 pub const MIN_10_EXP: i32 = -37;
  60 /// Maximum possible power of 10 exponent.
  61 #[stable(feature = "rust1", since = "1.0.0")]
  62 pub const MAX_10_EXP: i32 = 38;
  63
  64 /// Not a Number (NaN).
  65 #[stable(feature = "rust1", since = "1.0.0")]
  66 pub const NAN: f32 = 0.0_f32 / 0.0_f32;
  67 /// Infinity (∞).
  68 #[stable(feature = "rust1", since = "1.0.0")]
  69 pub const INFINITY: f32 = 1.0_f32 / 0.0_f32;
  70 /// Negative infinity (-∞).
  71 #[stable(feature = "rust1", since = "1.0.0")]
  72 pub const NEG_INFINITY: f32 = -1.0_f32 / 0.0_f32;
  73
  74 /// Basic mathematical constants.
  75 #[stable(feature = "rust1", since = "1.0.0")]
  76 pub mod consts {
  77     // FIXME: replace with mathematical constants from cmath.
  78
  79     /// Archimedes' constant (π)
  80     #[stable(feature = "rust1", since = "1.0.0")]
  81     pub const PI: f32 = 3.14159265358979323846264338327950288_f32;
  82
  83     /// π/2
  84     #[stable(feature = "rust1", since = "1.0.0")]
  85     pub const FRAC_PI_2: f32 = 1.57079632679489661923132169163975144_f32;
  86
  87     /// π/3
  88     #[stable(feature = "rust1", since = "1.0.0")]
  89     pub const FRAC_PI_3: f32 = 1.04719755119659774615421446109316763_f32;
  90
  91     /// π/4
  92     #[stable(feature = "rust1", since = "1.0.0")]
  93     pub const FRAC_PI_4: f32 = 0.785398163397448309615660845819875721_f32;
  94
  95     /// π/6
  96     #[stable(feature = "rust1", since = "1.0.0")]
  97     pub const FRAC_PI_6: f32 = 0.52359877559829887307710723054658381_f32;
  98
  99     /// π/8
 100     #[stable(feature = "rust1", since = "1.0.0")]
 101     pub const FRAC_PI_8: f32 = 0.39269908169872415480783042290993786_f32;
 102
 103     /// 1/π
 104     #[stable(feature = "rust1", since = "1.0.0")]
 105     pub const FRAC_1_PI: f32 = 0.318309886183790671537767526745028724_f32;
 106
 107     /// 2/π
 108     #[stable(feature = "rust1", since = "1.0.0")]
 109     pub const FRAC_2_PI: f32 = 0.636619772367581343075535053490057448_f32;
 110
 111     /// 2/sqrt(π)
 112     #[stable(feature = "rust1", since = "1.0.0")]
 113     pub const FRAC_2_SQRT_PI: f32 = 1.12837916709551257389615890312154517_f32;
 114
 115     /// sqrt(2)
 116     #[stable(feature = "rust1", since = "1.0.0")]
 117     pub const SQRT_2: f32 = 1.41421356237309504880168872420969808_f32;
 118
 119     /// 1/sqrt(2)
 120     #[stable(feature = "rust1", since = "1.0.0")]
 121     pub const FRAC_1_SQRT_2: f32 = 0.707106781186547524400844362104849039_f32;
 122
 123     /// Euler's number (e)
 124     #[stable(feature = "rust1", since = "1.0.0")]
 125     pub const E: f32 = 2.71828182845904523536028747135266250_f32;
 126
 127     /// log<sub>2</sub>(e)
 128     #[stable(feature = "rust1", since = "1.0.0")]
 129     pub const LOG2_E: f32 = 1.44269504088896340735992468100189214_f32;
 130
 131     /// log<sub>10</sub>(e)
 132     #[stable(feature = "rust1", since = "1.0.0")]
 133     pub const LOG10_E: f32 = 0.434294481903251827651128918916605082_f32;
 134
 135     /// ln(2)
 136     #[stable(feature = "rust1", since = "1.0.0")]
 137     pub const LN_2: f32 = 0.693147180559945309417232121458176568_f32;
 138
 139     /// ln(10)
 140     #[stable(feature = "rust1", since = "1.0.0")]
 141     pub const LN_10: f32 = 2.30258509299404568401799145468436421_f32;
 142 }
 143
 144 #[unstable(feature = "core_float",
 145            reason = "stable interface is via `impl f{32,64}` in later crates",
 146            issue = "32110")]
 147 impl Float for f32 {
 148     type Bits = u32;
 149
 150     /// Returns `true` if the number is NaN.
 151     #[inline]
 152     fn is_nan(self) -> bool {
 153         self != self
 154     }
 155
 156     /// Returns `true` if the number is infinite.
 157     #[inline]
 158     fn is_infinite(self) -> bool {
 159         self == INFINITY || self == NEG_INFINITY
 160     }
 161
 162     /// Returns `true` if the number is neither infinite or NaN.
 163     #[inline]
 164     fn is_finite(self) -> bool {
 165         !(self.is_nan() || self.is_infinite())
 166     }
 167
 168     /// Returns `true` if the number is neither zero, infinite, subnormal or NaN.
 169     #[inline]
 170     fn is_normal(self) -> bool {
 171         self.classify() == Fp::Normal
 172     }
 173
 174     /// Returns the floating point category of the number. If only one property
 175     /// is going to be tested, it is generally faster to use the specific
 176     /// predicate instead.
 177     fn classify(self) -> Fp {
 178         const EXP_MASK: u32 = 0x7f800000;
 179         const MAN_MASK: u32 = 0x007fffff;
 180
 181         let bits = self.to_bits();
 182         match (bits & MAN_MASK, bits & EXP_MASK) {
 183             (0, 0) => Fp::Zero,
 184             (_, 0) => Fp::Subnormal,
 185             (0, EXP_MASK) => Fp::Infinite,
 186             (_, EXP_MASK) => Fp::Nan,
 187             _ => Fp::Normal,
 188         }
 189     }
 190
 191     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 192     /// positive sign bit and positive infinity.
 193     #[inline]
 194     fn is_sign_positive(self) -> bool {
 195         !self.is_sign_negative()
 196     }
 197
 198     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 199     /// negative sign bit and negative infinity.
 200     #[inline]
 201     fn is_sign_negative(self) -> bool {
 202         // IEEE754 says: isSignMinus(x) is true if and only if x has negative sign. isSignMinus
 203         // applies to zeros and NaNs as well.
 204         self.to_bits() & 0x8000_0000 != 0
 205     }
 206
 207     /// Returns the reciprocal (multiplicative inverse) of the number.
 208     #[inline]
 209     fn recip(self) -> f32 {
 210         1.0 / self
 211     }
 212
 213     /// Converts to degrees, assuming the number is in radians.
 214     #[inline]
 215     fn to_degrees(self) -> f32 {
 216         // Use a constant for better precision.
 217         const PIS_IN_180: f32 = 57.2957795130823208767981548141051703_f32;
 218         self * PIS_IN_180
 219     }
 220
 221     /// Converts to radians, assuming the number is in degrees.
 222     #[inline]
 223     fn to_radians(self) -> f32 {
 224         let value: f32 = consts::PI;
 225         self * (value / 180.0f32)
 226     }
 227
 228     /// Returns the maximum of the two numbers.
 229     #[inline]
 230     fn max(self, other: f32) -> f32 {
 231         // IEEE754 says: maxNum(x, y) is the canonicalized number y if x < y, x if y < x, the
 232         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 233         // is either x or y, canonicalized (this means results might differ among implementations).
 234         // When either x or y is a signalingNaN, then the result is according to 6.2.
 235         //
 236         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 237         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 238         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 239         (if self.is_nan() || self < other { other } else { self }) * 1.0
 240     }
 241
 242     /// Returns the minimum of the two numbers.
 243     #[inline]
 244     fn min(self, other: f32) -> f32 {
 245         // IEEE754 says: minNum(x, y) is the canonicalized number x if x < y, y if y < x, the
 246         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 247         // is either x or y, canonicalized (this means results might differ among implementations).
 248         // When either x or y is a signalingNaN, then the result is according to 6.2.
 249         //
 250         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 251         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 252         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 253         (if other.is_nan() || self < other { self } else { other }) * 1.0
 254     }
 255
 256     /// Raw transmutation to `u32`.
 257     #[inline]
 258     fn to_bits(self) -> u32 {
 259         unsafe { mem::transmute(self) }
 260     }
 261
 262     /// Raw transmutation from `u32`.
 263     #[inline]
 264     fn from_bits(v: u32) -> Self {
 265         // It turns out the safety issues with sNaN were overblown! Hooray!
 266         unsafe { mem::transmute(v) }
 267     }
 268 }
 269
 270 // FIXME: remove (inline) this macro and the Float trait
 271 // when updating to a bootstrap compiler that has the new lang items.
 272 #[cfg_attr(stage0, macro_export)]
 273 #[unstable(feature = "core_float", issue = "32110")]
 274 macro_rules! f32_core_methods { () => {
 275     /// Returns `true` if this value is `NaN` and false otherwise.
 276     ///
 277     /// ```
 278     /// use std::f32;
 279     ///
 280     /// let nan = f32::NAN;
 281     /// let f = 7.0_f32;
 282     ///
 283     /// assert!(nan.is_nan());
 284     /// assert!(!f.is_nan());
 285     /// ```
 286     #[stable(feature = "rust1", since = "1.0.0")]
 287     #[inline]
 288     pub fn is_nan(self) -> bool { Float::is_nan(self) }
 289
 290     /// Returns `true` if this value is positive infinity or negative infinity and
 291     /// false otherwise.
 292     ///
 293     /// ```
 294     /// use std::f32;
 295     ///
 296     /// let f = 7.0f32;
 297     /// let inf = f32::INFINITY;
 298     /// let neg_inf = f32::NEG_INFINITY;
 299     /// let nan = f32::NAN;
 300     ///
 301     /// assert!(!f.is_infinite());
 302     /// assert!(!nan.is_infinite());
 303     ///
 304     /// assert!(inf.is_infinite());
 305     /// assert!(neg_inf.is_infinite());
 306     /// ```
 307     #[stable(feature = "rust1", since = "1.0.0")]
 308     #[inline]
 309     pub fn is_infinite(self) -> bool { Float::is_infinite(self) }
 310
 311     /// Returns `true` if this number is neither infinite nor `NaN`.
 312     ///
 313     /// ```
 314     /// use std::f32;
 315     ///
 316     /// let f = 7.0f32;
 317     /// let inf = f32::INFINITY;
 318     /// let neg_inf = f32::NEG_INFINITY;
 319     /// let nan = f32::NAN;
 320     ///
 321     /// assert!(f.is_finite());
 322     ///
 323     /// assert!(!nan.is_finite());
 324     /// assert!(!inf.is_finite());
 325     /// assert!(!neg_inf.is_finite());
 326     /// ```
 327     #[stable(feature = "rust1", since = "1.0.0")]
 328     #[inline]
 329     pub fn is_finite(self) -> bool { Float::is_finite(self) }
 330
 331     /// Returns `true` if the number is neither zero, infinite,
 332     /// [subnormal][subnormal], or `NaN`.
 333     ///
 334     /// ```
 335     /// use std::f32;
 336     ///
 337     /// let min = f32::MIN_POSITIVE; // 1.17549435e-38f32
 338     /// let max = f32::MAX;
 339     /// let lower_than_min = 1.0e-40_f32;
 340     /// let zero = 0.0_f32;
 341     ///
 342     /// assert!(min.is_normal());
 343     /// assert!(max.is_normal());
 344     ///
 345     /// assert!(!zero.is_normal());
 346     /// assert!(!f32::NAN.is_normal());
 347     /// assert!(!f32::INFINITY.is_normal());
 348     /// // Values between `0` and `min` are Subnormal.
 349     /// assert!(!lower_than_min.is_normal());
 350     /// ```
 351     /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
 352     #[stable(feature = "rust1", since = "1.0.0")]
 353     #[inline]
 354     pub fn is_normal(self) -> bool { Float::is_normal(self) }
 355
 356     /// Returns the floating point category of the number. If only one property
 357     /// is going to be tested, it is generally faster to use the specific
 358     /// predicate instead.
 359     ///
 360     /// ```
 361     /// use std::num::FpCategory;
 362     /// use std::f32;
 363     ///
 364     /// let num = 12.4_f32;
 365     /// let inf = f32::INFINITY;
 366     ///
 367     /// assert_eq!(num.classify(), FpCategory::Normal);
 368     /// assert_eq!(inf.classify(), FpCategory::Infinite);
 369     /// ```
 370     #[stable(feature = "rust1", since = "1.0.0")]
 371     #[inline]
 372     pub fn classify(self) -> FpCategory { Float::classify(self) }
 373
 374     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 375     /// positive sign bit and positive infinity.
 376     ///
 377     /// ```
 378     /// let f = 7.0_f32;
 379     /// let g = -7.0_f32;
 380     ///
 381     /// assert!(f.is_sign_positive());
 382     /// assert!(!g.is_sign_positive());
 383     /// ```
 384     #[stable(feature = "rust1", since = "1.0.0")]
 385     #[inline]
 386     pub fn is_sign_positive(self) -> bool { Float::is_sign_positive(self) }
 387
 388     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 389     /// negative sign bit and negative infinity.
 390     ///
 391     /// ```
 392     /// let f = 7.0f32;
 393     /// let g = -7.0f32;
 394     ///
 395     /// assert!(!f.is_sign_negative());
 396     /// assert!(g.is_sign_negative());
 397     /// ```
 398     #[stable(feature = "rust1", since = "1.0.0")]
 399     #[inline]
 400     pub fn is_sign_negative(self) -> bool { Float::is_sign_negative(self) }
 401
 402     /// Takes the reciprocal (inverse) of a number, `1/x`.
 403     ///
 404     /// ```
 405     /// use std::f32;
 406     ///
 407     /// let x = 2.0_f32;
 408     /// let abs_difference = (x.recip() - (1.0/x)).abs();
 409     ///
 410     /// assert!(abs_difference <= f32::EPSILON);
 411     /// ```
 412     #[stable(feature = "rust1", since = "1.0.0")]
 413     #[inline]
 414     pub fn recip(self) -> f32 { Float::recip(self) }
 415
 416     /// Converts radians to degrees.
 417     ///
 418     /// ```
 419     /// use std::f32::{self, consts};
 420     ///
 421     /// let angle = consts::PI;
 422     ///
 423     /// let abs_difference = (angle.to_degrees() - 180.0).abs();
 424     ///
 425     /// assert!(abs_difference <= f32::EPSILON);
 426     /// ```
 427     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 428     #[inline]
 429     pub fn to_degrees(self) -> f32 { Float::to_degrees(self) }
 430
 431     /// Converts degrees to radians.
 432     ///
 433     /// ```
 434     /// use std::f32::{self, consts};
 435     ///
 436     /// let angle = 180.0f32;
 437     ///
 438     /// let abs_difference = (angle.to_radians() - consts::PI).abs();
 439     ///
 440     /// assert!(abs_difference <= f32::EPSILON);
 441     /// ```
 442     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 443     #[inline]
 444     pub fn to_radians(self) -> f32 { Float::to_radians(self) }
 445
 446     /// Returns the maximum of the two numbers.
 447     ///
 448     /// ```
 449     /// let x = 1.0f32;
 450     /// let y = 2.0f32;
 451     ///
 452     /// assert_eq!(x.max(y), y);
 453     /// ```
 454     ///
 455     /// If one of the arguments is NaN, then the other argument is returned.
 456     #[stable(feature = "rust1", since = "1.0.0")]
 457     #[inline]
 458     pub fn max(self, other: f32) -> f32 {
 459         Float::max(self, other)
 460     }
 461
 462     /// Returns the minimum of the two numbers.
 463     ///
 464     /// ```
 465     /// let x = 1.0f32;
 466     /// let y = 2.0f32;
 467     ///
 468     /// assert_eq!(x.min(y), x);
 469     /// ```
 470     ///
 471     /// If one of the arguments is NaN, then the other argument is returned.
 472     #[stable(feature = "rust1", since = "1.0.0")]
 473     #[inline]
 474     pub fn min(self, other: f32) -> f32 {
 475         Float::min(self, other)
 476     }
 477
 478     /// Raw transmutation to `u32`.
 479     ///
 480     /// This is currently identical to `transmute::<f32, u32>(self)` on all platforms.
 481     ///
 482     /// See `from_bits` for some discussion of the portability of this operation
 483     /// (there are almost no issues).
 484     ///
 485     /// Note that this function is distinct from `as` casting, which attempts to
 486     /// preserve the *numeric* value, and not the bitwise value.
 487     ///
 488     /// # Examples
 489     ///
 490     /// ```
 491     /// assert_ne!((1f32).to_bits(), 1f32 as u32); // to_bits() is not casting!
 492     /// assert_eq!((12.5f32).to_bits(), 0x41480000);
 493     ///
 494     /// ```
 495     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 496     #[inline]
 497     pub fn to_bits(self) -> u32 {
 498         Float::to_bits(self)
 499     }
 500
 501     /// Raw transmutation from `u32`.
 502     ///
 503     /// This is currently identical to `transmute::<u32, f32>(v)` on all platforms.
 504     /// It turns out this is incredibly portable, for two reasons:
 505     ///
 506     /// * Floats and Ints have the same endianness on all supported platforms.
 507     /// * IEEE-754 very precisely specifies the bit layout of floats.
 508     ///
 509     /// However there is one caveat: prior to the 2008 version of IEEE-754, how
 510     /// to interpret the NaN signaling bit wasn't actually specified. Most platforms
 511     /// (notably x86 and ARM) picked the interpretation that was ultimately
 512     /// standardized in 2008, but some didn't (notably MIPS). As a result, all
 513     /// signaling NaNs on MIPS are quiet NaNs on x86, and vice-versa.
 514     ///
 515     /// Rather than trying to preserve signaling-ness cross-platform, this
 516     /// implementation favours preserving the exact bits. This means that
 517     /// any payloads encoded in NaNs will be preserved even if the result of
 518     /// this method is sent over the network from an x86 machine to a MIPS one.
 519     ///
 520     /// If the results of this method are only manipulated by the same
 521     /// architecture that produced them, then there is no portability concern.
 522     ///
 523     /// If the input isn't NaN, then there is no portability concern.
 524     ///
 525     /// If you don't care about signalingness (very likely), then there is no
 526     /// portability concern.
 527     ///
 528     /// Note that this function is distinct from `as` casting, which attempts to
 529     /// preserve the *numeric* value, and not the bitwise value.
 530     ///
 531     /// # Examples
 532     ///
 533     /// ```
 534     /// use std::f32;
 535     /// let v = f32::from_bits(0x41480000);
 536     /// let difference = (v - 12.5).abs();
 537     /// assert!(difference <= 1e-5);
 538     /// ```
 539     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 540     #[inline]
 541     pub fn from_bits(v: u32) -> Self {
 542         Float::from_bits(v)
 543     }
 544 }}
 545
 546 #[lang = "f32"]
 547 #[cfg(not(test))]
 548 #[cfg(not(stage0))]
 549 impl f32 {
 550     f32_core_methods!();
 551 }