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 intrinsics;
  21 use mem;
  22 use num::Float;
  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     /// Computes the absolute value of `self`. Returns `Float::nan()` if the
 192     /// number is `Float::nan()`.
 193     #[inline]
 194     fn abs(self) -> f32 {
 195         unsafe { intrinsics::fabsf32(self) }
 196     }
 197
 198     /// Returns a number that represents the sign of `self`.
 199     ///
 200     /// - `1.0` if the number is positive, `+0.0` or `Float::infinity()`
 201     /// - `-1.0` if the number is negative, `-0.0` or `Float::neg_infinity()`
 202     /// - `Float::nan()` if the number is `Float::nan()`
 203     #[inline]
 204     fn signum(self) -> f32 {
 205         if self.is_nan() {
 206             NAN
 207         } else {
 208             unsafe { intrinsics::copysignf32(1.0, self) }
 209         }
 210     }
 211
 212     /// Returns `true` if and only if `self` has a positive sign, including `+0.0`, `NaN`s with
 213     /// positive sign bit and positive infinity.
 214     #[inline]
 215     fn is_sign_positive(self) -> bool {
 216         !self.is_sign_negative()
 217     }
 218
 219     /// Returns `true` if and only if `self` has a negative sign, including `-0.0`, `NaN`s with
 220     /// negative sign bit and negative infinity.
 221     #[inline]
 222     fn is_sign_negative(self) -> bool {
 223         // IEEE754 says: isSignMinus(x) is true if and only if x has negative sign. isSignMinus
 224         // applies to zeros and NaNs as well.
 225         self.to_bits() & 0x8000_0000 != 0
 226     }
 227
 228     /// Returns the reciprocal (multiplicative inverse) of the number.
 229     #[inline]
 230     fn recip(self) -> f32 {
 231         1.0 / self
 232     }
 233
 234     #[inline]
 235     fn powi(self, n: i32) -> f32 {
 236         unsafe { intrinsics::powif32(self, n) }
 237     }
 238
 239     /// Converts to degrees, assuming the number is in radians.
 240     #[inline]
 241     fn to_degrees(self) -> f32 {
 242         self * (180.0f32 / consts::PI)
 243     }
 244
 245     /// Converts to radians, assuming the number is in degrees.
 246     #[inline]
 247     fn to_radians(self) -> f32 {
 248         let value: f32 = consts::PI;
 249         self * (value / 180.0f32)
 250     }
 251
 252     /// Returns the maximum of the two numbers.
 253     #[inline]
 254     fn max(self, other: f32) -> f32 {
 255         // IEEE754 says: maxNum(x, y) is the canonicalized number y if x < y, x if y < x, the
 256         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 257         // is either x or y, canonicalized (this means results might differ among implementations).
 258         // When either x or y is a signalingNaN, then the result is according to 6.2.
 259         //
 260         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 261         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 262         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 263         (if self.is_nan() || self < other { other } else { self }) * 1.0
 264     }
 265
 266     /// Returns the minimum of the two numbers.
 267     #[inline]
 268     fn min(self, other: f32) -> f32 {
 269         // IEEE754 says: minNum(x, y) is the canonicalized number x if x < y, y if y < x, the
 270         // canonicalized number if one operand is a number and the other a quiet NaN. Otherwise it
 271         // is either x or y, canonicalized (this means results might differ among implementations).
 272         // When either x or y is a signalingNaN, then the result is according to 6.2.
 273         //
 274         // Since we do not support sNaN in Rust yet, we do not need to handle them.
 275         // FIXME(nagisa): due to https://bugs.llvm.org/show_bug.cgi?id=33303 we canonicalize by
 276         // multiplying by 1.0. Should switch to the `canonicalize` when it works.
 277         (if other.is_nan() || self < other { self } else { other }) * 1.0
 278     }
 279
 280     /// Raw transmutation to `u32`.
 281     #[inline]
 282     fn to_bits(self) -> u32 {
 283         unsafe { mem::transmute(self) }
 284     }
 285
 286     /// Raw transmutation from `u32`.
 287     #[inline]
 288     fn from_bits(v: u32) -> Self {
 289         // It turns out the safety issues with sNaN were overblown! Hooray!
 290         unsafe { mem::transmute(v) }
 291     }
 292 }