src/libcore/num/f64.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 //! Operations and constants for 64-bits floats (`f64` type)
  12
  13 #![doc(primitive = "f64")]
  14 // FIXME: MIN_VALUE and MAX_VALUE literals are parsed as -inf and inf #14353
  15 #![allow(overflowing_literals)]
  16
  17 #![stable]
  18
  19 use intrinsics;
  20 use mem;
  21 use num::Float;
  22 use num::FpCategory as Fp;
  23 use option::Option;
  24
  25 // FIXME(#5527): These constants should be deprecated once associated
  26 // constants are implemented in favour of referencing the respective
  27 // members of `Bounded` and `Float`.
  28
  29 #[stable]
  30 pub const RADIX: uint = 2u;
  31
  32 #[stable]
  33 pub const MANTISSA_DIGITS: uint = 53u;
  34 #[stable]
  35 pub const DIGITS: uint = 15u;
  36
  37 #[stable]
  38 pub const EPSILON: f64 = 2.2204460492503131e-16_f64;
  39
  40 /// Smallest finite f64 value
  41 #[stable]
  42 pub const MIN_VALUE: f64 = -1.7976931348623157e+308_f64;
  43 /// Smallest positive, normalized f64 value
  44 #[stable]
  45 pub const MIN_POS_VALUE: f64 = 2.2250738585072014e-308_f64;
  46 /// Largest finite f64 value
  47 #[stable]
  48 pub const MAX_VALUE: f64 = 1.7976931348623157e+308_f64;
  49
  50 #[stable]
  51 pub const MIN_EXP: int = -1021;
  52 #[stable]
  53 pub const MAX_EXP: int = 1024;
  54
  55 #[stable]
  56 pub const MIN_10_EXP: int = -307;
  57 #[stable]
  58 pub const MAX_10_EXP: int = 308;
  59
  60 #[stable]
  61 pub const NAN: f64 = 0.0_f64/0.0_f64;
  62 #[stable]
  63 pub const INFINITY: f64 = 1.0_f64/0.0_f64;
  64 #[stable]
  65 pub const NEG_INFINITY: f64 = -1.0_f64/0.0_f64;
  66
  67 /// Various useful constants.
  68 #[unstable = "naming scheme needs to be revisited"]
  69 pub mod consts {
  70     // FIXME: replace with mathematical constants from cmath.
  71
  72     // FIXME(#5527): These constants should be deprecated once associated
  73     // constants are implemented in favour of referencing the respective members
  74     // of `Float`.
  75
  76     /// Archimedes' constant
  77     pub const PI: f64 = 3.14159265358979323846264338327950288_f64;
  78
  79     /// pi * 2.0
  80     pub const PI_2: f64 = 6.28318530717958647692528676655900576_f64;
  81
  82     /// pi/2.0
  83     pub const FRAC_PI_2: f64 = 1.57079632679489661923132169163975144_f64;
  84
  85     /// pi/3.0
  86     pub const FRAC_PI_3: f64 = 1.04719755119659774615421446109316763_f64;
  87
  88     /// pi/4.0
  89     pub const FRAC_PI_4: f64 = 0.785398163397448309615660845819875721_f64;
  90
  91     /// pi/6.0
  92     pub const FRAC_PI_6: f64 = 0.52359877559829887307710723054658381_f64;
  93
  94     /// pi/8.0
  95     pub const FRAC_PI_8: f64 = 0.39269908169872415480783042290993786_f64;
  96
  97     /// 1.0/pi
  98     pub const FRAC_1_PI: f64 = 0.318309886183790671537767526745028724_f64;
  99
 100     /// 2.0/pi
 101     pub const FRAC_2_PI: f64 = 0.636619772367581343075535053490057448_f64;
 102
 103     /// 2.0/sqrt(pi)
 104     pub const FRAC_2_SQRTPI: f64 = 1.12837916709551257389615890312154517_f64;
 105
 106     /// sqrt(2.0)
 107     pub const SQRT2: f64 = 1.41421356237309504880168872420969808_f64;
 108
 109     /// 1.0/sqrt(2.0)
 110     pub const FRAC_1_SQRT2: f64 = 0.707106781186547524400844362104849039_f64;
 111
 112     /// Euler's number
 113     pub const E: f64 = 2.71828182845904523536028747135266250_f64;
 114
 115     /// log2(e)
 116     pub const LOG2_E: f64 = 1.44269504088896340735992468100189214_f64;
 117
 118     /// log10(e)
 119     pub const LOG10_E: f64 = 0.434294481903251827651128918916605082_f64;
 120
 121     /// ln(2.0)
 122     pub const LN_2: f64 = 0.693147180559945309417232121458176568_f64;
 123
 124     /// ln(10.0)
 125     pub const LN_10: f64 = 2.30258509299404568401799145468436421_f64;
 126 }
 127
 128 #[unstable = "trait is unstable"]
 129 impl Float for f64 {
 130     #[inline]
 131     fn nan() -> f64 { NAN }
 132
 133     #[inline]
 134     fn infinity() -> f64 { INFINITY }
 135
 136     #[inline]
 137     fn neg_infinity() -> f64 { NEG_INFINITY }
 138
 139     #[inline]
 140     fn zero() -> f64 { 0.0 }
 141
 142     #[inline]
 143     fn neg_zero() -> f64 { -0.0 }
 144
 145     #[inline]
 146     fn one() -> f64 { 1.0 }
 147
 148     /// Returns `true` if the number is NaN.
 149     #[inline]
 150     fn is_nan(self) -> bool { self != self }
 151
 152     /// Returns `true` if the number is infinite.
 153     #[inline]
 154     fn is_infinite(self) -> bool {
 155         self == Float::infinity() || self == Float::neg_infinity()
 156     }
 157
 158     /// Returns `true` if the number is neither infinite or NaN.
 159     #[inline]
 160     fn is_finite(self) -> bool {
 161         !(self.is_nan() || self.is_infinite())
 162     }
 163
 164     /// Returns `true` if the number is neither zero, infinite, subnormal or NaN.
 165     #[inline]
 166     fn is_normal(self) -> bool {
 167         self.classify() == Fp::Normal
 168     }
 169
 170     /// Returns the floating point category of the number. If only one property
 171     /// is going to be tested, it is generally faster to use the specific
 172     /// predicate instead.
 173     fn classify(self) -> Fp {
 174         const EXP_MASK: u64 = 0x7ff0000000000000;
 175         const MAN_MASK: u64 = 0x000fffffffffffff;
 176
 177         let bits: u64 = unsafe { mem::transmute(self) };
 178         match (bits & MAN_MASK, bits & EXP_MASK) {
 179             (0, 0)        => Fp::Zero,
 180             (_, 0)        => Fp::Subnormal,
 181             (0, EXP_MASK) => Fp::Infinite,
 182             (_, EXP_MASK) => Fp::Nan,
 183             _             => Fp::Normal,
 184         }
 185     }
 186
 187     #[inline]
 188     fn mantissa_digits(_: Option<f64>) -> uint { MANTISSA_DIGITS }
 189
 190     #[inline]
 191     fn digits(_: Option<f64>) -> uint { DIGITS }
 192
 193     #[inline]
 194     fn epsilon() -> f64 { EPSILON }
 195
 196     #[inline]
 197     fn min_exp(_: Option<f64>) -> int { MIN_EXP }
 198
 199     #[inline]
 200     fn max_exp(_: Option<f64>) -> int { MAX_EXP }
 201
 202     #[inline]
 203     fn min_10_exp(_: Option<f64>) -> int { MIN_10_EXP }
 204
 205     #[inline]
 206     fn max_10_exp(_: Option<f64>) -> int { MAX_10_EXP }
 207
 208     #[inline]
 209     fn min_value() -> f64 { MIN_VALUE }
 210
 211     #[inline]
 212     fn min_pos_value(_: Option<f64>) -> f64 { MIN_POS_VALUE }
 213
 214     #[inline]
 215     fn max_value() -> f64 { MAX_VALUE }
 216
 217     /// Returns the mantissa, exponent and sign as integers.
 218     fn integer_decode(self) -> (u64, i16, i8) {
 219         let bits: u64 = unsafe { mem::transmute(self) };
 220         let sign: i8 = if bits >> 63 == 0 { 1 } else { -1 };
 221         let mut exponent: i16 = ((bits >> 52) & 0x7ff) as i16;
 222         let mantissa = if exponent == 0 {
 223             (bits & 0xfffffffffffff) << 1
 224         } else {
 225             (bits & 0xfffffffffffff) | 0x10000000000000
 226         };
 227         // Exponent bias + mantissa shift
 228         exponent -= 1023 + 52;
 229         (mantissa, exponent, sign)
 230     }
 231
 232     /// Rounds towards minus infinity.
 233     #[inline]
 234     fn floor(self) -> f64 {
 235         unsafe { intrinsics::floorf64(self) }
 236     }
 237
 238     /// Rounds towards plus infinity.
 239     #[inline]
 240     fn ceil(self) -> f64 {
 241         unsafe { intrinsics::ceilf64(self) }
 242     }
 243
 244     /// Rounds to nearest integer. Rounds half-way cases away from zero.
 245     #[inline]
 246     fn round(self) -> f64 {
 247         unsafe { intrinsics::roundf64(self) }
 248     }
 249
 250     /// Returns the integer part of the number (rounds towards zero).
 251     #[inline]
 252     fn trunc(self) -> f64 {
 253         unsafe { intrinsics::truncf64(self) }
 254     }
 255
 256     /// The fractional part of the number, satisfying:
 257     ///
 258     /// ```rust
 259     /// use core::num::Float;
 260     ///
 261     /// let x = 1.65f64;
 262     /// assert!(x == x.trunc() + x.fract())
 263     /// ```
 264     #[inline]
 265     fn fract(self) -> f64 { self - self.trunc() }
 266
 267     /// Computes the absolute value of `self`. Returns `Float::nan()` if the
 268     /// number is `Float::nan()`.
 269     #[inline]
 270     fn abs(self) -> f64 {
 271         unsafe { intrinsics::fabsf64(self) }
 272     }
 273
 274     /// Returns a number that represents the sign of `self`.
 275     ///
 276     /// - `1.0` if the number is positive, `+0.0` or `Float::infinity()`
 277     /// - `-1.0` if the number is negative, `-0.0` or `Float::neg_infinity()`
 278     /// - `Float::nan()` if the number is `Float::nan()`
 279     #[inline]
 280     fn signum(self) -> f64 {
 281         if self.is_nan() {
 282             Float::nan()
 283         } else {
 284             unsafe { intrinsics::copysignf64(1.0, self) }
 285         }
 286     }
 287
 288     /// Returns `true` if `self` is positive, including `+0.0` and
 289     /// `Float::infinity()`.
 290     #[inline]
 291     fn is_positive(self) -> bool {
 292         self > 0.0 || (1.0 / self) == Float::infinity()
 293     }
 294
 295     /// Returns `true` if `self` is negative, including `-0.0` and
 296     /// `Float::neg_infinity()`.
 297     #[inline]
 298     fn is_negative(self) -> bool {
 299         self < 0.0 || (1.0 / self) == Float::neg_infinity()
 300     }
 301
 302     /// Fused multiply-add. Computes `(self * a) + b` with only one rounding
 303     /// error. This produces a more accurate result with better performance than
 304     /// a separate multiplication operation followed by an add.
 305     #[inline]
 306     fn mul_add(self, a: f64, b: f64) -> f64 {
 307         unsafe { intrinsics::fmaf64(self, a, b) }
 308     }
 309
 310     /// Returns the reciprocal (multiplicative inverse) of the number.
 311     #[inline]
 312     fn recip(self) -> f64 { 1.0 / self }
 313
 314     #[inline]
 315     fn powf(self, n: f64) -> f64 {
 316         unsafe { intrinsics::powf64(self, n) }
 317     }
 318
 319     #[inline]
 320     fn powi(self, n: i32) -> f64 {
 321         unsafe { intrinsics::powif64(self, n) }
 322     }
 323
 324     #[inline]
 325     fn sqrt(self) -> f64 {
 326         if self < 0.0 {
 327             NAN
 328         } else {
 329             unsafe { intrinsics::sqrtf64(self) }
 330         }
 331     }
 332
 333     #[inline]
 334     fn rsqrt(self) -> f64 { self.sqrt().recip() }
 335
 336     /// Returns the exponential of the number.
 337     #[inline]
 338     fn exp(self) -> f64 {
 339         unsafe { intrinsics::expf64(self) }
 340     }
 341
 342     /// Returns 2 raised to the power of the number.
 343     #[inline]
 344     fn exp2(self) -> f64 {
 345         unsafe { intrinsics::exp2f64(self) }
 346     }
 347
 348     /// Returns the natural logarithm of the number.
 349     #[inline]
 350     fn ln(self) -> f64 {
 351         unsafe { intrinsics::logf64(self) }
 352     }
 353
 354     /// Returns the logarithm of the number with respect to an arbitrary base.
 355     #[inline]
 356     fn log(self, base: f64) -> f64 { self.ln() / base.ln() }
 357
 358     /// Returns the base 2 logarithm of the number.
 359     #[inline]
 360     fn log2(self) -> f64 {
 361         unsafe { intrinsics::log2f64(self) }
 362     }
 363
 364     /// Returns the base 10 logarithm of the number.
 365     #[inline]
 366     fn log10(self) -> f64 {
 367         unsafe { intrinsics::log10f64(self) }
 368     }
 369
 370     /// Converts to degrees, assuming the number is in radians.
 371     #[inline]
 372     fn to_degrees(self) -> f64 { self * (180.0f64 / consts::PI) }
 373
 374     /// Converts to radians, assuming the number is in degrees.
 375     #[inline]
 376     fn to_radians(self) -> f64 {
 377         let value: f64 = consts::PI;
 378         self * (value / 180.0)
 379     }
 380 }