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.
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.
11 //! Operations and constants for 64-bits floats (`f64` type)
13 #![doc(primitive = "f64")]
17 use num::{FPNormal, FPCategory, FPZero, FPSubnormal, FPInfinite, FPNaN};
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`.
25 pub static RADIX: uint = 2u;
27 pub static MANTISSA_DIGITS: uint = 53u;
28 pub static DIGITS: uint = 15u;
30 pub static EPSILON: f64 = 2.2204460492503131e-16_f64;
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;
39 pub static MIN_EXP: int = -1021;
40 pub static MAX_EXP: int = 1024;
42 pub static MIN_10_EXP: int = -307;
43 pub static MAX_10_EXP: int = 308;
45 pub static NAN: f64 = 0.0_f64/0.0_f64;
47 pub static INFINITY: f64 = 1.0_f64/0.0_f64;
49 pub static NEG_INFINITY: f64 = -1.0_f64/0.0_f64;
51 /// Various useful constants.
53 // FIXME: replace with mathematical constants from cmath.
55 // FIXME(#5527): These constants should be deprecated once associated
56 // constants are implemented in favour of referencing the respective members
59 /// Archimedes' constant
60 pub static PI: f64 = 3.14159265358979323846264338327950288_f64;
63 pub static PI_2: f64 = 6.28318530717958647692528676655900576_f64;
66 pub static FRAC_PI_2: f64 = 1.57079632679489661923132169163975144_f64;
69 pub static FRAC_PI_3: f64 = 1.04719755119659774615421446109316763_f64;
72 pub static FRAC_PI_4: f64 = 0.785398163397448309615660845819875721_f64;
75 pub static FRAC_PI_6: f64 = 0.52359877559829887307710723054658381_f64;
78 pub static FRAC_PI_8: f64 = 0.39269908169872415480783042290993786_f64;
81 pub static FRAC_1_PI: f64 = 0.318309886183790671537767526745028724_f64;
84 pub static FRAC_2_PI: f64 = 0.636619772367581343075535053490057448_f64;
87 pub static FRAC_2_SQRTPI: f64 = 1.12837916709551257389615890312154517_f64;
90 pub static SQRT2: f64 = 1.41421356237309504880168872420969808_f64;
93 pub static FRAC_1_SQRT2: f64 = 0.707106781186547524400844362104849039_f64;
96 pub static E: f64 = 2.71828182845904523536028747135266250_f64;
99 pub static LOG2_E: f64 = 1.44269504088896340735992468100189214_f64;
102 pub static LOG10_E: f64 = 0.434294481903251827651128918916605082_f64;
105 pub static LN_2: f64 = 0.693147180559945309417232121458176568_f64;
108 pub static LN_10: f64 = 2.30258509299404568401799145468436421_f64;
113 fn nan() -> f64 { NAN }
116 fn infinity() -> f64 { INFINITY }
119 fn neg_infinity() -> f64 { NEG_INFINITY }
122 fn neg_zero() -> f64 { -0.0 }
124 /// Returns `true` if the number is NaN
126 fn is_nan(self) -> bool { self != self }
128 /// Returns `true` if the number is infinite
130 fn is_infinite(self) -> bool {
131 self == Float::infinity() || self == Float::neg_infinity()
134 /// Returns `true` if the number is neither infinite or NaN
136 fn is_finite(self) -> bool {
137 !(self.is_nan() || self.is_infinite())
140 /// Returns `true` if the number is neither zero, infinite, subnormal or NaN
142 fn is_normal(self) -> bool {
143 self.classify() == FPNormal
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;
153 let bits: u64 = unsafe { mem::transmute(self) };
154 match (bits & MAN_MASK, bits & EXP_MASK) {
156 (_, 0) => FPSubnormal,
157 (0, EXP_MASK) => FPInfinite,
158 (_, EXP_MASK) => FPNaN,
164 fn mantissa_digits(_: Option<f64>) -> uint { MANTISSA_DIGITS }
167 fn digits(_: Option<f64>) -> uint { DIGITS }
170 fn epsilon() -> f64 { EPSILON }
173 fn min_exp(_: Option<f64>) -> int { MIN_EXP }
176 fn max_exp(_: Option<f64>) -> int { MAX_EXP }
179 fn min_10_exp(_: Option<f64>) -> int { MIN_10_EXP }
182 fn max_10_exp(_: Option<f64>) -> int { MAX_10_EXP }
185 fn min_pos_value(_: Option<f64>) -> f64 { MIN_POS_VALUE }
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
195 (bits & 0xfffffffffffff) | 0x10000000000000
197 // Exponent bias + mantissa shift
198 exponent -= 1023 + 52;
199 (mantissa, exponent, sign)
202 /// Round half-way cases toward `NEG_INFINITY`
204 fn floor(self) -> f64 {
205 unsafe { intrinsics::floorf64(self) }
208 /// Round half-way cases toward `INFINITY`
210 fn ceil(self) -> f64 {
211 unsafe { intrinsics::ceilf64(self) }
214 /// Round half-way cases away from `0.0`
216 fn round(self) -> f64 {
217 unsafe { intrinsics::roundf64(self) }
220 /// The integer part of the number (rounds towards `0.0`)
222 fn trunc(self) -> f64 {
223 unsafe { intrinsics::truncf64(self) }
226 /// The fractional part of the number, satisfying:
230 /// assert!(x == x.trunc() + x.fract())
233 fn fract(self) -> f64 { self - self.trunc() }
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.
239 fn mul_add(self, a: f64, b: f64) -> f64 {
240 unsafe { intrinsics::fmaf64(self, a, b) }
243 /// The reciprocal (multiplicative inverse) of the number
245 fn recip(self) -> f64 { 1.0 / self }
248 fn powf(self, n: f64) -> f64 {
249 unsafe { intrinsics::powf64(self, n) }
253 fn powi(self, n: i32) -> f64 {
254 unsafe { intrinsics::powif64(self, n) }
259 fn sqrt2() -> f64 { consts::SQRT2 }
263 fn frac_1_sqrt2() -> f64 { consts::FRAC_1_SQRT2 }
266 fn sqrt(self) -> f64 {
267 unsafe { intrinsics::sqrtf64(self) }
271 fn rsqrt(self) -> f64 { self.sqrt().recip() }
273 /// Archimedes' constant
275 fn pi() -> f64 { consts::PI }
279 fn two_pi() -> f64 { consts::PI_2 }
283 fn frac_pi_2() -> f64 { consts::FRAC_PI_2 }
287 fn frac_pi_3() -> f64 { consts::FRAC_PI_3 }
291 fn frac_pi_4() -> f64 { consts::FRAC_PI_4 }
295 fn frac_pi_6() -> f64 { consts::FRAC_PI_6 }
299 fn frac_pi_8() -> f64 { consts::FRAC_PI_8 }
303 fn frac_1_pi() -> f64 { consts::FRAC_1_PI }
307 fn frac_2_pi() -> f64 { consts::FRAC_2_PI }
311 fn frac_2_sqrtpi() -> f64 { consts::FRAC_2_SQRTPI }
315 fn e() -> f64 { consts::E }
319 fn log2_e() -> f64 { consts::LOG2_E }
323 fn log10_e() -> f64 { consts::LOG10_E }
327 fn ln_2() -> f64 { consts::LN_2 }
331 fn ln_10() -> f64 { consts::LN_10 }
333 /// Returns the exponential of the number
335 fn exp(self) -> f64 {
336 unsafe { intrinsics::expf64(self) }
339 /// Returns 2 raised to the power of the number
341 fn exp2(self) -> f64 {
342 unsafe { intrinsics::exp2f64(self) }
345 /// Returns the natural logarithm of the number
348 unsafe { intrinsics::logf64(self) }
351 /// Returns the logarithm of the number with respect to an arbitrary base
353 fn log(self, base: f64) -> f64 { self.ln() / base.ln() }
355 /// Returns the base 2 logarithm of the number
357 fn log2(self) -> f64 {
358 unsafe { intrinsics::log2f64(self) }
361 /// Returns the base 10 logarithm of the number
363 fn log10(self) -> f64 {
364 unsafe { intrinsics::log10f64(self) }
368 /// Converts to degrees, assuming the number is in radians
370 fn to_degrees(self) -> f64 { self * (180.0f64 / Float::pi()) }
372 /// Converts to radians, assuming the number is in degrees
374 fn to_radians(self) -> f64 {
375 let value: f64 = Float::pi();
376 self * (value / 180.0)