]> git.lizzy.rs Git - rust.git/blob - src/libstd/f32.rs
4ae8d2dcf16b09ca2432da8bf3dd948e9875ddab
[rust.git] / src / libstd / f32.rs
1 // Copyright 2012-2015 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 //! This module provides constants which are specific to the implementation
12 //! of the `f32` floating point data type.
13 //!
14 //! *[See also the `f32` primitive type](../../std/primitive.f32.html).*
15 //!
16 //! Mathematically significant numbers are provided in the `consts` sub-module.
17
18 #![stable(feature = "rust1", since = "1.0.0")]
19 #![allow(missing_docs)]
20
21 #[cfg(not(test))]
22 use intrinsics;
23 #[cfg(not(test))]
24 use sys::cmath;
25
26 #[stable(feature = "rust1", since = "1.0.0")]
27 pub use core::f32::{RADIX, MANTISSA_DIGITS, DIGITS, EPSILON};
28 #[stable(feature = "rust1", since = "1.0.0")]
29 pub use core::f32::{MIN_EXP, MAX_EXP, MIN_10_EXP};
30 #[stable(feature = "rust1", since = "1.0.0")]
31 pub use core::f32::{MAX_10_EXP, NAN, INFINITY, NEG_INFINITY};
32 #[stable(feature = "rust1", since = "1.0.0")]
33 pub use core::f32::{MIN, MIN_POSITIVE, MAX};
34 #[stable(feature = "rust1", since = "1.0.0")]
35 pub use core::f32::consts;
36
37 #[cfg(not(test))]
38 #[lang = "f32_runtime"]
39 impl f32 {
40     /// Returns the largest integer less than or equal to a number.
41     ///
42     /// # Examples
43     ///
44     /// ```
45     /// let f = 3.99_f32;
46     /// let g = 3.0_f32;
47     ///
48     /// assert_eq!(f.floor(), 3.0);
49     /// assert_eq!(g.floor(), 3.0);
50     /// ```
51     #[stable(feature = "rust1", since = "1.0.0")]
52     #[inline]
53     pub fn floor(self) -> f32 {
54         // On MSVC LLVM will lower many math intrinsics to a call to the
55         // corresponding function. On MSVC, however, many of these functions
56         // aren't actually available as symbols to call, but rather they are all
57         // `static inline` functions in header files. This means that from a C
58         // perspective it's "compatible", but not so much from an ABI
59         // perspective (which we're worried about).
60         //
61         // The inline header functions always just cast to a f64 and do their
62         // operation, so we do that here as well, but only for MSVC targets.
63         //
64         // Note that there are many MSVC-specific float operations which
65         // redirect to this comment, so `floorf` is just one case of a missing
66         // function on MSVC, but there are many others elsewhere.
67         #[cfg(target_env = "msvc")]
68         return (self as f64).floor() as f32;
69         #[cfg(not(target_env = "msvc"))]
70         return unsafe { intrinsics::floorf32(self) };
71     }
72
73     /// Returns the smallest integer greater than or equal to a number.
74     ///
75     /// # Examples
76     ///
77     /// ```
78     /// let f = 3.01_f32;
79     /// let g = 4.0_f32;
80     ///
81     /// assert_eq!(f.ceil(), 4.0);
82     /// assert_eq!(g.ceil(), 4.0);
83     /// ```
84     #[stable(feature = "rust1", since = "1.0.0")]
85     #[inline]
86     pub fn ceil(self) -> f32 {
87         // see notes above in `floor`
88         #[cfg(target_env = "msvc")]
89         return (self as f64).ceil() as f32;
90         #[cfg(not(target_env = "msvc"))]
91         return unsafe { intrinsics::ceilf32(self) };
92     }
93
94     /// Returns the nearest integer to a number. Round half-way cases away from
95     /// `0.0`.
96     ///
97     /// # Examples
98     ///
99     /// ```
100     /// let f = 3.3_f32;
101     /// let g = -3.3_f32;
102     ///
103     /// assert_eq!(f.round(), 3.0);
104     /// assert_eq!(g.round(), -3.0);
105     /// ```
106     #[stable(feature = "rust1", since = "1.0.0")]
107     #[inline]
108     pub fn round(self) -> f32 {
109         unsafe { intrinsics::roundf32(self) }
110     }
111
112     /// Returns the integer part of a number.
113     ///
114     /// # Examples
115     ///
116     /// ```
117     /// let f = 3.3_f32;
118     /// let g = -3.7_f32;
119     ///
120     /// assert_eq!(f.trunc(), 3.0);
121     /// assert_eq!(g.trunc(), -3.0);
122     /// ```
123     #[stable(feature = "rust1", since = "1.0.0")]
124     #[inline]
125     pub fn trunc(self) -> f32 {
126         unsafe { intrinsics::truncf32(self) }
127     }
128
129     /// Returns the fractional part of a number.
130     ///
131     /// # Examples
132     ///
133     /// ```
134     /// use std::f32;
135     ///
136     /// let x = 3.5_f32;
137     /// let y = -3.5_f32;
138     /// let abs_difference_x = (x.fract() - 0.5).abs();
139     /// let abs_difference_y = (y.fract() - (-0.5)).abs();
140     ///
141     /// assert!(abs_difference_x <= f32::EPSILON);
142     /// assert!(abs_difference_y <= f32::EPSILON);
143     /// ```
144     #[stable(feature = "rust1", since = "1.0.0")]
145     #[inline]
146     pub fn fract(self) -> f32 { self - self.trunc() }
147
148     /// Computes the absolute value of `self`. Returns `NAN` if the
149     /// number is `NAN`.
150     ///
151     /// # Examples
152     ///
153     /// ```
154     /// use std::f32;
155     ///
156     /// let x = 3.5_f32;
157     /// let y = -3.5_f32;
158     ///
159     /// let abs_difference_x = (x.abs() - x).abs();
160     /// let abs_difference_y = (y.abs() - (-y)).abs();
161     ///
162     /// assert!(abs_difference_x <= f32::EPSILON);
163     /// assert!(abs_difference_y <= f32::EPSILON);
164     ///
165     /// assert!(f32::NAN.abs().is_nan());
166     /// ```
167     #[stable(feature = "rust1", since = "1.0.0")]
168     #[inline]
169     pub fn abs(self) -> f32 {
170         unsafe { intrinsics::fabsf32(self) }
171     }
172
173     /// Returns a number that represents the sign of `self`.
174     ///
175     /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
176     /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
177     /// - `NAN` if the number is `NAN`
178     ///
179     /// # Examples
180     ///
181     /// ```
182     /// use std::f32;
183     ///
184     /// let f = 3.5_f32;
185     ///
186     /// assert_eq!(f.signum(), 1.0);
187     /// assert_eq!(f32::NEG_INFINITY.signum(), -1.0);
188     ///
189     /// assert!(f32::NAN.signum().is_nan());
190     /// ```
191     #[stable(feature = "rust1", since = "1.0.0")]
192     #[inline]
193     pub fn signum(self) -> f32 {
194         if self.is_nan() {
195             NAN
196         } else {
197             unsafe { intrinsics::copysignf32(1.0, self) }
198         }
199     }
200
201     /// Returns a number composed of the magnitude of one number and the sign of
202     /// another.
203     ///
204     /// Equal to `self` if the sign of `self` and `y` are the same, otherwise
205     /// equal to `-y`. If `self` is a `NAN`, then a `NAN` with the sign of `y`
206     /// is returned.
207     ///
208     /// # Examples
209     ///
210     /// ```
211     /// #![feature(copysign)]
212     /// use std::f32;
213     ///
214     /// let f = 3.5_f32;
215     ///
216     /// assert_eq!(f.copysign(0.42), 3.5_f32);
217     /// assert_eq!(f.copysign(-0.42), -3.5_f32);
218     /// assert_eq!((-f).copysign(0.42), 3.5_f32);
219     /// assert_eq!((-f).copysign(-0.42), -3.5_f32);
220     ///
221     /// assert!(f32::NAN.copysign(1.0).is_nan());
222     /// ```
223     #[inline]
224     #[unstable(feature="copysign", issue="0")]
225     pub fn copysign(self, y: f32) -> f32 {
226         unsafe { intrinsics::copysignf32(self, y) }
227     }
228
229     /// Fused multiply-add. Computes `(self * a) + b` with only one rounding
230     /// error, yielding a more accurate result than an unfused multiply-add.
231     ///
232     /// Using `mul_add` can be more performant than an unfused multiply-add if
233     /// the target architecture has a dedicated `fma` CPU instruction.
234     ///
235     /// # Examples
236     ///
237     /// ```
238     /// use std::f32;
239     ///
240     /// let m = 10.0_f32;
241     /// let x = 4.0_f32;
242     /// let b = 60.0_f32;
243     ///
244     /// // 100.0
245     /// let abs_difference = (m.mul_add(x, b) - (m*x + b)).abs();
246     ///
247     /// assert!(abs_difference <= f32::EPSILON);
248     /// ```
249     #[stable(feature = "rust1", since = "1.0.0")]
250     #[inline]
251     pub fn mul_add(self, a: f32, b: f32) -> f32 {
252         unsafe { intrinsics::fmaf32(self, a, b) }
253     }
254
255     /// Calculates Euclidean division, the matching method for `mod_euc`.
256     ///
257     /// This computes the integer `n` such that
258     /// `self = n * rhs + self.mod_euc(rhs)`.
259     /// In other words, the result is `self / rhs` rounded to the integer `n`
260     /// such that `self >= n * rhs`.
261     ///
262     /// # Examples
263     ///
264     /// ```
265     /// #![feature(euclidean_division)]
266     /// let a: f32 = 7.0;
267     /// let b = 4.0;
268     /// assert_eq!(a.div_euc(b), 1.0); // 7.0 > 4.0 * 1.0
269     /// assert_eq!((-a).div_euc(b), -2.0); // -7.0 >= 4.0 * -2.0
270     /// assert_eq!(a.div_euc(-b), -1.0); // 7.0 >= -4.0 * -1.0
271     /// assert_eq!((-a).div_euc(-b), 2.0); // -7.0 >= -4.0 * 2.0
272     /// ```
273     #[inline]
274     #[unstable(feature = "euclidean_division", issue = "49048")]
275     pub fn div_euc(self, rhs: f32) -> f32 {
276         let q = (self / rhs).trunc();
277         if self % rhs < 0.0 {
278             return if rhs > 0.0 { q - 1.0 } else { q + 1.0 }
279         }
280         q
281     }
282
283     /// Calculates the Euclidean modulo (self mod rhs), which is never negative.
284     ///
285     /// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
286     /// most cases. However, due to a floating point round-off error it can
287     /// result in `r == rhs.abs()`, violating the mathematical definition, if
288     /// `self` is much smaller than `rhs.abs()` in magnitude and `self < 0.0`.
289     /// This result is not an element of the function's codomain, but it is the
290     /// closest floating point number in the real numbers and thus fulfills the
291     /// property `self == self.div_euc(rhs) * rhs + self.mod_euc(rhs)`
292     /// approximatively.
293     ///
294     /// # Examples
295     ///
296     /// ```
297     /// #![feature(euclidean_division)]
298     /// let a: f32 = 7.0;
299     /// let b = 4.0;
300     /// assert_eq!(a.mod_euc(b), 3.0);
301     /// assert_eq!((-a).mod_euc(b), 1.0);
302     /// assert_eq!(a.mod_euc(-b), 3.0);
303     /// assert_eq!((-a).mod_euc(-b), 1.0);
304     /// // limitation due to round-off error
305     /// assert!((-std::f32::EPSILON).mod_euc(3.0) != 0.0);
306     /// ```
307     #[inline]
308     #[unstable(feature = "euclidean_division", issue = "49048")]
309     pub fn mod_euc(self, rhs: f32) -> f32 {
310         let r = self % rhs;
311         if r < 0.0 {
312             r + rhs.abs()
313         } else {
314             r
315         }
316     }
317
318
319     /// Raises a number to an integer power.
320     ///
321     /// Using this function is generally faster than using `powf`
322     ///
323     /// # Examples
324     ///
325     /// ```
326     /// use std::f32;
327     ///
328     /// let x = 2.0_f32;
329     /// let abs_difference = (x.powi(2) - x*x).abs();
330     ///
331     /// assert!(abs_difference <= f32::EPSILON);
332     /// ```
333     #[stable(feature = "rust1", since = "1.0.0")]
334     #[inline]
335     pub fn powi(self, n: i32) -> f32 {
336         unsafe { intrinsics::powif32(self, n) }
337     }
338
339     /// Raises a number to a floating point power.
340     ///
341     /// # Examples
342     ///
343     /// ```
344     /// use std::f32;
345     ///
346     /// let x = 2.0_f32;
347     /// let abs_difference = (x.powf(2.0) - x*x).abs();
348     ///
349     /// assert!(abs_difference <= f32::EPSILON);
350     /// ```
351     #[stable(feature = "rust1", since = "1.0.0")]
352     #[inline]
353     pub fn powf(self, n: f32) -> f32 {
354         // see notes above in `floor`
355         #[cfg(target_env = "msvc")]
356         return (self as f64).powf(n as f64) as f32;
357         #[cfg(not(target_env = "msvc"))]
358         return unsafe { intrinsics::powf32(self, n) };
359     }
360
361     /// Takes the square root of a number.
362     ///
363     /// Returns NaN if `self` is a negative number.
364     ///
365     /// # Examples
366     ///
367     /// ```
368     /// use std::f32;
369     ///
370     /// let positive = 4.0_f32;
371     /// let negative = -4.0_f32;
372     ///
373     /// let abs_difference = (positive.sqrt() - 2.0).abs();
374     ///
375     /// assert!(abs_difference <= f32::EPSILON);
376     /// assert!(negative.sqrt().is_nan());
377     /// ```
378     #[stable(feature = "rust1", since = "1.0.0")]
379     #[inline]
380     pub fn sqrt(self) -> f32 {
381         if self < 0.0 {
382             NAN
383         } else {
384             unsafe { intrinsics::sqrtf32(self) }
385         }
386     }
387
388     /// Returns `e^(self)`, (the exponential function).
389     ///
390     /// # Examples
391     ///
392     /// ```
393     /// use std::f32;
394     ///
395     /// let one = 1.0f32;
396     /// // e^1
397     /// let e = one.exp();
398     ///
399     /// // ln(e) - 1 == 0
400     /// let abs_difference = (e.ln() - 1.0).abs();
401     ///
402     /// assert!(abs_difference <= f32::EPSILON);
403     /// ```
404     #[stable(feature = "rust1", since = "1.0.0")]
405     #[inline]
406     pub fn exp(self) -> f32 {
407         // see notes above in `floor`
408         #[cfg(target_env = "msvc")]
409         return (self as f64).exp() as f32;
410         #[cfg(not(target_env = "msvc"))]
411         return unsafe { intrinsics::expf32(self) };
412     }
413
414     /// Returns `2^(self)`.
415     ///
416     /// # Examples
417     ///
418     /// ```
419     /// use std::f32;
420     ///
421     /// let f = 2.0f32;
422     ///
423     /// // 2^2 - 4 == 0
424     /// let abs_difference = (f.exp2() - 4.0).abs();
425     ///
426     /// assert!(abs_difference <= f32::EPSILON);
427     /// ```
428     #[stable(feature = "rust1", since = "1.0.0")]
429     #[inline]
430     pub fn exp2(self) -> f32 {
431         unsafe { intrinsics::exp2f32(self) }
432     }
433
434     /// Returns the natural logarithm of the number.
435     ///
436     /// # Examples
437     ///
438     /// ```
439     /// use std::f32;
440     ///
441     /// let one = 1.0f32;
442     /// // e^1
443     /// let e = one.exp();
444     ///
445     /// // ln(e) - 1 == 0
446     /// let abs_difference = (e.ln() - 1.0).abs();
447     ///
448     /// assert!(abs_difference <= f32::EPSILON);
449     /// ```
450     #[stable(feature = "rust1", since = "1.0.0")]
451     #[inline]
452     pub fn ln(self) -> f32 {
453         // see notes above in `floor`
454         #[cfg(target_env = "msvc")]
455         return (self as f64).ln() as f32;
456         #[cfg(not(target_env = "msvc"))]
457         return unsafe { intrinsics::logf32(self) };
458     }
459
460     /// Returns the logarithm of the number with respect to an arbitrary base.
461     ///
462     /// The result may not be correctly rounded owing to implementation details;
463     /// `self.log2()` can produce more accurate results for base 2, and
464     /// `self.log10()` can produce more accurate results for base 10.
465     ///
466     /// # Examples
467     ///
468     /// ```
469     /// use std::f32;
470     ///
471     /// let five = 5.0f32;
472     ///
473     /// // log5(5) - 1 == 0
474     /// let abs_difference = (five.log(5.0) - 1.0).abs();
475     ///
476     /// assert!(abs_difference <= f32::EPSILON);
477     /// ```
478     #[stable(feature = "rust1", since = "1.0.0")]
479     #[inline]
480     pub fn log(self, base: f32) -> f32 { self.ln() / base.ln() }
481
482     /// Returns the base 2 logarithm of the number.
483     ///
484     /// # Examples
485     ///
486     /// ```
487     /// use std::f32;
488     ///
489     /// let two = 2.0f32;
490     ///
491     /// // log2(2) - 1 == 0
492     /// let abs_difference = (two.log2() - 1.0).abs();
493     ///
494     /// assert!(abs_difference <= f32::EPSILON);
495     /// ```
496     #[stable(feature = "rust1", since = "1.0.0")]
497     #[inline]
498     pub fn log2(self) -> f32 {
499         #[cfg(target_os = "android")]
500         return ::sys::android::log2f32(self);
501         #[cfg(not(target_os = "android"))]
502         return unsafe { intrinsics::log2f32(self) };
503     }
504
505     /// Returns the base 10 logarithm of the number.
506     ///
507     /// # Examples
508     ///
509     /// ```
510     /// use std::f32;
511     ///
512     /// let ten = 10.0f32;
513     ///
514     /// // log10(10) - 1 == 0
515     /// let abs_difference = (ten.log10() - 1.0).abs();
516     ///
517     /// assert!(abs_difference <= f32::EPSILON);
518     /// ```
519     #[stable(feature = "rust1", since = "1.0.0")]
520     #[inline]
521     pub fn log10(self) -> f32 {
522         // see notes above in `floor`
523         #[cfg(target_env = "msvc")]
524         return (self as f64).log10() as f32;
525         #[cfg(not(target_env = "msvc"))]
526         return unsafe { intrinsics::log10f32(self) };
527     }
528
529     /// The positive difference of two numbers.
530     ///
531     /// * If `self <= other`: `0:0`
532     /// * Else: `self - other`
533     ///
534     /// # Examples
535     ///
536     /// ```
537     /// use std::f32;
538     ///
539     /// let x = 3.0f32;
540     /// let y = -3.0f32;
541     ///
542     /// let abs_difference_x = (x.abs_sub(1.0) - 2.0).abs();
543     /// let abs_difference_y = (y.abs_sub(1.0) - 0.0).abs();
544     ///
545     /// assert!(abs_difference_x <= f32::EPSILON);
546     /// assert!(abs_difference_y <= f32::EPSILON);
547     /// ```
548     #[stable(feature = "rust1", since = "1.0.0")]
549     #[inline]
550     #[rustc_deprecated(since = "1.10.0",
551                        reason = "you probably meant `(self - other).abs()`: \
552                                  this operation is `(self - other).max(0.0)` (also \
553                                  known as `fdimf` in C). If you truly need the positive \
554                                  difference, consider using that expression or the C function \
555                                  `fdimf`, depending on how you wish to handle NaN (please consider \
556                                  filing an issue describing your use-case too).")]
557     pub fn abs_sub(self, other: f32) -> f32 {
558         unsafe { cmath::fdimf(self, other) }
559     }
560
561     /// Takes the cubic root of a number.
562     ///
563     /// # Examples
564     ///
565     /// ```
566     /// use std::f32;
567     ///
568     /// let x = 8.0f32;
569     ///
570     /// // x^(1/3) - 2 == 0
571     /// let abs_difference = (x.cbrt() - 2.0).abs();
572     ///
573     /// assert!(abs_difference <= f32::EPSILON);
574     /// ```
575     #[stable(feature = "rust1", since = "1.0.0")]
576     #[inline]
577     pub fn cbrt(self) -> f32 {
578         unsafe { cmath::cbrtf(self) }
579     }
580
581     /// Calculates the length of the hypotenuse of a right-angle triangle given
582     /// legs of length `x` and `y`.
583     ///
584     /// # Examples
585     ///
586     /// ```
587     /// use std::f32;
588     ///
589     /// let x = 2.0f32;
590     /// let y = 3.0f32;
591     ///
592     /// // sqrt(x^2 + y^2)
593     /// let abs_difference = (x.hypot(y) - (x.powi(2) + y.powi(2)).sqrt()).abs();
594     ///
595     /// assert!(abs_difference <= f32::EPSILON);
596     /// ```
597     #[stable(feature = "rust1", since = "1.0.0")]
598     #[inline]
599     pub fn hypot(self, other: f32) -> f32 {
600         unsafe { cmath::hypotf(self, other) }
601     }
602
603     /// Computes the sine of a number (in radians).
604     ///
605     /// # Examples
606     ///
607     /// ```
608     /// use std::f32;
609     ///
610     /// let x = f32::consts::PI/2.0;
611     ///
612     /// let abs_difference = (x.sin() - 1.0).abs();
613     ///
614     /// assert!(abs_difference <= f32::EPSILON);
615     /// ```
616     #[stable(feature = "rust1", since = "1.0.0")]
617     #[inline]
618     pub fn sin(self) -> f32 {
619         // see notes in `core::f32::Float::floor`
620         #[cfg(target_env = "msvc")]
621         return (self as f64).sin() as f32;
622         #[cfg(not(target_env = "msvc"))]
623         return unsafe { intrinsics::sinf32(self) };
624     }
625
626     /// Computes the cosine of a number (in radians).
627     ///
628     /// # Examples
629     ///
630     /// ```
631     /// use std::f32;
632     ///
633     /// let x = 2.0*f32::consts::PI;
634     ///
635     /// let abs_difference = (x.cos() - 1.0).abs();
636     ///
637     /// assert!(abs_difference <= f32::EPSILON);
638     /// ```
639     #[stable(feature = "rust1", since = "1.0.0")]
640     #[inline]
641     pub fn cos(self) -> f32 {
642         // see notes in `core::f32::Float::floor`
643         #[cfg(target_env = "msvc")]
644         return (self as f64).cos() as f32;
645         #[cfg(not(target_env = "msvc"))]
646         return unsafe { intrinsics::cosf32(self) };
647     }
648
649     /// Computes the tangent of a number (in radians).
650     ///
651     /// # Examples
652     ///
653     /// ```
654     /// use std::f32;
655     ///
656     /// let x = f32::consts::PI / 4.0;
657     /// let abs_difference = (x.tan() - 1.0).abs();
658     ///
659     /// assert!(abs_difference <= f32::EPSILON);
660     /// ```
661     #[stable(feature = "rust1", since = "1.0.0")]
662     #[inline]
663     pub fn tan(self) -> f32 {
664         unsafe { cmath::tanf(self) }
665     }
666
667     /// Computes the arcsine of a number. Return value is in radians in
668     /// the range [-pi/2, pi/2] or NaN if the number is outside the range
669     /// [-1, 1].
670     ///
671     /// # Examples
672     ///
673     /// ```
674     /// use std::f32;
675     ///
676     /// let f = f32::consts::PI / 2.0;
677     ///
678     /// // asin(sin(pi/2))
679     /// let abs_difference = (f.sin().asin() - f32::consts::PI / 2.0).abs();
680     ///
681     /// assert!(abs_difference <= f32::EPSILON);
682     /// ```
683     #[stable(feature = "rust1", since = "1.0.0")]
684     #[inline]
685     pub fn asin(self) -> f32 {
686         unsafe { cmath::asinf(self) }
687     }
688
689     /// Computes the arccosine of a number. Return value is in radians in
690     /// the range [0, pi] or NaN if the number is outside the range
691     /// [-1, 1].
692     ///
693     /// # Examples
694     ///
695     /// ```
696     /// use std::f32;
697     ///
698     /// let f = f32::consts::PI / 4.0;
699     ///
700     /// // acos(cos(pi/4))
701     /// let abs_difference = (f.cos().acos() - f32::consts::PI / 4.0).abs();
702     ///
703     /// assert!(abs_difference <= f32::EPSILON);
704     /// ```
705     #[stable(feature = "rust1", since = "1.0.0")]
706     #[inline]
707     pub fn acos(self) -> f32 {
708         unsafe { cmath::acosf(self) }
709     }
710
711     /// Computes the arctangent of a number. Return value is in radians in the
712     /// range [-pi/2, pi/2];
713     ///
714     /// # Examples
715     ///
716     /// ```
717     /// use std::f32;
718     ///
719     /// let f = 1.0f32;
720     ///
721     /// // atan(tan(1))
722     /// let abs_difference = (f.tan().atan() - 1.0).abs();
723     ///
724     /// assert!(abs_difference <= f32::EPSILON);
725     /// ```
726     #[stable(feature = "rust1", since = "1.0.0")]
727     #[inline]
728     pub fn atan(self) -> f32 {
729         unsafe { cmath::atanf(self) }
730     }
731
732     /// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`) in radians.
733     ///
734     /// * `x = 0`, `y = 0`: `0`
735     /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
736     /// * `y >= 0`: `arctan(y/x) + pi` -> `(pi/2, pi]`
737     /// * `y < 0`: `arctan(y/x) - pi` -> `(-pi, -pi/2)`
738     ///
739     /// # Examples
740     ///
741     /// ```
742     /// use std::f32;
743     ///
744     /// let pi = f32::consts::PI;
745     /// // Positive angles measured counter-clockwise
746     /// // from positive x axis
747     /// // -pi/4 radians (45 deg clockwise)
748     /// let x1 = 3.0f32;
749     /// let y1 = -3.0f32;
750     ///
751     /// // 3pi/4 radians (135 deg counter-clockwise)
752     /// let x2 = -3.0f32;
753     /// let y2 = 3.0f32;
754     ///
755     /// let abs_difference_1 = (y1.atan2(x1) - (-pi/4.0)).abs();
756     /// let abs_difference_2 = (y2.atan2(x2) - 3.0*pi/4.0).abs();
757     ///
758     /// assert!(abs_difference_1 <= f32::EPSILON);
759     /// assert!(abs_difference_2 <= f32::EPSILON);
760     /// ```
761     #[stable(feature = "rust1", since = "1.0.0")]
762     #[inline]
763     pub fn atan2(self, other: f32) -> f32 {
764         unsafe { cmath::atan2f(self, other) }
765     }
766
767     /// Simultaneously computes the sine and cosine of the number, `x`. Returns
768     /// `(sin(x), cos(x))`.
769     ///
770     /// # Examples
771     ///
772     /// ```
773     /// use std::f32;
774     ///
775     /// let x = f32::consts::PI/4.0;
776     /// let f = x.sin_cos();
777     ///
778     /// let abs_difference_0 = (f.0 - x.sin()).abs();
779     /// let abs_difference_1 = (f.1 - x.cos()).abs();
780     ///
781     /// assert!(abs_difference_0 <= f32::EPSILON);
782     /// assert!(abs_difference_1 <= f32::EPSILON);
783     /// ```
784     #[stable(feature = "rust1", since = "1.0.0")]
785     #[inline]
786     pub fn sin_cos(self) -> (f32, f32) {
787         (self.sin(), self.cos())
788     }
789
790     /// Returns `e^(self) - 1` in a way that is accurate even if the
791     /// number is close to zero.
792     ///
793     /// # Examples
794     ///
795     /// ```
796     /// use std::f32;
797     ///
798     /// let x = 6.0f32;
799     ///
800     /// // e^(ln(6)) - 1
801     /// let abs_difference = (x.ln().exp_m1() - 5.0).abs();
802     ///
803     /// assert!(abs_difference <= f32::EPSILON);
804     /// ```
805     #[stable(feature = "rust1", since = "1.0.0")]
806     #[inline]
807     pub fn exp_m1(self) -> f32 {
808         unsafe { cmath::expm1f(self) }
809     }
810
811     /// Returns `ln(1+n)` (natural logarithm) more accurately than if
812     /// the operations were performed separately.
813     ///
814     /// # Examples
815     ///
816     /// ```
817     /// use std::f32;
818     ///
819     /// let x = f32::consts::E - 1.0;
820     ///
821     /// // ln(1 + (e - 1)) == ln(e) == 1
822     /// let abs_difference = (x.ln_1p() - 1.0).abs();
823     ///
824     /// assert!(abs_difference <= f32::EPSILON);
825     /// ```
826     #[stable(feature = "rust1", since = "1.0.0")]
827     #[inline]
828     pub fn ln_1p(self) -> f32 {
829         unsafe { cmath::log1pf(self) }
830     }
831
832     /// Hyperbolic sine function.
833     ///
834     /// # Examples
835     ///
836     /// ```
837     /// use std::f32;
838     ///
839     /// let e = f32::consts::E;
840     /// let x = 1.0f32;
841     ///
842     /// let f = x.sinh();
843     /// // Solving sinh() at 1 gives `(e^2-1)/(2e)`
844     /// let g = (e*e - 1.0)/(2.0*e);
845     /// let abs_difference = (f - g).abs();
846     ///
847     /// assert!(abs_difference <= f32::EPSILON);
848     /// ```
849     #[stable(feature = "rust1", since = "1.0.0")]
850     #[inline]
851     pub fn sinh(self) -> f32 {
852         unsafe { cmath::sinhf(self) }
853     }
854
855     /// Hyperbolic cosine function.
856     ///
857     /// # Examples
858     ///
859     /// ```
860     /// use std::f32;
861     ///
862     /// let e = f32::consts::E;
863     /// let x = 1.0f32;
864     /// let f = x.cosh();
865     /// // Solving cosh() at 1 gives this result
866     /// let g = (e*e + 1.0)/(2.0*e);
867     /// let abs_difference = (f - g).abs();
868     ///
869     /// // Same result
870     /// assert!(abs_difference <= f32::EPSILON);
871     /// ```
872     #[stable(feature = "rust1", since = "1.0.0")]
873     #[inline]
874     pub fn cosh(self) -> f32 {
875         unsafe { cmath::coshf(self) }
876     }
877
878     /// Hyperbolic tangent function.
879     ///
880     /// # Examples
881     ///
882     /// ```
883     /// use std::f32;
884     ///
885     /// let e = f32::consts::E;
886     /// let x = 1.0f32;
887     ///
888     /// let f = x.tanh();
889     /// // Solving tanh() at 1 gives `(1 - e^(-2))/(1 + e^(-2))`
890     /// let g = (1.0 - e.powi(-2))/(1.0 + e.powi(-2));
891     /// let abs_difference = (f - g).abs();
892     ///
893     /// assert!(abs_difference <= f32::EPSILON);
894     /// ```
895     #[stable(feature = "rust1", since = "1.0.0")]
896     #[inline]
897     pub fn tanh(self) -> f32 {
898         unsafe { cmath::tanhf(self) }
899     }
900
901     /// Inverse hyperbolic sine function.
902     ///
903     /// # Examples
904     ///
905     /// ```
906     /// use std::f32;
907     ///
908     /// let x = 1.0f32;
909     /// let f = x.sinh().asinh();
910     ///
911     /// let abs_difference = (f - x).abs();
912     ///
913     /// assert!(abs_difference <= f32::EPSILON);
914     /// ```
915     #[stable(feature = "rust1", since = "1.0.0")]
916     #[inline]
917     pub fn asinh(self) -> f32 {
918         if self == NEG_INFINITY {
919             NEG_INFINITY
920         } else {
921             (self + ((self * self) + 1.0).sqrt()).ln()
922         }
923     }
924
925     /// Inverse hyperbolic cosine function.
926     ///
927     /// # Examples
928     ///
929     /// ```
930     /// use std::f32;
931     ///
932     /// let x = 1.0f32;
933     /// let f = x.cosh().acosh();
934     ///
935     /// let abs_difference = (f - x).abs();
936     ///
937     /// assert!(abs_difference <= f32::EPSILON);
938     /// ```
939     #[stable(feature = "rust1", since = "1.0.0")]
940     #[inline]
941     pub fn acosh(self) -> f32 {
942         match self {
943             x if x < 1.0 => ::f32::NAN,
944             x => (x + ((x * x) - 1.0).sqrt()).ln(),
945         }
946     }
947
948     /// Inverse hyperbolic tangent function.
949     ///
950     /// # Examples
951     ///
952     /// ```
953     /// use std::f32;
954     ///
955     /// let e = f32::consts::E;
956     /// let f = e.tanh().atanh();
957     ///
958     /// let abs_difference = (f - e).abs();
959     ///
960     /// assert!(abs_difference <= 1e-5);
961     /// ```
962     #[stable(feature = "rust1", since = "1.0.0")]
963     #[inline]
964     pub fn atanh(self) -> f32 {
965         0.5 * ((2.0 * self) / (1.0 - self)).ln_1p()
966     }
967 }
968
969 #[cfg(test)]
970 mod tests {
971     use f32;
972     use f32::*;
973     use num::*;
974     use num::FpCategory as Fp;
975
976     #[test]
977     fn test_num_f32() {
978         test_num(10f32, 2f32);
979     }
980
981     #[test]
982     fn test_min_nan() {
983         assert_eq!(NAN.min(2.0), 2.0);
984         assert_eq!(2.0f32.min(NAN), 2.0);
985     }
986
987     #[test]
988     fn test_max_nan() {
989         assert_eq!(NAN.max(2.0), 2.0);
990         assert_eq!(2.0f32.max(NAN), 2.0);
991     }
992
993     #[test]
994     fn test_nan() {
995         let nan: f32 = f32::NAN;
996         assert!(nan.is_nan());
997         assert!(!nan.is_infinite());
998         assert!(!nan.is_finite());
999         assert!(!nan.is_normal());
1000         assert!(nan.is_sign_positive());
1001         assert!(!nan.is_sign_negative());
1002         assert_eq!(Fp::Nan, nan.classify());
1003     }
1004
1005     #[test]
1006     fn test_infinity() {
1007         let inf: f32 = f32::INFINITY;
1008         assert!(inf.is_infinite());
1009         assert!(!inf.is_finite());
1010         assert!(inf.is_sign_positive());
1011         assert!(!inf.is_sign_negative());
1012         assert!(!inf.is_nan());
1013         assert!(!inf.is_normal());
1014         assert_eq!(Fp::Infinite, inf.classify());
1015     }
1016
1017     #[test]
1018     fn test_neg_infinity() {
1019         let neg_inf: f32 = f32::NEG_INFINITY;
1020         assert!(neg_inf.is_infinite());
1021         assert!(!neg_inf.is_finite());
1022         assert!(!neg_inf.is_sign_positive());
1023         assert!(neg_inf.is_sign_negative());
1024         assert!(!neg_inf.is_nan());
1025         assert!(!neg_inf.is_normal());
1026         assert_eq!(Fp::Infinite, neg_inf.classify());
1027     }
1028
1029     #[test]
1030     fn test_zero() {
1031         let zero: f32 = 0.0f32;
1032         assert_eq!(0.0, zero);
1033         assert!(!zero.is_infinite());
1034         assert!(zero.is_finite());
1035         assert!(zero.is_sign_positive());
1036         assert!(!zero.is_sign_negative());
1037         assert!(!zero.is_nan());
1038         assert!(!zero.is_normal());
1039         assert_eq!(Fp::Zero, zero.classify());
1040     }
1041
1042     #[test]
1043     fn test_neg_zero() {
1044         let neg_zero: f32 = -0.0;
1045         assert_eq!(0.0, neg_zero);
1046         assert!(!neg_zero.is_infinite());
1047         assert!(neg_zero.is_finite());
1048         assert!(!neg_zero.is_sign_positive());
1049         assert!(neg_zero.is_sign_negative());
1050         assert!(!neg_zero.is_nan());
1051         assert!(!neg_zero.is_normal());
1052         assert_eq!(Fp::Zero, neg_zero.classify());
1053     }
1054
1055     #[test]
1056     fn test_one() {
1057         let one: f32 = 1.0f32;
1058         assert_eq!(1.0, one);
1059         assert!(!one.is_infinite());
1060         assert!(one.is_finite());
1061         assert!(one.is_sign_positive());
1062         assert!(!one.is_sign_negative());
1063         assert!(!one.is_nan());
1064         assert!(one.is_normal());
1065         assert_eq!(Fp::Normal, one.classify());
1066     }
1067
1068     #[test]
1069     fn test_is_nan() {
1070         let nan: f32 = f32::NAN;
1071         let inf: f32 = f32::INFINITY;
1072         let neg_inf: f32 = f32::NEG_INFINITY;
1073         assert!(nan.is_nan());
1074         assert!(!0.0f32.is_nan());
1075         assert!(!5.3f32.is_nan());
1076         assert!(!(-10.732f32).is_nan());
1077         assert!(!inf.is_nan());
1078         assert!(!neg_inf.is_nan());
1079     }
1080
1081     #[test]
1082     fn test_is_infinite() {
1083         let nan: f32 = f32::NAN;
1084         let inf: f32 = f32::INFINITY;
1085         let neg_inf: f32 = f32::NEG_INFINITY;
1086         assert!(!nan.is_infinite());
1087         assert!(inf.is_infinite());
1088         assert!(neg_inf.is_infinite());
1089         assert!(!0.0f32.is_infinite());
1090         assert!(!42.8f32.is_infinite());
1091         assert!(!(-109.2f32).is_infinite());
1092     }
1093
1094     #[test]
1095     fn test_is_finite() {
1096         let nan: f32 = f32::NAN;
1097         let inf: f32 = f32::INFINITY;
1098         let neg_inf: f32 = f32::NEG_INFINITY;
1099         assert!(!nan.is_finite());
1100         assert!(!inf.is_finite());
1101         assert!(!neg_inf.is_finite());
1102         assert!(0.0f32.is_finite());
1103         assert!(42.8f32.is_finite());
1104         assert!((-109.2f32).is_finite());
1105     }
1106
1107     #[test]
1108     fn test_is_normal() {
1109         let nan: f32 = f32::NAN;
1110         let inf: f32 = f32::INFINITY;
1111         let neg_inf: f32 = f32::NEG_INFINITY;
1112         let zero: f32 = 0.0f32;
1113         let neg_zero: f32 = -0.0;
1114         assert!(!nan.is_normal());
1115         assert!(!inf.is_normal());
1116         assert!(!neg_inf.is_normal());
1117         assert!(!zero.is_normal());
1118         assert!(!neg_zero.is_normal());
1119         assert!(1f32.is_normal());
1120         assert!(1e-37f32.is_normal());
1121         assert!(!1e-38f32.is_normal());
1122     }
1123
1124     #[test]
1125     fn test_classify() {
1126         let nan: f32 = f32::NAN;
1127         let inf: f32 = f32::INFINITY;
1128         let neg_inf: f32 = f32::NEG_INFINITY;
1129         let zero: f32 = 0.0f32;
1130         let neg_zero: f32 = -0.0;
1131         assert_eq!(nan.classify(), Fp::Nan);
1132         assert_eq!(inf.classify(), Fp::Infinite);
1133         assert_eq!(neg_inf.classify(), Fp::Infinite);
1134         assert_eq!(zero.classify(), Fp::Zero);
1135         assert_eq!(neg_zero.classify(), Fp::Zero);
1136         assert_eq!(1f32.classify(), Fp::Normal);
1137         assert_eq!(1e-37f32.classify(), Fp::Normal);
1138         assert_eq!(1e-38f32.classify(), Fp::Subnormal);
1139     }
1140
1141     #[test]
1142     fn test_floor() {
1143         assert_approx_eq!(1.0f32.floor(), 1.0f32);
1144         assert_approx_eq!(1.3f32.floor(), 1.0f32);
1145         assert_approx_eq!(1.5f32.floor(), 1.0f32);
1146         assert_approx_eq!(1.7f32.floor(), 1.0f32);
1147         assert_approx_eq!(0.0f32.floor(), 0.0f32);
1148         assert_approx_eq!((-0.0f32).floor(), -0.0f32);
1149         assert_approx_eq!((-1.0f32).floor(), -1.0f32);
1150         assert_approx_eq!((-1.3f32).floor(), -2.0f32);
1151         assert_approx_eq!((-1.5f32).floor(), -2.0f32);
1152         assert_approx_eq!((-1.7f32).floor(), -2.0f32);
1153     }
1154
1155     #[test]
1156     fn test_ceil() {
1157         assert_approx_eq!(1.0f32.ceil(), 1.0f32);
1158         assert_approx_eq!(1.3f32.ceil(), 2.0f32);
1159         assert_approx_eq!(1.5f32.ceil(), 2.0f32);
1160         assert_approx_eq!(1.7f32.ceil(), 2.0f32);
1161         assert_approx_eq!(0.0f32.ceil(), 0.0f32);
1162         assert_approx_eq!((-0.0f32).ceil(), -0.0f32);
1163         assert_approx_eq!((-1.0f32).ceil(), -1.0f32);
1164         assert_approx_eq!((-1.3f32).ceil(), -1.0f32);
1165         assert_approx_eq!((-1.5f32).ceil(), -1.0f32);
1166         assert_approx_eq!((-1.7f32).ceil(), -1.0f32);
1167     }
1168
1169     #[test]
1170     fn test_round() {
1171         assert_approx_eq!(1.0f32.round(), 1.0f32);
1172         assert_approx_eq!(1.3f32.round(), 1.0f32);
1173         assert_approx_eq!(1.5f32.round(), 2.0f32);
1174         assert_approx_eq!(1.7f32.round(), 2.0f32);
1175         assert_approx_eq!(0.0f32.round(), 0.0f32);
1176         assert_approx_eq!((-0.0f32).round(), -0.0f32);
1177         assert_approx_eq!((-1.0f32).round(), -1.0f32);
1178         assert_approx_eq!((-1.3f32).round(), -1.0f32);
1179         assert_approx_eq!((-1.5f32).round(), -2.0f32);
1180         assert_approx_eq!((-1.7f32).round(), -2.0f32);
1181     }
1182
1183     #[test]
1184     fn test_trunc() {
1185         assert_approx_eq!(1.0f32.trunc(), 1.0f32);
1186         assert_approx_eq!(1.3f32.trunc(), 1.0f32);
1187         assert_approx_eq!(1.5f32.trunc(), 1.0f32);
1188         assert_approx_eq!(1.7f32.trunc(), 1.0f32);
1189         assert_approx_eq!(0.0f32.trunc(), 0.0f32);
1190         assert_approx_eq!((-0.0f32).trunc(), -0.0f32);
1191         assert_approx_eq!((-1.0f32).trunc(), -1.0f32);
1192         assert_approx_eq!((-1.3f32).trunc(), -1.0f32);
1193         assert_approx_eq!((-1.5f32).trunc(), -1.0f32);
1194         assert_approx_eq!((-1.7f32).trunc(), -1.0f32);
1195     }
1196
1197     #[test]
1198     fn test_fract() {
1199         assert_approx_eq!(1.0f32.fract(), 0.0f32);
1200         assert_approx_eq!(1.3f32.fract(), 0.3f32);
1201         assert_approx_eq!(1.5f32.fract(), 0.5f32);
1202         assert_approx_eq!(1.7f32.fract(), 0.7f32);
1203         assert_approx_eq!(0.0f32.fract(), 0.0f32);
1204         assert_approx_eq!((-0.0f32).fract(), -0.0f32);
1205         assert_approx_eq!((-1.0f32).fract(), -0.0f32);
1206         assert_approx_eq!((-1.3f32).fract(), -0.3f32);
1207         assert_approx_eq!((-1.5f32).fract(), -0.5f32);
1208         assert_approx_eq!((-1.7f32).fract(), -0.7f32);
1209     }
1210
1211     #[test]
1212     fn test_abs() {
1213         assert_eq!(INFINITY.abs(), INFINITY);
1214         assert_eq!(1f32.abs(), 1f32);
1215         assert_eq!(0f32.abs(), 0f32);
1216         assert_eq!((-0f32).abs(), 0f32);
1217         assert_eq!((-1f32).abs(), 1f32);
1218         assert_eq!(NEG_INFINITY.abs(), INFINITY);
1219         assert_eq!((1f32/NEG_INFINITY).abs(), 0f32);
1220         assert!(NAN.abs().is_nan());
1221     }
1222
1223     #[test]
1224     fn test_signum() {
1225         assert_eq!(INFINITY.signum(), 1f32);
1226         assert_eq!(1f32.signum(), 1f32);
1227         assert_eq!(0f32.signum(), 1f32);
1228         assert_eq!((-0f32).signum(), -1f32);
1229         assert_eq!((-1f32).signum(), -1f32);
1230         assert_eq!(NEG_INFINITY.signum(), -1f32);
1231         assert_eq!((1f32/NEG_INFINITY).signum(), -1f32);
1232         assert!(NAN.signum().is_nan());
1233     }
1234
1235     #[test]
1236     fn test_is_sign_positive() {
1237         assert!(INFINITY.is_sign_positive());
1238         assert!(1f32.is_sign_positive());
1239         assert!(0f32.is_sign_positive());
1240         assert!(!(-0f32).is_sign_positive());
1241         assert!(!(-1f32).is_sign_positive());
1242         assert!(!NEG_INFINITY.is_sign_positive());
1243         assert!(!(1f32/NEG_INFINITY).is_sign_positive());
1244         assert!(NAN.is_sign_positive());
1245         assert!(!(-NAN).is_sign_positive());
1246     }
1247
1248     #[test]
1249     fn test_is_sign_negative() {
1250         assert!(!INFINITY.is_sign_negative());
1251         assert!(!1f32.is_sign_negative());
1252         assert!(!0f32.is_sign_negative());
1253         assert!((-0f32).is_sign_negative());
1254         assert!((-1f32).is_sign_negative());
1255         assert!(NEG_INFINITY.is_sign_negative());
1256         assert!((1f32/NEG_INFINITY).is_sign_negative());
1257         assert!(!NAN.is_sign_negative());
1258         assert!((-NAN).is_sign_negative());
1259     }
1260
1261     #[test]
1262     fn test_mul_add() {
1263         let nan: f32 = f32::NAN;
1264         let inf: f32 = f32::INFINITY;
1265         let neg_inf: f32 = f32::NEG_INFINITY;
1266         assert_approx_eq!(12.3f32.mul_add(4.5, 6.7), 62.05);
1267         assert_approx_eq!((-12.3f32).mul_add(-4.5, -6.7), 48.65);
1268         assert_approx_eq!(0.0f32.mul_add(8.9, 1.2), 1.2);
1269         assert_approx_eq!(3.4f32.mul_add(-0.0, 5.6), 5.6);
1270         assert!(nan.mul_add(7.8, 9.0).is_nan());
1271         assert_eq!(inf.mul_add(7.8, 9.0), inf);
1272         assert_eq!(neg_inf.mul_add(7.8, 9.0), neg_inf);
1273         assert_eq!(8.9f32.mul_add(inf, 3.2), inf);
1274         assert_eq!((-3.2f32).mul_add(2.4, neg_inf), neg_inf);
1275     }
1276
1277     #[test]
1278     fn test_recip() {
1279         let nan: f32 = f32::NAN;
1280         let inf: f32 = f32::INFINITY;
1281         let neg_inf: f32 = f32::NEG_INFINITY;
1282         assert_eq!(1.0f32.recip(), 1.0);
1283         assert_eq!(2.0f32.recip(), 0.5);
1284         assert_eq!((-0.4f32).recip(), -2.5);
1285         assert_eq!(0.0f32.recip(), inf);
1286         assert!(nan.recip().is_nan());
1287         assert_eq!(inf.recip(), 0.0);
1288         assert_eq!(neg_inf.recip(), 0.0);
1289     }
1290
1291     #[test]
1292     fn test_powi() {
1293         let nan: f32 = f32::NAN;
1294         let inf: f32 = f32::INFINITY;
1295         let neg_inf: f32 = f32::NEG_INFINITY;
1296         assert_eq!(1.0f32.powi(1), 1.0);
1297         assert_approx_eq!((-3.1f32).powi(2), 9.61);
1298         assert_approx_eq!(5.9f32.powi(-2), 0.028727);
1299         assert_eq!(8.3f32.powi(0), 1.0);
1300         assert!(nan.powi(2).is_nan());
1301         assert_eq!(inf.powi(3), inf);
1302         assert_eq!(neg_inf.powi(2), inf);
1303     }
1304
1305     #[test]
1306     fn test_powf() {
1307         let nan: f32 = f32::NAN;
1308         let inf: f32 = f32::INFINITY;
1309         let neg_inf: f32 = f32::NEG_INFINITY;
1310         assert_eq!(1.0f32.powf(1.0), 1.0);
1311         assert_approx_eq!(3.4f32.powf(4.5), 246.408218);
1312         assert_approx_eq!(2.7f32.powf(-3.2), 0.041652);
1313         assert_approx_eq!((-3.1f32).powf(2.0), 9.61);
1314         assert_approx_eq!(5.9f32.powf(-2.0), 0.028727);
1315         assert_eq!(8.3f32.powf(0.0), 1.0);
1316         assert!(nan.powf(2.0).is_nan());
1317         assert_eq!(inf.powf(2.0), inf);
1318         assert_eq!(neg_inf.powf(3.0), neg_inf);
1319     }
1320
1321     #[test]
1322     fn test_sqrt_domain() {
1323         assert!(NAN.sqrt().is_nan());
1324         assert!(NEG_INFINITY.sqrt().is_nan());
1325         assert!((-1.0f32).sqrt().is_nan());
1326         assert_eq!((-0.0f32).sqrt(), -0.0);
1327         assert_eq!(0.0f32.sqrt(), 0.0);
1328         assert_eq!(1.0f32.sqrt(), 1.0);
1329         assert_eq!(INFINITY.sqrt(), INFINITY);
1330     }
1331
1332     #[test]
1333     fn test_exp() {
1334         assert_eq!(1.0, 0.0f32.exp());
1335         assert_approx_eq!(2.718282, 1.0f32.exp());
1336         assert_approx_eq!(148.413162, 5.0f32.exp());
1337
1338         let inf: f32 = f32::INFINITY;
1339         let neg_inf: f32 = f32::NEG_INFINITY;
1340         let nan: f32 = f32::NAN;
1341         assert_eq!(inf, inf.exp());
1342         assert_eq!(0.0, neg_inf.exp());
1343         assert!(nan.exp().is_nan());
1344     }
1345
1346     #[test]
1347     fn test_exp2() {
1348         assert_eq!(32.0, 5.0f32.exp2());
1349         assert_eq!(1.0, 0.0f32.exp2());
1350
1351         let inf: f32 = f32::INFINITY;
1352         let neg_inf: f32 = f32::NEG_INFINITY;
1353         let nan: f32 = f32::NAN;
1354         assert_eq!(inf, inf.exp2());
1355         assert_eq!(0.0, neg_inf.exp2());
1356         assert!(nan.exp2().is_nan());
1357     }
1358
1359     #[test]
1360     fn test_ln() {
1361         let nan: f32 = f32::NAN;
1362         let inf: f32 = f32::INFINITY;
1363         let neg_inf: f32 = f32::NEG_INFINITY;
1364         assert_approx_eq!(1.0f32.exp().ln(), 1.0);
1365         assert!(nan.ln().is_nan());
1366         assert_eq!(inf.ln(), inf);
1367         assert!(neg_inf.ln().is_nan());
1368         assert!((-2.3f32).ln().is_nan());
1369         assert_eq!((-0.0f32).ln(), neg_inf);
1370         assert_eq!(0.0f32.ln(), neg_inf);
1371         assert_approx_eq!(4.0f32.ln(), 1.386294);
1372     }
1373
1374     #[test]
1375     fn test_log() {
1376         let nan: f32 = f32::NAN;
1377         let inf: f32 = f32::INFINITY;
1378         let neg_inf: f32 = f32::NEG_INFINITY;
1379         assert_eq!(10.0f32.log(10.0), 1.0);
1380         assert_approx_eq!(2.3f32.log(3.5), 0.664858);
1381         assert_eq!(1.0f32.exp().log(1.0f32.exp()), 1.0);
1382         assert!(1.0f32.log(1.0).is_nan());
1383         assert!(1.0f32.log(-13.9).is_nan());
1384         assert!(nan.log(2.3).is_nan());
1385         assert_eq!(inf.log(10.0), inf);
1386         assert!(neg_inf.log(8.8).is_nan());
1387         assert!((-2.3f32).log(0.1).is_nan());
1388         assert_eq!((-0.0f32).log(2.0), neg_inf);
1389         assert_eq!(0.0f32.log(7.0), neg_inf);
1390     }
1391
1392     #[test]
1393     fn test_log2() {
1394         let nan: f32 = f32::NAN;
1395         let inf: f32 = f32::INFINITY;
1396         let neg_inf: f32 = f32::NEG_INFINITY;
1397         assert_approx_eq!(10.0f32.log2(), 3.321928);
1398         assert_approx_eq!(2.3f32.log2(), 1.201634);
1399         assert_approx_eq!(1.0f32.exp().log2(), 1.442695);
1400         assert!(nan.log2().is_nan());
1401         assert_eq!(inf.log2(), inf);
1402         assert!(neg_inf.log2().is_nan());
1403         assert!((-2.3f32).log2().is_nan());
1404         assert_eq!((-0.0f32).log2(), neg_inf);
1405         assert_eq!(0.0f32.log2(), neg_inf);
1406     }
1407
1408     #[test]
1409     fn test_log10() {
1410         let nan: f32 = f32::NAN;
1411         let inf: f32 = f32::INFINITY;
1412         let neg_inf: f32 = f32::NEG_INFINITY;
1413         assert_eq!(10.0f32.log10(), 1.0);
1414         assert_approx_eq!(2.3f32.log10(), 0.361728);
1415         assert_approx_eq!(1.0f32.exp().log10(), 0.434294);
1416         assert_eq!(1.0f32.log10(), 0.0);
1417         assert!(nan.log10().is_nan());
1418         assert_eq!(inf.log10(), inf);
1419         assert!(neg_inf.log10().is_nan());
1420         assert!((-2.3f32).log10().is_nan());
1421         assert_eq!((-0.0f32).log10(), neg_inf);
1422         assert_eq!(0.0f32.log10(), neg_inf);
1423     }
1424
1425     #[test]
1426     fn test_to_degrees() {
1427         let pi: f32 = consts::PI;
1428         let nan: f32 = f32::NAN;
1429         let inf: f32 = f32::INFINITY;
1430         let neg_inf: f32 = f32::NEG_INFINITY;
1431         assert_eq!(0.0f32.to_degrees(), 0.0);
1432         assert_approx_eq!((-5.8f32).to_degrees(), -332.315521);
1433         assert_eq!(pi.to_degrees(), 180.0);
1434         assert!(nan.to_degrees().is_nan());
1435         assert_eq!(inf.to_degrees(), inf);
1436         assert_eq!(neg_inf.to_degrees(), neg_inf);
1437         assert_eq!(1_f32.to_degrees(), 57.2957795130823208767981548141051703);
1438     }
1439
1440     #[test]
1441     fn test_to_radians() {
1442         let pi: f32 = consts::PI;
1443         let nan: f32 = f32::NAN;
1444         let inf: f32 = f32::INFINITY;
1445         let neg_inf: f32 = f32::NEG_INFINITY;
1446         assert_eq!(0.0f32.to_radians(), 0.0);
1447         assert_approx_eq!(154.6f32.to_radians(), 2.698279);
1448         assert_approx_eq!((-332.31f32).to_radians(), -5.799903);
1449         assert_eq!(180.0f32.to_radians(), pi);
1450         assert!(nan.to_radians().is_nan());
1451         assert_eq!(inf.to_radians(), inf);
1452         assert_eq!(neg_inf.to_radians(), neg_inf);
1453     }
1454
1455     #[test]
1456     fn test_asinh() {
1457         assert_eq!(0.0f32.asinh(), 0.0f32);
1458         assert_eq!((-0.0f32).asinh(), -0.0f32);
1459
1460         let inf: f32 = f32::INFINITY;
1461         let neg_inf: f32 = f32::NEG_INFINITY;
1462         let nan: f32 = f32::NAN;
1463         assert_eq!(inf.asinh(), inf);
1464         assert_eq!(neg_inf.asinh(), neg_inf);
1465         assert!(nan.asinh().is_nan());
1466         assert_approx_eq!(2.0f32.asinh(), 1.443635475178810342493276740273105f32);
1467         assert_approx_eq!((-2.0f32).asinh(), -1.443635475178810342493276740273105f32);
1468     }
1469
1470     #[test]
1471     fn test_acosh() {
1472         assert_eq!(1.0f32.acosh(), 0.0f32);
1473         assert!(0.999f32.acosh().is_nan());
1474
1475         let inf: f32 = f32::INFINITY;
1476         let neg_inf: f32 = f32::NEG_INFINITY;
1477         let nan: f32 = f32::NAN;
1478         assert_eq!(inf.acosh(), inf);
1479         assert!(neg_inf.acosh().is_nan());
1480         assert!(nan.acosh().is_nan());
1481         assert_approx_eq!(2.0f32.acosh(), 1.31695789692481670862504634730796844f32);
1482         assert_approx_eq!(3.0f32.acosh(), 1.76274717403908605046521864995958461f32);
1483     }
1484
1485     #[test]
1486     fn test_atanh() {
1487         assert_eq!(0.0f32.atanh(), 0.0f32);
1488         assert_eq!((-0.0f32).atanh(), -0.0f32);
1489
1490         let inf32: f32 = f32::INFINITY;
1491         let neg_inf32: f32 = f32::NEG_INFINITY;
1492         assert_eq!(1.0f32.atanh(), inf32);
1493         assert_eq!((-1.0f32).atanh(), neg_inf32);
1494
1495         assert!(2f64.atanh().atanh().is_nan());
1496         assert!((-2f64).atanh().atanh().is_nan());
1497
1498         let inf64: f32 = f32::INFINITY;
1499         let neg_inf64: f32 = f32::NEG_INFINITY;
1500         let nan32: f32 = f32::NAN;
1501         assert!(inf64.atanh().is_nan());
1502         assert!(neg_inf64.atanh().is_nan());
1503         assert!(nan32.atanh().is_nan());
1504
1505         assert_approx_eq!(0.5f32.atanh(), 0.54930614433405484569762261846126285f32);
1506         assert_approx_eq!((-0.5f32).atanh(), -0.54930614433405484569762261846126285f32);
1507     }
1508
1509     #[test]
1510     fn test_real_consts() {
1511         use super::consts;
1512
1513         let pi: f32 = consts::PI;
1514         let frac_pi_2: f32 = consts::FRAC_PI_2;
1515         let frac_pi_3: f32 = consts::FRAC_PI_3;
1516         let frac_pi_4: f32 = consts::FRAC_PI_4;
1517         let frac_pi_6: f32 = consts::FRAC_PI_6;
1518         let frac_pi_8: f32 = consts::FRAC_PI_8;
1519         let frac_1_pi: f32 = consts::FRAC_1_PI;
1520         let frac_2_pi: f32 = consts::FRAC_2_PI;
1521         let frac_2_sqrtpi: f32 = consts::FRAC_2_SQRT_PI;
1522         let sqrt2: f32 = consts::SQRT_2;
1523         let frac_1_sqrt2: f32 = consts::FRAC_1_SQRT_2;
1524         let e: f32 = consts::E;
1525         let log2_e: f32 = consts::LOG2_E;
1526         let log10_e: f32 = consts::LOG10_E;
1527         let ln_2: f32 = consts::LN_2;
1528         let ln_10: f32 = consts::LN_10;
1529
1530         assert_approx_eq!(frac_pi_2, pi / 2f32);
1531         assert_approx_eq!(frac_pi_3, pi / 3f32);
1532         assert_approx_eq!(frac_pi_4, pi / 4f32);
1533         assert_approx_eq!(frac_pi_6, pi / 6f32);
1534         assert_approx_eq!(frac_pi_8, pi / 8f32);
1535         assert_approx_eq!(frac_1_pi, 1f32 / pi);
1536         assert_approx_eq!(frac_2_pi, 2f32 / pi);
1537         assert_approx_eq!(frac_2_sqrtpi, 2f32 / pi.sqrt());
1538         assert_approx_eq!(sqrt2, 2f32.sqrt());
1539         assert_approx_eq!(frac_1_sqrt2, 1f32 / 2f32.sqrt());
1540         assert_approx_eq!(log2_e, e.log2());
1541         assert_approx_eq!(log10_e, e.log10());
1542         assert_approx_eq!(ln_2, 2f32.ln());
1543         assert_approx_eq!(ln_10, 10f32.ln());
1544     }
1545
1546     #[test]
1547     fn test_float_bits_conv() {
1548         assert_eq!((1f32).to_bits(), 0x3f800000);
1549         assert_eq!((12.5f32).to_bits(), 0x41480000);
1550         assert_eq!((1337f32).to_bits(), 0x44a72000);
1551         assert_eq!((-14.25f32).to_bits(), 0xc1640000);
1552         assert_approx_eq!(f32::from_bits(0x3f800000), 1.0);
1553         assert_approx_eq!(f32::from_bits(0x41480000), 12.5);
1554         assert_approx_eq!(f32::from_bits(0x44a72000), 1337.0);
1555         assert_approx_eq!(f32::from_bits(0xc1640000), -14.25);
1556
1557         // Check that NaNs roundtrip their bits regardless of signalingness
1558         // 0xA is 0b1010; 0x5 is 0b0101 -- so these two together clobbers all the mantissa bits
1559         let masked_nan1 = f32::NAN.to_bits() ^ 0x002A_AAAA;
1560         let masked_nan2 = f32::NAN.to_bits() ^ 0x0055_5555;
1561         assert!(f32::from_bits(masked_nan1).is_nan());
1562         assert!(f32::from_bits(masked_nan2).is_nan());
1563
1564         assert_eq!(f32::from_bits(masked_nan1).to_bits(), masked_nan1);
1565         assert_eq!(f32::from_bits(masked_nan2).to_bits(), masked_nan2);
1566     }
1567 }