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>2</sub>(10)
 132     #[unstable(feature = "extra_log_consts", issue = "50540")]
 133     pub const LOG2_10: f32 = 3.32192809488736234787031942948939018_f32;
 134
 135     /// log<sub>10</sub>(e)
 136     #[stable(feature = "rust1", since = "1.0.0")]
 137     pub const LOG10_E: f32 = 0.434294481903251827651128918916605082_f32;
 138
 139     /// log<sub>10</sub>(2)
 140     #[unstable(feature = "extra_log_consts", issue = "50540")]
 141     pub const LOG10_2: f32 = 0.301029995663981195213738894724493027_f32;
 142
 143     /// ln(2)
 144     #[stable(feature = "rust1", since = "1.0.0")]
 145     pub const LN_2: f32 = 0.693147180559945309417232121458176568_f32;
 146
 147     /// ln(10)
 148     #[stable(feature = "rust1", since = "1.0.0")]
 149     pub const LN_10: f32 = 2.30258509299404568401799145468436421_f32;
 150 }
 151
 152 #[unstable(feature = "core_float",
 153            reason = "stable interface is via `impl f{32,64}` in later crates",
 154            issue = "32110")]
 155 impl Float for f32 {
 156     type Bits = u32;
 157
 158     /// Returns `true` if the number is NaN.
 159     #[inline]
 160     fn is_nan(self) -> bool {
 161         self != self
 162     }
 163
 164     /// Returns `true` if the number is infinite.
 165     #[inline]
 166     fn is_infinite(self) -> bool {
 167         self == INFINITY || self == NEG_INFINITY
 168     }
 169
 170     /// Returns `true` if the number is neither infinite or NaN.
 171     #[inline]
 172     fn is_finite(self) -> bool {
 173         !(self.is_nan() || self.is_infinite())
 174     }
 175
 176     /// Returns `true` if the number is neither zero, infinite, subnormal or NaN.
 177     #[inline]
 178     fn is_normal(self) -> bool {
 179         self.classify() == Fp::Normal
 180     }
 181
 182     /// Returns the floating point category of the number. If only one property
 183     /// is going to be tested, it is generally faster to use the specific
 184     /// predicate instead.
 185     fn classify(self) -> Fp {
 186         const EXP_MASK: u32 = 0x7f800000;
 187         const MAN_MASK: u32 = 0x007fffff;
 188
 189         let bits = self.to_bits();
 190         match (bits & MAN_MASK, bits & EXP_MASK) {
 191             (0, 0) => Fp::Zero,
 192             (_, 0) => Fp::Subnormal,
 193             (0, EXP_MASK) => Fp::Infinite,
 194             (_, EXP_MASK) => Fp::Nan,
 195             _ => Fp::Normal,
 196         }
 197     }
 198
 199     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 200     /// positive sign bit and positive infinity.
 201     #[inline]
 202     fn is_sign_positive(self) -> bool {
 203         !self.is_sign_negative()
 204     }
 205
 206     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 207     /// negative sign bit and negative infinity.
 208     #[inline]
 209     fn is_sign_negative(self) -> bool {
 210         // IEEE754 says: isSignMinus(x) is true if and only if x has negative sign. isSignMinus
 211         // applies to zeros and NaNs as well.
 212         self.to_bits() & 0x8000_0000 != 0
 213     }
 214
 215     /// Returns the reciprocal (multiplicative inverse) of the number.
 216     #[inline]
 217     fn recip(self) -> f32 {
 218         1.0 / self
 219     }
 220
 221     /// Converts to degrees, assuming the number is in radians.
 222     #[inline]
 223     fn to_degrees(self) -> f32 {
 224         // Use a constant for better precision.
 225         const PIS_IN_180: f32 = 57.2957795130823208767981548141051703_f32;
 226         self * PIS_IN_180
 227     }
 228
 229     /// Converts to radians, assuming the number is in degrees.
 230     #[inline]
 231     fn to_radians(self) -> f32 {
 232         let value: f32 = consts::PI;
 233         self * (value / 180.0f32)
 234     }
 235
 236     /// Returns the maximum of the two numbers.
 237     #[inline]
 238     fn max(self, other: f32) -> f32 {
 239         // IEEE754 says: maxNum(x, y) is the canonicalized number y if x < y, x if y < x, the
 240         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 241         // is either x or y, canonicalized (this means results might differ among implementations).
 242         // When either x or y is a signalingNaN, then the result is according to 6.2.
 243         //
 244         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 245         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 246         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 247         (if self.is_nan() || self < other { other } else { self }) * 1.0
 248     }
 249
 250     /// Returns the minimum of the two numbers.
 251     #[inline]
 252     fn min(self, other: f32) -> f32 {
 253         // IEEE754 says: minNum(x, y) is the canonicalized number x if x < y, y if y < x, the
 254         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 255         // is either x or y, canonicalized (this means results might differ among implementations).
 256         // When either x or y is a signalingNaN, then the result is according to 6.2.
 257         //
 258         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 259         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 260         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 261         (if other.is_nan() || self < other { self } else { other }) * 1.0
 262     }
 263
 264     /// Raw transmutation to `u32`.
 265     #[inline]
 266     fn to_bits(self) -> u32 {
 267         unsafe { mem::transmute(self) }
 268     }
 269
 270     /// Raw transmutation from `u32`.
 271     #[inline]
 272     fn from_bits(v: u32) -> Self {
 273         // It turns out the safety issues with sNaN were overblown! Hooray!
 274         unsafe { mem::transmute(v) }
 275     }
 276 }
 277
 278 // FIXME: remove (inline) this macro and the Float trait
 279 // when updating to a bootstrap compiler that has the new lang items.
 280 #[cfg_attr(stage0, macro_export)]
 281 #[unstable(feature = "core_float", issue = "32110")]
 282 macro_rules! f32_core_methods { () => {
 283     /// Returns `true` if this value is `NaN` and false otherwise.
 284     ///
 285     /// ```
 286     /// use std::f32;
 287     ///
 288     /// let nan = f32::NAN;
 289     /// let f = 7.0_f32;
 290     ///
 291     /// assert!(nan.is_nan());
 292     /// assert!(!f.is_nan());
 293     /// ```
 294     #[stable(feature = "rust1", since = "1.0.0")]
 295     #[inline]
 296     pub fn is_nan(self) -> bool { Float::is_nan(self) }
 297
 298     /// Returns `true` if this value is positive infinity or negative infinity and
 299     /// false otherwise.
 300     ///
 301     /// ```
 302     /// use std::f32;
 303     ///
 304     /// let f = 7.0f32;
 305     /// let inf = f32::INFINITY;
 306     /// let neg_inf = f32::NEG_INFINITY;
 307     /// let nan = f32::NAN;
 308     ///
 309     /// assert!(!f.is_infinite());
 310     /// assert!(!nan.is_infinite());
 311     ///
 312     /// assert!(inf.is_infinite());
 313     /// assert!(neg_inf.is_infinite());
 314     /// ```
 315     #[stable(feature = "rust1", since = "1.0.0")]
 316     #[inline]
 317     pub fn is_infinite(self) -> bool { Float::is_infinite(self) }
 318
 319     /// Returns `true` if this number is neither infinite nor `NaN`.
 320     ///
 321     /// ```
 322     /// use std::f32;
 323     ///
 324     /// let f = 7.0f32;
 325     /// let inf = f32::INFINITY;
 326     /// let neg_inf = f32::NEG_INFINITY;
 327     /// let nan = f32::NAN;
 328     ///
 329     /// assert!(f.is_finite());
 330     ///
 331     /// assert!(!nan.is_finite());
 332     /// assert!(!inf.is_finite());
 333     /// assert!(!neg_inf.is_finite());
 334     /// ```
 335     #[stable(feature = "rust1", since = "1.0.0")]
 336     #[inline]
 337     pub fn is_finite(self) -> bool { Float::is_finite(self) }
 338
 339     /// Returns `true` if the number is neither zero, infinite,
 340     /// [subnormal][subnormal], or `NaN`.
 341     ///
 342     /// ```
 343     /// use std::f32;
 344     ///
 345     /// let min = f32::MIN_POSITIVE; // 1.17549435e-38f32
 346     /// let max = f32::MAX;
 347     /// let lower_than_min = 1.0e-40_f32;
 348     /// let zero = 0.0_f32;
 349     ///
 350     /// assert!(min.is_normal());
 351     /// assert!(max.is_normal());
 352     ///
 353     /// assert!(!zero.is_normal());
 354     /// assert!(!f32::NAN.is_normal());
 355     /// assert!(!f32::INFINITY.is_normal());
 356     /// // Values between `0` and `min` are Subnormal.
 357     /// assert!(!lower_than_min.is_normal());
 358     /// ```
 359     /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
 360     #[stable(feature = "rust1", since = "1.0.0")]
 361     #[inline]
 362     pub fn is_normal(self) -> bool { Float::is_normal(self) }
 363
 364     /// Returns the floating point category of the number. If only one property
 365     /// is going to be tested, it is generally faster to use the specific
 366     /// predicate instead.
 367     ///
 368     /// ```
 369     /// use std::num::FpCategory;
 370     /// use std::f32;
 371     ///
 372     /// let num = 12.4_f32;
 373     /// let inf = f32::INFINITY;
 374     ///
 375     /// assert_eq!(num.classify(), FpCategory::Normal);
 376     /// assert_eq!(inf.classify(), FpCategory::Infinite);
 377     /// ```
 378     #[stable(feature = "rust1", since = "1.0.0")]
 379     #[inline]
 380     pub fn classify(self) -> FpCategory { Float::classify(self) }
 381
 382     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 383     /// positive sign bit and positive infinity.
 384     ///
 385     /// ```
 386     /// let f = 7.0_f32;
 387     /// let g = -7.0_f32;
 388     ///
 389     /// assert!(f.is_sign_positive());
 390     /// assert!(!g.is_sign_positive());
 391     /// ```
 392     #[stable(feature = "rust1", since = "1.0.0")]
 393     #[inline]
 394     pub fn is_sign_positive(self) -> bool { Float::is_sign_positive(self) }
 395
 396     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 397     /// negative sign bit and negative infinity.
 398     ///
 399     /// ```
 400     /// let f = 7.0f32;
 401     /// let g = -7.0f32;
 402     ///
 403     /// assert!(!f.is_sign_negative());
 404     /// assert!(g.is_sign_negative());
 405     /// ```
 406     #[stable(feature = "rust1", since = "1.0.0")]
 407     #[inline]
 408     pub fn is_sign_negative(self) -> bool { Float::is_sign_negative(self) }
 409
 410     /// Takes the reciprocal (inverse) of a number, `1/x`.
 411     ///
 412     /// ```
 413     /// use std::f32;
 414     ///
 415     /// let x = 2.0_f32;
 416     /// let abs_difference = (x.recip() - (1.0/x)).abs();
 417     ///
 418     /// assert!(abs_difference <= f32::EPSILON);
 419     /// ```
 420     #[stable(feature = "rust1", since = "1.0.0")]
 421     #[inline]
 422     pub fn recip(self) -> f32 { Float::recip(self) }
 423
 424     /// Converts radians to degrees.
 425     ///
 426     /// ```
 427     /// use std::f32::{self, consts};
 428     ///
 429     /// let angle = consts::PI;
 430     ///
 431     /// let abs_difference = (angle.to_degrees() - 180.0).abs();
 432     ///
 433     /// assert!(abs_difference <= f32::EPSILON);
 434     /// ```
 435     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 436     #[inline]
 437     pub fn to_degrees(self) -> f32 { Float::to_degrees(self) }
 438
 439     /// Converts degrees to radians.
 440     ///
 441     /// ```
 442     /// use std::f32::{self, consts};
 443     ///
 444     /// let angle = 180.0f32;
 445     ///
 446     /// let abs_difference = (angle.to_radians() - consts::PI).abs();
 447     ///
 448     /// assert!(abs_difference <= f32::EPSILON);
 449     /// ```
 450     #[stable(feature = "f32_deg_rad_conversions", since="1.7.0")]
 451     #[inline]
 452     pub fn to_radians(self) -> f32 { Float::to_radians(self) }
 453
 454     /// Returns the maximum of the two numbers.
 455     ///
 456     /// ```
 457     /// let x = 1.0f32;
 458     /// let y = 2.0f32;
 459     ///
 460     /// assert_eq!(x.max(y), y);
 461     /// ```
 462     ///
 463     /// If one of the arguments is NaN, then the other argument is returned.
 464     #[stable(feature = "rust1", since = "1.0.0")]
 465     #[inline]
 466     pub fn max(self, other: f32) -> f32 {
 467         Float::max(self, other)
 468     }
 469
 470     /// Returns the minimum of the two numbers.
 471     ///
 472     /// ```
 473     /// let x = 1.0f32;
 474     /// let y = 2.0f32;
 475     ///
 476     /// assert_eq!(x.min(y), x);
 477     /// ```
 478     ///
 479     /// If one of the arguments is NaN, then the other argument is returned.
 480     #[stable(feature = "rust1", since = "1.0.0")]
 481     #[inline]
 482     pub fn min(self, other: f32) -> f32 {
 483         Float::min(self, other)
 484     }
 485
 486     /// Raw transmutation to `u32`.
 487     ///
 488     /// This is currently identical to `transmute::<f32, u32>(self)` on all platforms.
 489     ///
 490     /// See `from_bits` for some discussion of the portability of this operation
 491     /// (there are almost no issues).
 492     ///
 493     /// Note that this function is distinct from `as` casting, which attempts to
 494     /// preserve the *numeric* value, and not the bitwise value.
 495     ///
 496     /// # Examples
 497     ///
 498     /// ```
 499     /// assert_ne!((1f32).to_bits(), 1f32 as u32); // to_bits() is not casting!
 500     /// assert_eq!((12.5f32).to_bits(), 0x41480000);
 501     ///
 502     /// ```
 503     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 504     #[inline]
 505     pub fn to_bits(self) -> u32 {
 506         Float::to_bits(self)
 507     }
 508
 509     /// Raw transmutation from `u32`.
 510     ///
 511     /// This is currently identical to `transmute::<u32, f32>(v)` on all platforms.
 512     /// It turns out this is incredibly portable, for two reasons:
 513     ///
 514     /// * Floats and Ints have the same endianness on all supported platforms.
 515     /// * IEEE-754 very precisely specifies the bit layout of floats.
 516     ///
 517     /// However there is one caveat: prior to the 2008 version of IEEE-754, how
 518     /// to interpret the NaN signaling bit wasn't actually specified. Most platforms
 519     /// (notably x86 and ARM) picked the interpretation that was ultimately
 520     /// standardized in 2008, but some didn't (notably MIPS). As a result, all
 521     /// signaling NaNs on MIPS are quiet NaNs on x86, and vice-versa.
 522     ///
 523     /// Rather than trying to preserve signaling-ness cross-platform, this
 524     /// implementation favours preserving the exact bits. This means that
 525     /// any payloads encoded in NaNs will be preserved even if the result of
 526     /// this method is sent over the network from an x86 machine to a MIPS one.
 527     ///
 528     /// If the results of this method are only manipulated by the same
 529     /// architecture that produced them, then there is no portability concern.
 530     ///
 531     /// If the input isn't NaN, then there is no portability concern.
 532     ///
 533     /// If you don't care about signalingness (very likely), then there is no
 534     /// portability concern.
 535     ///
 536     /// Note that this function is distinct from `as` casting, which attempts to
 537     /// preserve the *numeric* value, and not the bitwise value.
 538     ///
 539     /// # Examples
 540     ///
 541     /// ```
 542     /// use std::f32;
 543     /// let v = f32::from_bits(0x41480000);
 544     /// let difference = (v - 12.5).abs();
 545     /// assert!(difference <= 1e-5);
 546     /// ```
 547     #[stable(feature = "float_bits_conv", since = "1.20.0")]
 548     #[inline]
 549     pub fn from_bits(v: u32) -> Self {
 550         Float::from_bits(v)
 551     }
 552 }}
 553
 554 #[lang = "f32"]
 555 #[cfg(not(test))]
 556 #[cfg(not(stage0))]
 557 impl f32 {
 558     f32_core_methods!();
 559 }