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