1 //! Constants specific to the `f64` double-precision floating point type.
3 //! *[See also the `f64` primitive type](primitive@f64).*
5 //! Mathematically significant numbers are provided in the `consts` sub-module.
7 //! For the constants defined directly in this module
8 //! (as distinct from those defined in the `consts` sub-module),
9 //! new code should instead use the associated constants
10 //! defined directly on the `f64` type.
12 #![stable(feature = "rust1", since = "1.0.0")]
13 #![allow(missing_docs)]
19 use crate::intrinsics;
21 use crate::sys::cmath;
23 #[stable(feature = "rust1", since = "1.0.0")]
24 #[allow(deprecated, deprecated_in_future)]
26 consts, DIGITS, EPSILON, INFINITY, MANTISSA_DIGITS, MAX, MAX_10_EXP, MAX_EXP, MIN, MIN_10_EXP,
27 MIN_EXP, MIN_POSITIVE, NAN, NEG_INFINITY, RADIX,
31 #[lang = "f64_runtime"]
33 /// Returns the largest integer less than or equal to a number.
42 /// assert_eq!(f.floor(), 3.0);
43 /// assert_eq!(g.floor(), 3.0);
44 /// assert_eq!(h.floor(), -4.0);
46 #[must_use = "method returns a new number and does not mutate the original value"]
47 #[stable(feature = "rust1", since = "1.0.0")]
49 pub fn floor(self) -> f64 {
50 unsafe { intrinsics::floorf64(self) }
53 /// Returns the smallest integer greater than or equal to a number.
61 /// assert_eq!(f.ceil(), 4.0);
62 /// assert_eq!(g.ceil(), 4.0);
64 #[must_use = "method returns a new number and does not mutate the original value"]
65 #[stable(feature = "rust1", since = "1.0.0")]
67 pub fn ceil(self) -> f64 {
68 unsafe { intrinsics::ceilf64(self) }
71 /// Returns the nearest integer to a number. Round half-way cases away from
80 /// assert_eq!(f.round(), 3.0);
81 /// assert_eq!(g.round(), -3.0);
83 #[must_use = "method returns a new number and does not mutate the original value"]
84 #[stable(feature = "rust1", since = "1.0.0")]
86 pub fn round(self) -> f64 {
87 unsafe { intrinsics::roundf64(self) }
90 /// Returns the integer part of a number.
99 /// assert_eq!(f.trunc(), 3.0);
100 /// assert_eq!(g.trunc(), 3.0);
101 /// assert_eq!(h.trunc(), -3.0);
103 #[must_use = "method returns a new number and does not mutate the original value"]
104 #[stable(feature = "rust1", since = "1.0.0")]
106 pub fn trunc(self) -> f64 {
107 unsafe { intrinsics::truncf64(self) }
110 /// Returns the fractional part of a number.
116 /// let y = -3.6_f64;
117 /// let abs_difference_x = (x.fract() - 0.6).abs();
118 /// let abs_difference_y = (y.fract() - (-0.6)).abs();
120 /// assert!(abs_difference_x < 1e-10);
121 /// assert!(abs_difference_y < 1e-10);
123 #[must_use = "method returns a new number and does not mutate the original value"]
124 #[stable(feature = "rust1", since = "1.0.0")]
126 pub fn fract(self) -> f64 {
130 /// Computes the absolute value of `self`. Returns `NAN` if the
137 /// let y = -3.5_f64;
139 /// let abs_difference_x = (x.abs() - x).abs();
140 /// let abs_difference_y = (y.abs() - (-y)).abs();
142 /// assert!(abs_difference_x < 1e-10);
143 /// assert!(abs_difference_y < 1e-10);
145 /// assert!(f64::NAN.abs().is_nan());
147 #[must_use = "method returns a new number and does not mutate the original value"]
148 #[stable(feature = "rust1", since = "1.0.0")]
150 pub fn abs(self) -> f64 {
151 unsafe { intrinsics::fabsf64(self) }
154 /// Returns a number that represents the sign of `self`.
156 /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
157 /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
158 /// - `NAN` if the number is `NAN`
165 /// assert_eq!(f.signum(), 1.0);
166 /// assert_eq!(f64::NEG_INFINITY.signum(), -1.0);
168 /// assert!(f64::NAN.signum().is_nan());
170 #[must_use = "method returns a new number and does not mutate the original value"]
171 #[stable(feature = "rust1", since = "1.0.0")]
173 pub fn signum(self) -> f64 {
174 if self.is_nan() { Self::NAN } else { 1.0_f64.copysign(self) }
177 /// Returns a number composed of the magnitude of `self` and the sign of
180 /// Equal to `self` if the sign of `self` and `sign` are the same, otherwise
181 /// equal to `-self`. If `self` is a `NAN`, then a `NAN` with the sign of
182 /// `sign` is returned.
189 /// assert_eq!(f.copysign(0.42), 3.5_f64);
190 /// assert_eq!(f.copysign(-0.42), -3.5_f64);
191 /// assert_eq!((-f).copysign(0.42), 3.5_f64);
192 /// assert_eq!((-f).copysign(-0.42), -3.5_f64);
194 /// assert!(f64::NAN.copysign(1.0).is_nan());
196 #[must_use = "method returns a new number and does not mutate the original value"]
197 #[stable(feature = "copysign", since = "1.35.0")]
199 pub fn copysign(self, sign: f64) -> f64 {
200 unsafe { intrinsics::copysignf64(self, sign) }
203 /// Fused multiply-add. Computes `(self * a) + b` with only one rounding
204 /// error, yielding a more accurate result than an unfused multiply-add.
206 /// Using `mul_add` *may* be more performant than an unfused multiply-add if
207 /// the target architecture has a dedicated `fma` CPU instruction. However,
208 /// this is not always true, and will be heavily dependant on designing
209 /// algorithms with specific target hardware in mind.
214 /// let m = 10.0_f64;
216 /// let b = 60.0_f64;
219 /// let abs_difference = (m.mul_add(x, b) - ((m * x) + b)).abs();
221 /// assert!(abs_difference < 1e-10);
223 #[must_use = "method returns a new number and does not mutate the original value"]
224 #[stable(feature = "rust1", since = "1.0.0")]
226 pub fn mul_add(self, a: f64, b: f64) -> f64 {
227 unsafe { intrinsics::fmaf64(self, a, b) }
230 /// Calculates Euclidean division, the matching method for `rem_euclid`.
232 /// This computes the integer `n` such that
233 /// `self = n * rhs + self.rem_euclid(rhs)`.
234 /// In other words, the result is `self / rhs` rounded to the integer `n`
235 /// such that `self >= n * rhs`.
240 /// let a: f64 = 7.0;
242 /// assert_eq!(a.div_euclid(b), 1.0); // 7.0 > 4.0 * 1.0
243 /// assert_eq!((-a).div_euclid(b), -2.0); // -7.0 >= 4.0 * -2.0
244 /// assert_eq!(a.div_euclid(-b), -1.0); // 7.0 >= -4.0 * -1.0
245 /// assert_eq!((-a).div_euclid(-b), 2.0); // -7.0 >= -4.0 * 2.0
247 #[must_use = "method returns a new number and does not mutate the original value"]
249 #[stable(feature = "euclidean_division", since = "1.38.0")]
250 pub fn div_euclid(self, rhs: f64) -> f64 {
251 let q = (self / rhs).trunc();
252 if self % rhs < 0.0 {
253 return if rhs > 0.0 { q - 1.0 } else { q + 1.0 };
258 /// Calculates the least nonnegative remainder of `self (mod rhs)`.
260 /// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
261 /// most cases. However, due to a floating point round-off error it can
262 /// result in `r == rhs.abs()`, violating the mathematical definition, if
263 /// `self` is much smaller than `rhs.abs()` in magnitude and `self < 0.0`.
264 /// This result is not an element of the function's codomain, but it is the
265 /// closest floating point number in the real numbers and thus fulfills the
266 /// property `self == self.div_euclid(rhs) * rhs + self.rem_euclid(rhs)`
272 /// let a: f64 = 7.0;
274 /// assert_eq!(a.rem_euclid(b), 3.0);
275 /// assert_eq!((-a).rem_euclid(b), 1.0);
276 /// assert_eq!(a.rem_euclid(-b), 3.0);
277 /// assert_eq!((-a).rem_euclid(-b), 1.0);
278 /// // limitation due to round-off error
279 /// assert!((-f64::EPSILON).rem_euclid(3.0) != 0.0);
281 #[must_use = "method returns a new number and does not mutate the original value"]
283 #[stable(feature = "euclidean_division", since = "1.38.0")]
284 pub fn rem_euclid(self, rhs: f64) -> f64 {
286 if r < 0.0 { r + rhs.abs() } else { r }
289 /// Raises a number to an integer power.
291 /// Using this function is generally faster than using `powf`
297 /// let abs_difference = (x.powi(2) - (x * x)).abs();
299 /// assert!(abs_difference < 1e-10);
301 #[must_use = "method returns a new number and does not mutate the original value"]
302 #[stable(feature = "rust1", since = "1.0.0")]
304 pub fn powi(self, n: i32) -> f64 {
305 unsafe { intrinsics::powif64(self, n) }
308 /// Raises a number to a floating point power.
314 /// let abs_difference = (x.powf(2.0) - (x * x)).abs();
316 /// assert!(abs_difference < 1e-10);
318 #[must_use = "method returns a new number and does not mutate the original value"]
319 #[stable(feature = "rust1", since = "1.0.0")]
321 pub fn powf(self, n: f64) -> f64 {
322 unsafe { intrinsics::powf64(self, n) }
325 /// Returns the square root of a number.
327 /// Returns NaN if `self` is a negative number.
332 /// let positive = 4.0_f64;
333 /// let negative = -4.0_f64;
335 /// let abs_difference = (positive.sqrt() - 2.0).abs();
337 /// assert!(abs_difference < 1e-10);
338 /// assert!(negative.sqrt().is_nan());
340 #[must_use = "method returns a new number and does not mutate the original value"]
341 #[stable(feature = "rust1", since = "1.0.0")]
343 pub fn sqrt(self) -> f64 {
344 unsafe { intrinsics::sqrtf64(self) }
347 /// Returns `e^(self)`, (the exponential function).
352 /// let one = 1.0_f64;
354 /// let e = one.exp();
356 /// // ln(e) - 1 == 0
357 /// let abs_difference = (e.ln() - 1.0).abs();
359 /// assert!(abs_difference < 1e-10);
361 #[must_use = "method returns a new number and does not mutate the original value"]
362 #[stable(feature = "rust1", since = "1.0.0")]
364 pub fn exp(self) -> f64 {
365 unsafe { intrinsics::expf64(self) }
368 /// Returns `2^(self)`.
376 /// let abs_difference = (f.exp2() - 4.0).abs();
378 /// assert!(abs_difference < 1e-10);
380 #[must_use = "method returns a new number and does not mutate the original value"]
381 #[stable(feature = "rust1", since = "1.0.0")]
383 pub fn exp2(self) -> f64 {
384 unsafe { intrinsics::exp2f64(self) }
387 /// Returns the natural logarithm of the number.
392 /// let one = 1.0_f64;
394 /// let e = one.exp();
396 /// // ln(e) - 1 == 0
397 /// let abs_difference = (e.ln() - 1.0).abs();
399 /// assert!(abs_difference < 1e-10);
401 #[must_use = "method returns a new number and does not mutate the original value"]
402 #[stable(feature = "rust1", since = "1.0.0")]
404 pub fn ln(self) -> f64 {
405 self.log_wrapper(|n| unsafe { intrinsics::logf64(n) })
408 /// Returns the logarithm of the number with respect to an arbitrary base.
410 /// The result may not be correctly rounded owing to implementation details;
411 /// `self.log2()` can produce more accurate results for base 2, and
412 /// `self.log10()` can produce more accurate results for base 10.
417 /// let twenty_five = 25.0_f64;
419 /// // log5(25) - 2 == 0
420 /// let abs_difference = (twenty_five.log(5.0) - 2.0).abs();
422 /// assert!(abs_difference < 1e-10);
424 #[must_use = "method returns a new number and does not mutate the original value"]
425 #[stable(feature = "rust1", since = "1.0.0")]
427 pub fn log(self, base: f64) -> f64 {
428 self.ln() / base.ln()
431 /// Returns the base 2 logarithm of the number.
436 /// let four = 4.0_f64;
438 /// // log2(4) - 2 == 0
439 /// let abs_difference = (four.log2() - 2.0).abs();
441 /// assert!(abs_difference < 1e-10);
443 #[must_use = "method returns a new number and does not mutate the original value"]
444 #[stable(feature = "rust1", since = "1.0.0")]
446 pub fn log2(self) -> f64 {
447 self.log_wrapper(|n| {
448 #[cfg(target_os = "android")]
449 return crate::sys::android::log2f64(n);
450 #[cfg(not(target_os = "android"))]
451 return unsafe { intrinsics::log2f64(n) };
455 /// Returns the base 10 logarithm of the number.
460 /// let hundred = 100.0_f64;
462 /// // log10(100) - 2 == 0
463 /// let abs_difference = (hundred.log10() - 2.0).abs();
465 /// assert!(abs_difference < 1e-10);
467 #[must_use = "method returns a new number and does not mutate the original value"]
468 #[stable(feature = "rust1", since = "1.0.0")]
470 pub fn log10(self) -> f64 {
471 self.log_wrapper(|n| unsafe { intrinsics::log10f64(n) })
474 /// The positive difference of two numbers.
476 /// * If `self <= other`: `0:0`
477 /// * Else: `self - other`
483 /// let y = -3.0_f64;
485 /// let abs_difference_x = (x.abs_sub(1.0) - 2.0).abs();
486 /// let abs_difference_y = (y.abs_sub(1.0) - 0.0).abs();
488 /// assert!(abs_difference_x < 1e-10);
489 /// assert!(abs_difference_y < 1e-10);
491 #[must_use = "method returns a new number and does not mutate the original value"]
492 #[stable(feature = "rust1", since = "1.0.0")]
496 reason = "you probably meant `(self - other).abs()`: \
497 this operation is `(self - other).max(0.0)` \
498 except that `abs_sub` also propagates NaNs (also \
499 known as `fdim` in C). If you truly need the positive \
500 difference, consider using that expression or the C function \
501 `fdim`, depending on how you wish to handle NaN (please consider \
502 filing an issue describing your use-case too)."
504 pub fn abs_sub(self, other: f64) -> f64 {
505 unsafe { cmath::fdim(self, other) }
508 /// Returns the cube root of a number.
515 /// // x^(1/3) - 2 == 0
516 /// let abs_difference = (x.cbrt() - 2.0).abs();
518 /// assert!(abs_difference < 1e-10);
520 #[must_use = "method returns a new number and does not mutate the original value"]
521 #[stable(feature = "rust1", since = "1.0.0")]
523 pub fn cbrt(self) -> f64 {
524 unsafe { cmath::cbrt(self) }
527 /// Calculates the length of the hypotenuse of a right-angle triangle given
528 /// legs of length `x` and `y`.
536 /// // sqrt(x^2 + y^2)
537 /// let abs_difference = (x.hypot(y) - (x.powi(2) + y.powi(2)).sqrt()).abs();
539 /// assert!(abs_difference < 1e-10);
541 #[must_use = "method returns a new number and does not mutate the original value"]
542 #[stable(feature = "rust1", since = "1.0.0")]
544 pub fn hypot(self, other: f64) -> f64 {
545 unsafe { cmath::hypot(self, other) }
548 /// Computes the sine of a number (in radians).
553 /// let x = std::f64::consts::FRAC_PI_2;
555 /// let abs_difference = (x.sin() - 1.0).abs();
557 /// assert!(abs_difference < 1e-10);
559 #[must_use = "method returns a new number and does not mutate the original value"]
560 #[stable(feature = "rust1", since = "1.0.0")]
562 pub fn sin(self) -> f64 {
563 unsafe { intrinsics::sinf64(self) }
566 /// Computes the cosine of a number (in radians).
571 /// let x = 2.0 * std::f64::consts::PI;
573 /// let abs_difference = (x.cos() - 1.0).abs();
575 /// assert!(abs_difference < 1e-10);
577 #[must_use = "method returns a new number and does not mutate the original value"]
578 #[stable(feature = "rust1", since = "1.0.0")]
580 pub fn cos(self) -> f64 {
581 unsafe { intrinsics::cosf64(self) }
584 /// Computes the tangent of a number (in radians).
589 /// let x = std::f64::consts::FRAC_PI_4;
590 /// let abs_difference = (x.tan() - 1.0).abs();
592 /// assert!(abs_difference < 1e-14);
594 #[must_use = "method returns a new number and does not mutate the original value"]
595 #[stable(feature = "rust1", since = "1.0.0")]
597 pub fn tan(self) -> f64 {
598 unsafe { cmath::tan(self) }
601 /// Computes the arcsine of a number. Return value is in radians in
602 /// the range [-pi/2, pi/2] or NaN if the number is outside the range
608 /// let f = std::f64::consts::FRAC_PI_2;
610 /// // asin(sin(pi/2))
611 /// let abs_difference = (f.sin().asin() - std::f64::consts::FRAC_PI_2).abs();
613 /// assert!(abs_difference < 1e-10);
615 #[must_use = "method returns a new number and does not mutate the original value"]
616 #[stable(feature = "rust1", since = "1.0.0")]
618 pub fn asin(self) -> f64 {
619 unsafe { cmath::asin(self) }
622 /// Computes the arccosine of a number. Return value is in radians in
623 /// the range [0, pi] or NaN if the number is outside the range
629 /// let f = std::f64::consts::FRAC_PI_4;
631 /// // acos(cos(pi/4))
632 /// let abs_difference = (f.cos().acos() - std::f64::consts::FRAC_PI_4).abs();
634 /// assert!(abs_difference < 1e-10);
636 #[must_use = "method returns a new number and does not mutate the original value"]
637 #[stable(feature = "rust1", since = "1.0.0")]
639 pub fn acos(self) -> f64 {
640 unsafe { cmath::acos(self) }
643 /// Computes the arctangent of a number. Return value is in radians in the
644 /// range [-pi/2, pi/2];
652 /// let abs_difference = (f.tan().atan() - 1.0).abs();
654 /// assert!(abs_difference < 1e-10);
656 #[must_use = "method returns a new number and does not mutate the original value"]
657 #[stable(feature = "rust1", since = "1.0.0")]
659 pub fn atan(self) -> f64 {
660 unsafe { cmath::atan(self) }
663 /// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`) in radians.
665 /// * `x = 0`, `y = 0`: `0`
666 /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
667 /// * `y >= 0`: `arctan(y/x) + pi` -> `(pi/2, pi]`
668 /// * `y < 0`: `arctan(y/x) - pi` -> `(-pi, -pi/2)`
673 /// // Positive angles measured counter-clockwise
674 /// // from positive x axis
675 /// // -pi/4 radians (45 deg clockwise)
676 /// let x1 = 3.0_f64;
677 /// let y1 = -3.0_f64;
679 /// // 3pi/4 radians (135 deg counter-clockwise)
680 /// let x2 = -3.0_f64;
681 /// let y2 = 3.0_f64;
683 /// let abs_difference_1 = (y1.atan2(x1) - (-std::f64::consts::FRAC_PI_4)).abs();
684 /// let abs_difference_2 = (y2.atan2(x2) - (3.0 * std::f64::consts::FRAC_PI_4)).abs();
686 /// assert!(abs_difference_1 < 1e-10);
687 /// assert!(abs_difference_2 < 1e-10);
689 #[must_use = "method returns a new number and does not mutate the original value"]
690 #[stable(feature = "rust1", since = "1.0.0")]
692 pub fn atan2(self, other: f64) -> f64 {
693 unsafe { cmath::atan2(self, other) }
696 /// Simultaneously computes the sine and cosine of the number, `x`. Returns
697 /// `(sin(x), cos(x))`.
702 /// let x = std::f64::consts::FRAC_PI_4;
703 /// let f = x.sin_cos();
705 /// let abs_difference_0 = (f.0 - x.sin()).abs();
706 /// let abs_difference_1 = (f.1 - x.cos()).abs();
708 /// assert!(abs_difference_0 < 1e-10);
709 /// assert!(abs_difference_1 < 1e-10);
711 #[stable(feature = "rust1", since = "1.0.0")]
713 pub fn sin_cos(self) -> (f64, f64) {
714 (self.sin(), self.cos())
717 /// Returns `e^(self) - 1` in a way that is accurate even if the
718 /// number is close to zero.
723 /// let x = 1e-16_f64;
725 /// // for very small x, e^x is approximately 1 + x + x^2 / 2
726 /// let approx = x + x * x / 2.0;
727 /// let abs_difference = (x.exp_m1() - approx).abs();
729 /// assert!(abs_difference < 1e-20);
731 #[must_use = "method returns a new number and does not mutate the original value"]
732 #[stable(feature = "rust1", since = "1.0.0")]
734 pub fn exp_m1(self) -> f64 {
735 unsafe { cmath::expm1(self) }
738 /// Returns `ln(1+n)` (natural logarithm) more accurately than if
739 /// the operations were performed separately.
744 /// let x = 1e-16_f64;
746 /// // for very small x, ln(1 + x) is approximately x - x^2 / 2
747 /// let approx = x - x * x / 2.0;
748 /// let abs_difference = (x.ln_1p() - approx).abs();
750 /// assert!(abs_difference < 1e-20);
752 #[must_use = "method returns a new number and does not mutate the original value"]
753 #[stable(feature = "rust1", since = "1.0.0")]
755 pub fn ln_1p(self) -> f64 {
756 unsafe { cmath::log1p(self) }
759 /// Hyperbolic sine function.
764 /// let e = std::f64::consts::E;
767 /// let f = x.sinh();
768 /// // Solving sinh() at 1 gives `(e^2-1)/(2e)`
769 /// let g = ((e * e) - 1.0) / (2.0 * e);
770 /// let abs_difference = (f - g).abs();
772 /// assert!(abs_difference < 1e-10);
774 #[must_use = "method returns a new number and does not mutate the original value"]
775 #[stable(feature = "rust1", since = "1.0.0")]
777 pub fn sinh(self) -> f64 {
778 unsafe { cmath::sinh(self) }
781 /// Hyperbolic cosine function.
786 /// let e = std::f64::consts::E;
788 /// let f = x.cosh();
789 /// // Solving cosh() at 1 gives this result
790 /// let g = ((e * e) + 1.0) / (2.0 * e);
791 /// let abs_difference = (f - g).abs();
794 /// assert!(abs_difference < 1.0e-10);
796 #[must_use = "method returns a new number and does not mutate the original value"]
797 #[stable(feature = "rust1", since = "1.0.0")]
799 pub fn cosh(self) -> f64 {
800 unsafe { cmath::cosh(self) }
803 /// Hyperbolic tangent function.
808 /// let e = std::f64::consts::E;
811 /// let f = x.tanh();
812 /// // Solving tanh() at 1 gives `(1 - e^(-2))/(1 + e^(-2))`
813 /// let g = (1.0 - e.powi(-2)) / (1.0 + e.powi(-2));
814 /// let abs_difference = (f - g).abs();
816 /// assert!(abs_difference < 1.0e-10);
818 #[must_use = "method returns a new number and does not mutate the original value"]
819 #[stable(feature = "rust1", since = "1.0.0")]
821 pub fn tanh(self) -> f64 {
822 unsafe { cmath::tanh(self) }
825 /// Inverse hyperbolic sine function.
831 /// let f = x.sinh().asinh();
833 /// let abs_difference = (f - x).abs();
835 /// assert!(abs_difference < 1.0e-10);
837 #[must_use = "method returns a new number and does not mutate the original value"]
838 #[stable(feature = "rust1", since = "1.0.0")]
840 pub fn asinh(self) -> f64 {
841 (self.abs() + ((self * self) + 1.0).sqrt()).ln().copysign(self)
844 /// Inverse hyperbolic cosine function.
850 /// let f = x.cosh().acosh();
852 /// let abs_difference = (f - x).abs();
854 /// assert!(abs_difference < 1.0e-10);
856 #[must_use = "method returns a new number and does not mutate the original value"]
857 #[stable(feature = "rust1", since = "1.0.0")]
859 pub fn acosh(self) -> f64 {
860 if self < 1.0 { Self::NAN } else { (self + ((self * self) - 1.0).sqrt()).ln() }
863 /// Inverse hyperbolic tangent function.
868 /// let e = std::f64::consts::E;
869 /// let f = e.tanh().atanh();
871 /// let abs_difference = (f - e).abs();
873 /// assert!(abs_difference < 1.0e-10);
875 #[must_use = "method returns a new number and does not mutate the original value"]
876 #[stable(feature = "rust1", since = "1.0.0")]
878 pub fn atanh(self) -> f64 {
879 0.5 * ((2.0 * self) / (1.0 - self)).ln_1p()
882 // Solaris/Illumos requires a wrapper around log, log2, and log10 functions
883 // because of their non-standard behavior (e.g., log(-n) returns -Inf instead
885 fn log_wrapper<F: Fn(f64) -> f64>(self, log_fn: F) -> f64 {
886 if !cfg!(any(target_os = "solaris", target_os = "illumos")) {
888 } else if self.is_finite() {
891 } else if self == 0.0 {
892 Self::NEG_INFINITY // log(0) = -Inf
894 Self::NAN // log(-n) = NaN
896 } else if self.is_nan() {
897 self // log(NaN) = NaN
898 } else if self > 0.0 {
899 self // log(Inf) = Inf
901 Self::NAN // log(-Inf) = NaN