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