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