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 32-bits floats (`f32` type)
13 #![allow(missing_doc)]
18 use from_str::FromStr;
20 use num::{FPCategory, FPNaN, FPInfinite , FPZero, FPSubnormal, FPNormal};
21 use num::{Zero, One, Bounded, strconv};
27 use libc::{c_float, c_int};
31 pub fn acosf(n: c_float) -> c_float;
32 pub fn asinf(n: c_float) -> c_float;
33 pub fn atanf(n: c_float) -> c_float;
34 pub fn atan2f(a: c_float, b: c_float) -> c_float;
35 pub fn cbrtf(n: c_float) -> c_float;
36 pub fn coshf(n: c_float) -> c_float;
37 pub fn erff(n: c_float) -> c_float;
38 pub fn erfcf(n: c_float) -> c_float;
39 pub fn expm1f(n: c_float) -> c_float;
40 pub fn fdimf(a: c_float, b: c_float) -> c_float;
41 pub fn frexpf(n: c_float, value: &mut c_int) -> c_float;
42 pub fn fmaxf(a: c_float, b: c_float) -> c_float;
43 pub fn fminf(a: c_float, b: c_float) -> c_float;
44 pub fn nextafterf(x: c_float, y: c_float) -> c_float;
45 pub fn hypotf(x: c_float, y: c_float) -> c_float;
46 pub fn ldexpf(x: c_float, n: c_int) -> c_float;
47 pub fn logbf(n: c_float) -> c_float;
48 pub fn log1pf(n: c_float) -> c_float;
49 pub fn ilogbf(n: c_float) -> c_int;
50 pub fn modff(n: c_float, iptr: &mut c_float) -> c_float;
51 pub fn sinhf(n: c_float) -> c_float;
52 pub fn tanf(n: c_float) -> c_float;
53 pub fn tanhf(n: c_float) -> c_float;
54 pub fn tgammaf(n: c_float) -> c_float;
57 pub fn lgammaf_r(n: c_float, sign: &mut c_int) -> c_float;
60 #[link_name="__lgammaf_r"]
61 pub fn lgammaf_r(n: c_float, sign: &mut c_int) -> c_float;
65 // FIXME(#11621): These constants should be deprecated once CTFE is implemented
66 // in favour of calling their respective functions in `Bounded` and `Float`.
68 pub static RADIX: uint = 2u;
70 pub static MANTISSA_DIGITS: uint = 53u;
71 pub static DIGITS: uint = 15u;
73 pub static EPSILON: f64 = 2.220446e-16_f64;
75 // FIXME (#1433): this is wrong, replace with hexadecimal (%a) statics
77 pub static MIN_VALUE: f64 = 2.225074e-308_f64;
78 pub static MAX_VALUE: f64 = 1.797693e+308_f64;
80 pub static MIN_EXP: uint = -1021u;
81 pub static MAX_EXP: uint = 1024u;
83 pub static MIN_10_EXP: int = -307;
84 pub static MAX_10_EXP: int = 308;
86 pub static NAN: f32 = 0.0_f32/0.0_f32;
87 pub static INFINITY: f32 = 1.0_f32/0.0_f32;
88 pub static NEG_INFINITY: f32 = -1.0_f32/0.0_f32;
90 /// Various useful constants.
92 // FIXME (requires Issue #1433 to fix): replace with mathematical
93 // staticants from cmath.
95 // FIXME(#11621): These constants should be deprecated once CTFE is
96 // implemented in favour of calling their respective functions in `Float`.
98 /// Archimedes' constant
99 pub static PI: f32 = 3.14159265358979323846264338327950288_f32;
102 pub static FRAC_PI_2: f32 = 1.57079632679489661923132169163975144_f32;
105 pub static FRAC_PI_4: f32 = 0.785398163397448309615660845819875721_f32;
108 pub static FRAC_1_PI: f32 = 0.318309886183790671537767526745028724_f32;
111 pub static FRAC_2_PI: f32 = 0.636619772367581343075535053490057448_f32;
114 pub static FRAC_2_SQRTPI: f32 = 1.12837916709551257389615890312154517_f32;
117 pub static SQRT2: f32 = 1.41421356237309504880168872420969808_f32;
120 pub static FRAC_1_SQRT2: f32 = 0.707106781186547524400844362104849039_f32;
123 pub static E: f32 = 2.71828182845904523536028747135266250_f32;
126 pub static LOG2_E: f32 = 1.44269504088896340735992468100189214_f32;
129 pub static LOG10_E: f32 = 0.434294481903251827651128918916605082_f32;
132 pub static LN_2: f32 = 0.693147180559945309417232121458176568_f32;
135 pub static LN_10: f32 = 2.30258509299404568401799145468436421_f32;
143 fn eq(&self, other: &f32) -> bool { (*self) == (*other) }
149 fn lt(&self, other: &f32) -> bool { (*self) < (*other) }
151 fn le(&self, other: &f32) -> bool { (*self) <= (*other) }
153 fn ge(&self, other: &f32) -> bool { (*self) >= (*other) }
155 fn gt(&self, other: &f32) -> bool { (*self) > (*other) }
158 impl Default for f32 {
160 fn default() -> f32 { 0.0 }
165 fn zero() -> f32 { 0.0 }
167 /// Returns true if the number is equal to either `0.0` or `-0.0`
169 fn is_zero(&self) -> bool { *self == 0.0 || *self == -0.0 }
174 fn one() -> f32 { 1.0 }
178 impl Add<f32,f32> for f32 {
180 fn add(&self, other: &f32) -> f32 { *self + *other }
184 impl Sub<f32,f32> for f32 {
186 fn sub(&self, other: &f32) -> f32 { *self - *other }
190 impl Mul<f32,f32> for f32 {
192 fn mul(&self, other: &f32) -> f32 { *self * *other }
196 impl Div<f32,f32> for f32 {
198 fn div(&self, other: &f32) -> f32 { *self / *other }
202 impl Rem<f32,f32> for f32 {
204 fn rem(&self, other: &f32) -> f32 { *self % *other }
208 impl Neg<f32> for f32 {
210 fn neg(&self) -> f32 { -*self }
213 impl Signed for f32 {
214 /// Computes the absolute value. Returns `NAN` if the number is `NAN`.
216 fn abs(&self) -> f32 { unsafe{intrinsics::fabsf32(*self)} }
218 /// The positive difference of two numbers. Returns `0.0` if the number is less than or
219 /// equal to `other`, otherwise the difference between`self` and `other` is returned.
221 fn abs_sub(&self, other: &f32) -> f32 { unsafe{cmath::fdimf(*self, *other)} }
225 /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
226 /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
227 /// - `NAN` if the number is NaN
229 fn signum(&self) -> f32 {
230 if self.is_nan() { NAN } else { unsafe{intrinsics::copysignf32(1.0, *self)} }
233 /// Returns `true` if the number is positive, including `+0.0` and `INFINITY`
235 fn is_positive(&self) -> bool { *self > 0.0 || (1.0 / *self) == INFINITY }
237 /// Returns `true` if the number is negative, including `-0.0` and `NEG_INFINITY`
239 fn is_negative(&self) -> bool { *self < 0.0 || (1.0 / *self) == NEG_INFINITY }
243 /// Round half-way cases toward `NEG_INFINITY`
245 fn floor(&self) -> f32 { unsafe{intrinsics::floorf32(*self)} }
247 /// Round half-way cases toward `INFINITY`
249 fn ceil(&self) -> f32 { unsafe{intrinsics::ceilf32(*self)} }
251 /// Round half-way cases away from `0.0`
253 fn round(&self) -> f32 { unsafe{intrinsics::roundf32(*self)} }
255 /// The integer part of the number (rounds towards `0.0`)
257 fn trunc(&self) -> f32 { unsafe{intrinsics::truncf32(*self)} }
259 /// The fractional part of the number, satisfying:
263 /// assert!(x == x.trunc() + x.fract())
266 fn fract(&self) -> f32 { *self - self.trunc() }
269 impl Bounded for f32 {
271 fn min_value() -> f32 { 1.17549435e-38 }
274 fn max_value() -> f32 { 3.40282347e+38 }
277 impl Primitive for f32 {}
280 fn powi(&self, n: i32) -> f32 { unsafe{intrinsics::powif32(*self, n)} }
283 fn max(self, other: f32) -> f32 {
284 unsafe { cmath::fmaxf(self, other) }
288 fn min(self, other: f32) -> f32 {
289 unsafe { cmath::fminf(self, other) }
293 fn nan() -> f32 { 0.0 / 0.0 }
296 fn infinity() -> f32 { 1.0 / 0.0 }
299 fn neg_infinity() -> f32 { -1.0 / 0.0 }
302 fn neg_zero() -> f32 { -0.0 }
304 /// Returns `true` if the number is NaN
306 fn is_nan(&self) -> bool { *self != *self }
308 /// Returns `true` if the number is infinite
310 fn is_infinite(&self) -> bool {
311 *self == Float::infinity() || *self == Float::neg_infinity()
314 /// Returns `true` if the number is neither infinite or NaN
316 fn is_finite(&self) -> bool {
317 !(self.is_nan() || self.is_infinite())
320 /// Returns `true` if the number is neither zero, infinite, subnormal or NaN
322 fn is_normal(&self) -> bool {
323 self.classify() == FPNormal
326 /// Returns the floating point category of the number. If only one property is going to
327 /// be tested, it is generally faster to use the specific predicate instead.
328 fn classify(&self) -> FPCategory {
329 static EXP_MASK: u32 = 0x7f800000;
330 static MAN_MASK: u32 = 0x007fffff;
332 let bits: u32 = unsafe {::cast::transmute(*self)};
333 match (bits & MAN_MASK, bits & EXP_MASK) {
335 (_, 0) => FPSubnormal,
336 (0, EXP_MASK) => FPInfinite,
337 (_, EXP_MASK) => FPNaN,
343 fn mantissa_digits(_: Option<f32>) -> uint { 24 }
346 fn digits(_: Option<f32>) -> uint { 6 }
349 fn epsilon() -> f32 { 1.19209290e-07 }
352 fn min_exp(_: Option<f32>) -> int { -125 }
355 fn max_exp(_: Option<f32>) -> int { 128 }
358 fn min_10_exp(_: Option<f32>) -> int { -37 }
361 fn max_10_exp(_: Option<f32>) -> int { 38 }
363 /// Constructs a floating point number by multiplying `x` by 2 raised to the power of `exp`
365 fn ldexp(x: f32, exp: int) -> f32 { unsafe{cmath::ldexpf(x, exp as c_int)} }
367 /// Breaks the number into a normalized fraction and a base-2 exponent, satisfying:
369 /// - `self = x * pow(2, exp)`
370 /// - `0.5 <= abs(x) < 1.0`
372 fn frexp(&self) -> (f32, int) {
375 let x = cmath::frexpf(*self, &mut exp);
380 /// Returns the exponential of the number, minus `1`, in a way that is accurate
381 /// even if the number is close to zero
383 fn exp_m1(&self) -> f32 { unsafe{cmath::expm1f(*self)} }
385 /// Returns the natural logarithm of the number plus `1` (`ln(1+n)`) more accurately
386 /// than if the operations were performed separately
388 fn ln_1p(&self) -> f32 { unsafe{cmath::log1pf(*self)} }
390 /// Fused multiply-add. Computes `(self * a) + b` with only one rounding error. This
391 /// produces a more accurate result with better performance than a separate multiplication
392 /// operation followed by an add.
394 fn mul_add(&self, a: f32, b: f32) -> f32 { unsafe{intrinsics::fmaf32(*self, a, b)} }
396 /// Returns the next representable floating-point value in the direction of `other`
398 fn next_after(&self, other: f32) -> f32 { unsafe{cmath::nextafterf(*self, other)} }
400 /// Returns the mantissa, exponent and sign as integers.
401 fn integer_decode(&self) -> (u64, i16, i8) {
402 let bits: u32 = unsafe {
403 ::cast::transmute(*self)
405 let sign: i8 = if bits >> 31 == 0 { 1 } else { -1 };
406 let mut exponent: i16 = ((bits >> 23) & 0xff) as i16;
407 let mantissa = if exponent == 0 {
408 (bits & 0x7fffff) << 1
410 (bits & 0x7fffff) | 0x800000
412 // Exponent bias + mantissa shift
413 exponent -= 127 + 23;
414 (mantissa as u64, exponent, sign)
417 /// Archimedes' constant
419 fn pi() -> f32 { 3.14159265358979323846264338327950288 }
423 fn two_pi() -> f32 { 6.28318530717958647692528676655900576 }
427 fn frac_pi_2() -> f32 { 1.57079632679489661923132169163975144 }
431 fn frac_pi_3() -> f32 { 1.04719755119659774615421446109316763 }
435 fn frac_pi_4() -> f32 { 0.785398163397448309615660845819875721 }
439 fn frac_pi_6() -> f32 { 0.52359877559829887307710723054658381 }
443 fn frac_pi_8() -> f32 { 0.39269908169872415480783042290993786 }
447 fn frac_1_pi() -> f32 { 0.318309886183790671537767526745028724 }
451 fn frac_2_pi() -> f32 { 0.636619772367581343075535053490057448 }
455 fn frac_2_sqrtpi() -> f32 { 1.12837916709551257389615890312154517 }
459 fn sqrt2() -> f32 { 1.41421356237309504880168872420969808 }
463 fn frac_1_sqrt2() -> f32 { 0.707106781186547524400844362104849039 }
467 fn e() -> f32 { 2.71828182845904523536028747135266250 }
471 fn log2_e() -> f32 { 1.44269504088896340735992468100189214 }
475 fn log10_e() -> f32 { 0.434294481903251827651128918916605082 }
479 fn ln_2() -> f32 { 0.693147180559945309417232121458176568 }
483 fn ln_10() -> f32 { 2.30258509299404568401799145468436421 }
485 /// The reciprocal (multiplicative inverse) of the number
487 fn recip(&self) -> f32 { 1.0 / *self }
490 fn powf(&self, n: &f32) -> f32 { unsafe{intrinsics::powf32(*self, *n)} }
493 fn sqrt(&self) -> f32 { unsafe{intrinsics::sqrtf32(*self)} }
496 fn rsqrt(&self) -> f32 { self.sqrt().recip() }
499 fn cbrt(&self) -> f32 { unsafe{cmath::cbrtf(*self)} }
502 fn hypot(&self, other: &f32) -> f32 { unsafe{cmath::hypotf(*self, *other)} }
505 fn sin(&self) -> f32 { unsafe{intrinsics::sinf32(*self)} }
508 fn cos(&self) -> f32 { unsafe{intrinsics::cosf32(*self)} }
511 fn tan(&self) -> f32 { unsafe{cmath::tanf(*self)} }
514 fn asin(&self) -> f32 { unsafe{cmath::asinf(*self)} }
517 fn acos(&self) -> f32 { unsafe{cmath::acosf(*self)} }
520 fn atan(&self) -> f32 { unsafe{cmath::atanf(*self)} }
523 fn atan2(&self, other: &f32) -> f32 { unsafe{cmath::atan2f(*self, *other)} }
525 /// Simultaneously computes the sine and cosine of the number
527 fn sin_cos(&self) -> (f32, f32) {
528 (self.sin(), self.cos())
531 /// Returns the exponential of the number
533 fn exp(&self) -> f32 { unsafe{intrinsics::expf32(*self)} }
535 /// Returns 2 raised to the power of the number
537 fn exp2(&self) -> f32 { unsafe{intrinsics::exp2f32(*self)} }
539 /// Returns the natural logarithm of the number
541 fn ln(&self) -> f32 { unsafe{intrinsics::logf32(*self)} }
543 /// Returns the logarithm of the number with respect to an arbitrary base
545 fn log(&self, base: &f32) -> f32 { self.ln() / base.ln() }
547 /// Returns the base 2 logarithm of the number
549 fn log2(&self) -> f32 { unsafe{intrinsics::log2f32(*self)} }
551 /// Returns the base 10 logarithm of the number
553 fn log10(&self) -> f32 { unsafe{intrinsics::log10f32(*self)} }
556 fn sinh(&self) -> f32 { unsafe{cmath::sinhf(*self)} }
559 fn cosh(&self) -> f32 { unsafe{cmath::coshf(*self)} }
562 fn tanh(&self) -> f32 { unsafe{cmath::tanhf(*self)} }
564 /// Inverse hyperbolic sine
568 /// - on success, the inverse hyperbolic sine of `self` will be returned
569 /// - `self` if `self` is `0.0`, `-0.0`, `INFINITY`, or `NEG_INFINITY`
570 /// - `NAN` if `self` is `NAN`
572 fn asinh(&self) -> f32 {
574 NEG_INFINITY => NEG_INFINITY,
575 x => (x + ((x * x) + 1.0).sqrt()).ln(),
579 /// Inverse hyperbolic cosine
583 /// - on success, the inverse hyperbolic cosine of `self` will be returned
584 /// - `INFINITY` if `self` is `INFINITY`
585 /// - `NAN` if `self` is `NAN` or `self < 1.0` (including `NEG_INFINITY`)
587 fn acosh(&self) -> f32 {
589 x if x < 1.0 => Float::nan(),
590 x => (x + ((x * x) - 1.0).sqrt()).ln(),
594 /// Inverse hyperbolic tangent
598 /// - on success, the inverse hyperbolic tangent of `self` will be returned
599 /// - `self` if `self` is `0.0` or `-0.0`
600 /// - `INFINITY` if `self` is `1.0`
601 /// - `NEG_INFINITY` if `self` is `-1.0`
602 /// - `NAN` if the `self` is `NAN` or outside the domain of `-1.0 <= self <= 1.0`
603 /// (including `INFINITY` and `NEG_INFINITY`)
605 fn atanh(&self) -> f32 {
606 0.5 * ((2.0 * *self) / (1.0 - *self)).ln_1p()
609 /// Converts to degrees, assuming the number is in radians
611 fn to_degrees(&self) -> f32 { *self * (180.0f32 / Float::pi()) }
613 /// Converts to radians, assuming the number is in degrees
615 fn to_radians(&self) -> f32 {
616 let value: f32 = Float::pi();
617 *self * (value / 180.0f32)
622 // Section: String Conversions
625 /// Converts a float to a string
629 /// * num - The float value
631 pub fn to_str(num: f32) -> ~str {
632 let (r, _) = strconv::float_to_str_common(
633 num, 10u, true, strconv::SignNeg, strconv::DigAll, strconv::ExpNone, false);
637 /// Converts a float to a string in hexadecimal format
641 /// * num - The float value
643 pub fn to_str_hex(num: f32) -> ~str {
644 let (r, _) = strconv::float_to_str_common(
645 num, 16u, true, strconv::SignNeg, strconv::DigAll, strconv::ExpNone, false);
649 /// Converts a float to a string in a given radix, and a flag indicating
650 /// whether it's a special value
654 /// * num - The float value
655 /// * radix - The base to use
657 pub fn to_str_radix_special(num: f32, rdx: uint) -> (~str, bool) {
658 strconv::float_to_str_common(num, rdx, true,
659 strconv::SignNeg, strconv::DigAll, strconv::ExpNone, false)
662 /// Converts a float to a string with exactly the number of
663 /// provided significant digits
667 /// * num - The float value
668 /// * digits - The number of significant digits
670 pub fn to_str_exact(num: f32, dig: uint) -> ~str {
671 let (r, _) = strconv::float_to_str_common(
672 num, 10u, true, strconv::SignNeg, strconv::DigExact(dig), strconv::ExpNone, false);
676 /// Converts a float to a string with a maximum number of
677 /// significant digits
681 /// * num - The float value
682 /// * digits - The number of significant digits
684 pub fn to_str_digits(num: f32, dig: uint) -> ~str {
685 let (r, _) = strconv::float_to_str_common(
686 num, 10u, true, strconv::SignNeg, strconv::DigMax(dig), strconv::ExpNone, false);
690 /// Converts a float to a string using the exponential notation with exactly the number of
691 /// provided digits after the decimal point in the significand
695 /// * num - The float value
696 /// * digits - The number of digits after the decimal point
697 /// * upper - Use `E` instead of `e` for the exponent sign
699 pub fn to_str_exp_exact(num: f32, dig: uint, upper: bool) -> ~str {
700 let (r, _) = strconv::float_to_str_common(
701 num, 10u, true, strconv::SignNeg, strconv::DigExact(dig), strconv::ExpDec, upper);
705 /// Converts a float to a string using the exponential notation with the maximum number of
706 /// digits after the decimal point in the significand
710 /// * num - The float value
711 /// * digits - The number of digits after the decimal point
712 /// * upper - Use `E` instead of `e` for the exponent sign
714 pub fn to_str_exp_digits(num: f32, dig: uint, upper: bool) -> ~str {
715 let (r, _) = strconv::float_to_str_common(
716 num, 10u, true, strconv::SignNeg, strconv::DigMax(dig), strconv::ExpDec, upper);
720 impl num::ToStrRadix for f32 {
721 /// Converts a float to a string in a given radix
725 /// * num - The float value
726 /// * radix - The base to use
730 /// Fails if called on a special value like `inf`, `-inf` or `NaN` due to
731 /// possible misinterpretation of the result at higher bases. If those values
732 /// are expected, use `to_str_radix_special()` instead.
734 fn to_str_radix(&self, rdx: uint) -> ~str {
735 let (r, special) = strconv::float_to_str_common(
736 *self, rdx, true, strconv::SignNeg, strconv::DigAll, strconv::ExpNone, false);
737 if special { fail!("number has a special value, \
738 try to_str_radix_special() if those are expected") }
743 /// Convert a string in base 16 to a float.
744 /// Accepts an optional binary exponent.
746 /// This function accepts strings such as
749 /// * '+a4.fe', equivalent to 'a4.fe'
751 /// * '2b.aP128', or equivalently, '2b.ap128'
753 /// * '.' (understood as 0)
755 /// * '.c', or, equivalently, '0.c'
756 /// * '+inf', 'inf', '-inf', 'NaN'
758 /// Leading and trailing whitespace represent an error.
766 /// `None` if the string did not represent a valid number. Otherwise,
767 /// `Some(n)` where `n` is the floating-point number represented by `[num]`.
769 pub fn from_str_hex(num: &str) -> Option<f32> {
770 strconv::from_str_common(num, 16u, true, true, true,
771 strconv::ExpBin, false, false)
774 impl FromStr for f32 {
775 /// Convert a string in base 10 to a float.
776 /// Accepts an optional decimal exponent.
778 /// This function accepts strings such as
781 /// * '+3.14', equivalent to '3.14'
783 /// * '2.5E10', or equivalently, '2.5e10'
785 /// * '.' (understood as 0)
787 /// * '.5', or, equivalently, '0.5'
788 /// * '+inf', 'inf', '-inf', 'NaN'
790 /// Leading and trailing whitespace represent an error.
798 /// `None` if the string did not represent a valid number. Otherwise,
799 /// `Some(n)` where `n` is the floating-point number represented by `num`.
801 fn from_str(val: &str) -> Option<f32> {
802 strconv::from_str_common(val, 10u, true, true, true,
803 strconv::ExpDec, false, false)
807 impl num::FromStrRadix for f32 {
808 /// Convert a string in a given base to a float.
810 /// Due to possible conflicts, this function does **not** accept
811 /// the special values `inf`, `-inf`, `+inf` and `NaN`, **nor**
812 /// does it recognize exponents of any kind.
814 /// Leading and trailing whitespace represent an error.
819 /// * radix - The base to use. Must lie in the range [2 .. 36]
823 /// `None` if the string did not represent a valid number. Otherwise,
824 /// `Some(n)` where `n` is the floating-point number represented by `num`.
826 fn from_str_radix(val: &str, rdx: uint) -> Option<f32> {
827 strconv::from_str_common(val, rdx, true, true, false,
828 strconv::ExpNone, false, false)
840 assert_eq!(NAN.min(2.0), 2.0);
841 assert_eq!(2.0f32.min(NAN), 2.0);
846 assert_eq!(NAN.max(2.0), 2.0);
847 assert_eq!(2.0f32.max(NAN), 2.0);
852 num::test_num(10f32, 2f32);
857 assert_approx_eq!(1.0f32.floor(), 1.0f32);
858 assert_approx_eq!(1.3f32.floor(), 1.0f32);
859 assert_approx_eq!(1.5f32.floor(), 1.0f32);
860 assert_approx_eq!(1.7f32.floor(), 1.0f32);
861 assert_approx_eq!(0.0f32.floor(), 0.0f32);
862 assert_approx_eq!((-0.0f32).floor(), -0.0f32);
863 assert_approx_eq!((-1.0f32).floor(), -1.0f32);
864 assert_approx_eq!((-1.3f32).floor(), -2.0f32);
865 assert_approx_eq!((-1.5f32).floor(), -2.0f32);
866 assert_approx_eq!((-1.7f32).floor(), -2.0f32);
871 assert_approx_eq!(1.0f32.ceil(), 1.0f32);
872 assert_approx_eq!(1.3f32.ceil(), 2.0f32);
873 assert_approx_eq!(1.5f32.ceil(), 2.0f32);
874 assert_approx_eq!(1.7f32.ceil(), 2.0f32);
875 assert_approx_eq!(0.0f32.ceil(), 0.0f32);
876 assert_approx_eq!((-0.0f32).ceil(), -0.0f32);
877 assert_approx_eq!((-1.0f32).ceil(), -1.0f32);
878 assert_approx_eq!((-1.3f32).ceil(), -1.0f32);
879 assert_approx_eq!((-1.5f32).ceil(), -1.0f32);
880 assert_approx_eq!((-1.7f32).ceil(), -1.0f32);
885 assert_approx_eq!(1.0f32.round(), 1.0f32);
886 assert_approx_eq!(1.3f32.round(), 1.0f32);
887 assert_approx_eq!(1.5f32.round(), 2.0f32);
888 assert_approx_eq!(1.7f32.round(), 2.0f32);
889 assert_approx_eq!(0.0f32.round(), 0.0f32);
890 assert_approx_eq!((-0.0f32).round(), -0.0f32);
891 assert_approx_eq!((-1.0f32).round(), -1.0f32);
892 assert_approx_eq!((-1.3f32).round(), -1.0f32);
893 assert_approx_eq!((-1.5f32).round(), -2.0f32);
894 assert_approx_eq!((-1.7f32).round(), -2.0f32);
899 assert_approx_eq!(1.0f32.trunc(), 1.0f32);
900 assert_approx_eq!(1.3f32.trunc(), 1.0f32);
901 assert_approx_eq!(1.5f32.trunc(), 1.0f32);
902 assert_approx_eq!(1.7f32.trunc(), 1.0f32);
903 assert_approx_eq!(0.0f32.trunc(), 0.0f32);
904 assert_approx_eq!((-0.0f32).trunc(), -0.0f32);
905 assert_approx_eq!((-1.0f32).trunc(), -1.0f32);
906 assert_approx_eq!((-1.3f32).trunc(), -1.0f32);
907 assert_approx_eq!((-1.5f32).trunc(), -1.0f32);
908 assert_approx_eq!((-1.7f32).trunc(), -1.0f32);
913 assert_approx_eq!(1.0f32.fract(), 0.0f32);
914 assert_approx_eq!(1.3f32.fract(), 0.3f32);
915 assert_approx_eq!(1.5f32.fract(), 0.5f32);
916 assert_approx_eq!(1.7f32.fract(), 0.7f32);
917 assert_approx_eq!(0.0f32.fract(), 0.0f32);
918 assert_approx_eq!((-0.0f32).fract(), -0.0f32);
919 assert_approx_eq!((-1.0f32).fract(), -0.0f32);
920 assert_approx_eq!((-1.3f32).fract(), -0.3f32);
921 assert_approx_eq!((-1.5f32).fract(), -0.5f32);
922 assert_approx_eq!((-1.7f32).fract(), -0.7f32);
927 assert_eq!(0.0f32.asinh(), 0.0f32);
928 assert_eq!((-0.0f32).asinh(), -0.0f32);
930 let inf: f32 = Float::infinity();
931 let neg_inf: f32 = Float::neg_infinity();
932 let nan: f32 = Float::nan();
933 assert_eq!(inf.asinh(), inf);
934 assert_eq!(neg_inf.asinh(), neg_inf);
935 assert!(nan.asinh().is_nan());
936 assert_approx_eq!(2.0f32.asinh(), 1.443635475178810342493276740273105f32);
937 assert_approx_eq!((-2.0f32).asinh(), -1.443635475178810342493276740273105f32);
942 assert_eq!(1.0f32.acosh(), 0.0f32);
943 assert!(0.999f32.acosh().is_nan());
945 let inf: f32 = Float::infinity();
946 let neg_inf: f32 = Float::neg_infinity();
947 let nan: f32 = Float::nan();
948 assert_eq!(inf.acosh(), inf);
949 assert!(neg_inf.acosh().is_nan());
950 assert!(nan.acosh().is_nan());
951 assert_approx_eq!(2.0f32.acosh(), 1.31695789692481670862504634730796844f32);
952 assert_approx_eq!(3.0f32.acosh(), 1.76274717403908605046521864995958461f32);
957 assert_eq!(0.0f32.atanh(), 0.0f32);
958 assert_eq!((-0.0f32).atanh(), -0.0f32);
960 let inf32: f32 = Float::infinity();
961 let neg_inf32: f32 = Float::neg_infinity();
962 assert_eq!(1.0f32.atanh(), inf32);
963 assert_eq!((-1.0f32).atanh(), neg_inf32);
965 assert!(2f64.atanh().atanh().is_nan());
966 assert!((-2f64).atanh().atanh().is_nan());
968 let inf64: f32 = Float::infinity();
969 let neg_inf64: f32 = Float::neg_infinity();
970 let nan32: f32 = Float::nan();
971 assert!(inf64.atanh().is_nan());
972 assert!(neg_inf64.atanh().is_nan());
973 assert!(nan32.atanh().is_nan());
975 assert_approx_eq!(0.5f32.atanh(), 0.54930614433405484569762261846126285f32);
976 assert_approx_eq!((-0.5f32).atanh(), -0.54930614433405484569762261846126285f32);
980 fn test_real_consts() {
981 let pi: f32 = Float::pi();
982 let two_pi: f32 = Float::two_pi();
983 let frac_pi_2: f32 = Float::frac_pi_2();
984 let frac_pi_3: f32 = Float::frac_pi_3();
985 let frac_pi_4: f32 = Float::frac_pi_4();
986 let frac_pi_6: f32 = Float::frac_pi_6();
987 let frac_pi_8: f32 = Float::frac_pi_8();
988 let frac_1_pi: f32 = Float::frac_1_pi();
989 let frac_2_pi: f32 = Float::frac_2_pi();
990 let frac_2_sqrtpi: f32 = Float::frac_2_sqrtpi();
991 let sqrt2: f32 = Float::sqrt2();
992 let frac_1_sqrt2: f32 = Float::frac_1_sqrt2();
993 let e: f32 = Float::e();
994 let log2_e: f32 = Float::log2_e();
995 let log10_e: f32 = Float::log10_e();
996 let ln_2: f32 = Float::ln_2();
997 let ln_10: f32 = Float::ln_10();
999 assert_approx_eq!(two_pi, 2f32 * pi);
1000 assert_approx_eq!(frac_pi_2, pi / 2f32);
1001 assert_approx_eq!(frac_pi_3, pi / 3f32);
1002 assert_approx_eq!(frac_pi_4, pi / 4f32);
1003 assert_approx_eq!(frac_pi_6, pi / 6f32);
1004 assert_approx_eq!(frac_pi_8, pi / 8f32);
1005 assert_approx_eq!(frac_1_pi, 1f32 / pi);
1006 assert_approx_eq!(frac_2_pi, 2f32 / pi);
1007 assert_approx_eq!(frac_2_sqrtpi, 2f32 / pi.sqrt());
1008 assert_approx_eq!(sqrt2, 2f32.sqrt());
1009 assert_approx_eq!(frac_1_sqrt2, 1f32 / 2f32.sqrt());
1010 assert_approx_eq!(log2_e, e.log2());
1011 assert_approx_eq!(log10_e, e.log10());
1012 assert_approx_eq!(ln_2, 2f32.ln());
1013 assert_approx_eq!(ln_10, 10f32.ln());
1018 assert_eq!(INFINITY.abs(), INFINITY);
1019 assert_eq!(1f32.abs(), 1f32);
1020 assert_eq!(0f32.abs(), 0f32);
1021 assert_eq!((-0f32).abs(), 0f32);
1022 assert_eq!((-1f32).abs(), 1f32);
1023 assert_eq!(NEG_INFINITY.abs(), INFINITY);
1024 assert_eq!((1f32/NEG_INFINITY).abs(), 0f32);
1025 assert!(NAN.abs().is_nan());
1030 assert_eq!((-1f32).abs_sub(&1f32), 0f32);
1031 assert_eq!(1f32.abs_sub(&1f32), 0f32);
1032 assert_eq!(1f32.abs_sub(&0f32), 1f32);
1033 assert_eq!(1f32.abs_sub(&-1f32), 2f32);
1034 assert_eq!(NEG_INFINITY.abs_sub(&0f32), 0f32);
1035 assert_eq!(INFINITY.abs_sub(&1f32), INFINITY);
1036 assert_eq!(0f32.abs_sub(&NEG_INFINITY), INFINITY);
1037 assert_eq!(0f32.abs_sub(&INFINITY), 0f32);
1041 fn test_abs_sub_nowin() {
1042 assert!(NAN.abs_sub(&-1f32).is_nan());
1043 assert!(1f32.abs_sub(&NAN).is_nan());
1048 assert_eq!(INFINITY.signum(), 1f32);
1049 assert_eq!(1f32.signum(), 1f32);
1050 assert_eq!(0f32.signum(), 1f32);
1051 assert_eq!((-0f32).signum(), -1f32);
1052 assert_eq!((-1f32).signum(), -1f32);
1053 assert_eq!(NEG_INFINITY.signum(), -1f32);
1054 assert_eq!((1f32/NEG_INFINITY).signum(), -1f32);
1055 assert!(NAN.signum().is_nan());
1059 fn test_is_positive() {
1060 assert!(INFINITY.is_positive());
1061 assert!(1f32.is_positive());
1062 assert!(0f32.is_positive());
1063 assert!(!(-0f32).is_positive());
1064 assert!(!(-1f32).is_positive());
1065 assert!(!NEG_INFINITY.is_positive());
1066 assert!(!(1f32/NEG_INFINITY).is_positive());
1067 assert!(!NAN.is_positive());
1071 fn test_is_negative() {
1072 assert!(!INFINITY.is_negative());
1073 assert!(!1f32.is_negative());
1074 assert!(!0f32.is_negative());
1075 assert!((-0f32).is_negative());
1076 assert!((-1f32).is_negative());
1077 assert!(NEG_INFINITY.is_negative());
1078 assert!((1f32/NEG_INFINITY).is_negative());
1079 assert!(!NAN.is_negative());
1083 fn test_is_normal() {
1084 let nan: f32 = Float::nan();
1085 let inf: f32 = Float::infinity();
1086 let neg_inf: f32 = Float::neg_infinity();
1087 let zero: f32 = Zero::zero();
1088 let neg_zero: f32 = Float::neg_zero();
1089 assert!(!nan.is_normal());
1090 assert!(!inf.is_normal());
1091 assert!(!neg_inf.is_normal());
1092 assert!(!zero.is_normal());
1093 assert!(!neg_zero.is_normal());
1094 assert!(1f32.is_normal());
1095 assert!(1e-37f32.is_normal());
1096 assert!(!1e-38f32.is_normal());
1100 fn test_classify() {
1101 let nan: f32 = Float::nan();
1102 let inf: f32 = Float::infinity();
1103 let neg_inf: f32 = Float::neg_infinity();
1104 let zero: f32 = Zero::zero();
1105 let neg_zero: f32 = Float::neg_zero();
1106 assert_eq!(nan.classify(), FPNaN);
1107 assert_eq!(inf.classify(), FPInfinite);
1108 assert_eq!(neg_inf.classify(), FPInfinite);
1109 assert_eq!(zero.classify(), FPZero);
1110 assert_eq!(neg_zero.classify(), FPZero);
1111 assert_eq!(1f32.classify(), FPNormal);
1112 assert_eq!(1e-37f32.classify(), FPNormal);
1113 assert_eq!(1e-38f32.classify(), FPSubnormal);
1118 // We have to use from_str until base-2 exponents
1119 // are supported in floating-point literals
1120 let f1: f32 = from_str_hex("1p-123").unwrap();
1121 let f2: f32 = from_str_hex("1p-111").unwrap();
1122 assert_eq!(Float::ldexp(1f32, -123), f1);
1123 assert_eq!(Float::ldexp(1f32, -111), f2);
1125 assert_eq!(Float::ldexp(0f32, -123), 0f32);
1126 assert_eq!(Float::ldexp(-0f32, -123), -0f32);
1128 let inf: f32 = Float::infinity();
1129 let neg_inf: f32 = Float::neg_infinity();
1130 let nan: f32 = Float::nan();
1131 assert_eq!(Float::ldexp(inf, -123), inf);
1132 assert_eq!(Float::ldexp(neg_inf, -123), neg_inf);
1133 assert!(Float::ldexp(nan, -123).is_nan());
1138 // We have to use from_str until base-2 exponents
1139 // are supported in floating-point literals
1140 let f1: f32 = from_str_hex("1p-123").unwrap();
1141 let f2: f32 = from_str_hex("1p-111").unwrap();
1142 let (x1, exp1) = f1.frexp();
1143 let (x2, exp2) = f2.frexp();
1144 assert_eq!((x1, exp1), (0.5f32, -122));
1145 assert_eq!((x2, exp2), (0.5f32, -110));
1146 assert_eq!(Float::ldexp(x1, exp1), f1);
1147 assert_eq!(Float::ldexp(x2, exp2), f2);
1149 assert_eq!(0f32.frexp(), (0f32, 0));
1150 assert_eq!((-0f32).frexp(), (-0f32, 0));
1153 #[test] #[ignore(cfg(windows))] // FIXME #8755
1154 fn test_frexp_nowin() {
1155 let inf: f32 = Float::infinity();
1156 let neg_inf: f32 = Float::neg_infinity();
1157 let nan: f32 = Float::nan();
1158 assert_eq!(match inf.frexp() { (x, _) => x }, inf)
1159 assert_eq!(match neg_inf.frexp() { (x, _) => x }, neg_inf)
1160 assert!(match nan.frexp() { (x, _) => x.is_nan() })
1164 fn test_integer_decode() {
1165 assert_eq!(3.14159265359f32.integer_decode(), (13176795u64, -22i16, 1i8));
1166 assert_eq!((-8573.5918555f32).integer_decode(), (8779358u64, -10i16, -1i8));
1167 assert_eq!(2f32.powf(&100.0).integer_decode(), (8388608u64, 77i16, 1i8));
1168 assert_eq!(0f32.integer_decode(), (0u64, -150i16, 1i8));
1169 assert_eq!((-0f32).integer_decode(), (0u64, -150i16, -1i8));
1170 assert_eq!(INFINITY.integer_decode(), (8388608u64, 105i16, 1i8));
1171 assert_eq!(NEG_INFINITY.integer_decode(), (8388608u64, 105i16, -1i8));
1172 assert_eq!(NAN.integer_decode(), (12582912u64, 105i16, 1i8));