core/num/f64.rs
1//! Constants for the `f64` double-precision floating point type.
2//!
3//! *[See also the `f64` primitive type][f64].*
4//!
5//! Mathematically significant numbers are provided in the `consts` sub-module.
6//!
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.
11
12#![stable(feature = "rust1", since = "1.0.0")]
13
14use crate::convert::FloatToInt;
15use crate::num::FpCategory;
16use crate::panic::const_assert;
17use crate::{intrinsics, mem};
18
19/// The radix or base of the internal representation of `f64`.
20/// Use [`f64::RADIX`] instead.
21///
22/// # Examples
23///
24/// ```rust
25/// // deprecated way
26/// # #[allow(deprecated, deprecated_in_future)]
27/// let r = std::f64::RADIX;
28///
29/// // intended way
30/// let r = f64::RADIX;
31/// ```
32#[stable(feature = "rust1", since = "1.0.0")]
33#[deprecated(since = "TBD", note = "replaced by the `RADIX` associated constant on `f64`")]
34#[rustc_diagnostic_item = "f64_legacy_const_radix"]
35pub const RADIX: u32 = f64::RADIX;
36
37/// Number of significant digits in base 2.
38/// Use [`f64::MANTISSA_DIGITS`] instead.
39///
40/// # Examples
41///
42/// ```rust
43/// // deprecated way
44/// # #[allow(deprecated, deprecated_in_future)]
45/// let d = std::f64::MANTISSA_DIGITS;
46///
47/// // intended way
48/// let d = f64::MANTISSA_DIGITS;
49/// ```
50#[stable(feature = "rust1", since = "1.0.0")]
51#[deprecated(
52 since = "TBD",
53 note = "replaced by the `MANTISSA_DIGITS` associated constant on `f64`"
54)]
55#[rustc_diagnostic_item = "f64_legacy_const_mantissa_dig"]
56pub const MANTISSA_DIGITS: u32 = f64::MANTISSA_DIGITS;
57
58/// Approximate number of significant digits in base 10.
59/// Use [`f64::DIGITS`] instead.
60///
61/// # Examples
62///
63/// ```rust
64/// // deprecated way
65/// # #[allow(deprecated, deprecated_in_future)]
66/// let d = std::f64::DIGITS;
67///
68/// // intended way
69/// let d = f64::DIGITS;
70/// ```
71#[stable(feature = "rust1", since = "1.0.0")]
72#[deprecated(since = "TBD", note = "replaced by the `DIGITS` associated constant on `f64`")]
73#[rustc_diagnostic_item = "f64_legacy_const_digits"]
74pub const DIGITS: u32 = f64::DIGITS;
75
76/// [Machine epsilon] value for `f64`.
77/// Use [`f64::EPSILON`] instead.
78///
79/// This is the difference between `1.0` and the next larger representable number.
80///
81/// [Machine epsilon]: https://en.wikipedia.org/wiki/Machine_epsilon
82///
83/// # Examples
84///
85/// ```rust
86/// // deprecated way
87/// # #[allow(deprecated, deprecated_in_future)]
88/// let e = std::f64::EPSILON;
89///
90/// // intended way
91/// let e = f64::EPSILON;
92/// ```
93#[stable(feature = "rust1", since = "1.0.0")]
94#[deprecated(since = "TBD", note = "replaced by the `EPSILON` associated constant on `f64`")]
95#[rustc_diagnostic_item = "f64_legacy_const_epsilon"]
96pub const EPSILON: f64 = f64::EPSILON;
97
98/// Smallest finite `f64` value.
99/// Use [`f64::MIN`] instead.
100///
101/// # Examples
102///
103/// ```rust
104/// // deprecated way
105/// # #[allow(deprecated, deprecated_in_future)]
106/// let min = std::f64::MIN;
107///
108/// // intended way
109/// let min = f64::MIN;
110/// ```
111#[stable(feature = "rust1", since = "1.0.0")]
112#[deprecated(since = "TBD", note = "replaced by the `MIN` associated constant on `f64`")]
113#[rustc_diagnostic_item = "f64_legacy_const_min"]
114pub const MIN: f64 = f64::MIN;
115
116/// Smallest positive normal `f64` value.
117/// Use [`f64::MIN_POSITIVE`] instead.
118///
119/// # Examples
120///
121/// ```rust
122/// // deprecated way
123/// # #[allow(deprecated, deprecated_in_future)]
124/// let min = std::f64::MIN_POSITIVE;
125///
126/// // intended way
127/// let min = f64::MIN_POSITIVE;
128/// ```
129#[stable(feature = "rust1", since = "1.0.0")]
130#[deprecated(since = "TBD", note = "replaced by the `MIN_POSITIVE` associated constant on `f64`")]
131#[rustc_diagnostic_item = "f64_legacy_const_min_positive"]
132pub const MIN_POSITIVE: f64 = f64::MIN_POSITIVE;
133
134/// Largest finite `f64` value.
135/// Use [`f64::MAX`] instead.
136///
137/// # Examples
138///
139/// ```rust
140/// // deprecated way
141/// # #[allow(deprecated, deprecated_in_future)]
142/// let max = std::f64::MAX;
143///
144/// // intended way
145/// let max = f64::MAX;
146/// ```
147#[stable(feature = "rust1", since = "1.0.0")]
148#[deprecated(since = "TBD", note = "replaced by the `MAX` associated constant on `f64`")]
149#[rustc_diagnostic_item = "f64_legacy_const_max"]
150pub const MAX: f64 = f64::MAX;
151
152/// One greater than the minimum possible normal power of 2 exponent.
153/// Use [`f64::MIN_EXP`] instead.
154///
155/// # Examples
156///
157/// ```rust
158/// // deprecated way
159/// # #[allow(deprecated, deprecated_in_future)]
160/// let min = std::f64::MIN_EXP;
161///
162/// // intended way
163/// let min = f64::MIN_EXP;
164/// ```
165#[stable(feature = "rust1", since = "1.0.0")]
166#[deprecated(since = "TBD", note = "replaced by the `MIN_EXP` associated constant on `f64`")]
167#[rustc_diagnostic_item = "f64_legacy_const_min_exp"]
168pub const MIN_EXP: i32 = f64::MIN_EXP;
169
170/// Maximum possible power of 2 exponent.
171/// Use [`f64::MAX_EXP`] instead.
172///
173/// # Examples
174///
175/// ```rust
176/// // deprecated way
177/// # #[allow(deprecated, deprecated_in_future)]
178/// let max = std::f64::MAX_EXP;
179///
180/// // intended way
181/// let max = f64::MAX_EXP;
182/// ```
183#[stable(feature = "rust1", since = "1.0.0")]
184#[deprecated(since = "TBD", note = "replaced by the `MAX_EXP` associated constant on `f64`")]
185#[rustc_diagnostic_item = "f64_legacy_const_max_exp"]
186pub const MAX_EXP: i32 = f64::MAX_EXP;
187
188/// Minimum possible normal power of 10 exponent.
189/// Use [`f64::MIN_10_EXP`] instead.
190///
191/// # Examples
192///
193/// ```rust
194/// // deprecated way
195/// # #[allow(deprecated, deprecated_in_future)]
196/// let min = std::f64::MIN_10_EXP;
197///
198/// // intended way
199/// let min = f64::MIN_10_EXP;
200/// ```
201#[stable(feature = "rust1", since = "1.0.0")]
202#[deprecated(since = "TBD", note = "replaced by the `MIN_10_EXP` associated constant on `f64`")]
203#[rustc_diagnostic_item = "f64_legacy_const_min_10_exp"]
204pub const MIN_10_EXP: i32 = f64::MIN_10_EXP;
205
206/// Maximum possible power of 10 exponent.
207/// Use [`f64::MAX_10_EXP`] instead.
208///
209/// # Examples
210///
211/// ```rust
212/// // deprecated way
213/// # #[allow(deprecated, deprecated_in_future)]
214/// let max = std::f64::MAX_10_EXP;
215///
216/// // intended way
217/// let max = f64::MAX_10_EXP;
218/// ```
219#[stable(feature = "rust1", since = "1.0.0")]
220#[deprecated(since = "TBD", note = "replaced by the `MAX_10_EXP` associated constant on `f64`")]
221#[rustc_diagnostic_item = "f64_legacy_const_max_10_exp"]
222pub const MAX_10_EXP: i32 = f64::MAX_10_EXP;
223
224/// Not a Number (NaN).
225/// Use [`f64::NAN`] instead.
226///
227/// # Examples
228///
229/// ```rust
230/// // deprecated way
231/// # #[allow(deprecated, deprecated_in_future)]
232/// let nan = std::f64::NAN;
233///
234/// // intended way
235/// let nan = f64::NAN;
236/// ```
237#[stable(feature = "rust1", since = "1.0.0")]
238#[deprecated(since = "TBD", note = "replaced by the `NAN` associated constant on `f64`")]
239#[rustc_diagnostic_item = "f64_legacy_const_nan"]
240pub const NAN: f64 = f64::NAN;
241
242/// Infinity (∞).
243/// Use [`f64::INFINITY`] instead.
244///
245/// # Examples
246///
247/// ```rust
248/// // deprecated way
249/// # #[allow(deprecated, deprecated_in_future)]
250/// let inf = std::f64::INFINITY;
251///
252/// // intended way
253/// let inf = f64::INFINITY;
254/// ```
255#[stable(feature = "rust1", since = "1.0.0")]
256#[deprecated(since = "TBD", note = "replaced by the `INFINITY` associated constant on `f64`")]
257#[rustc_diagnostic_item = "f64_legacy_const_infinity"]
258pub const INFINITY: f64 = f64::INFINITY;
259
260/// Negative infinity (−∞).
261/// Use [`f64::NEG_INFINITY`] instead.
262///
263/// # Examples
264///
265/// ```rust
266/// // deprecated way
267/// # #[allow(deprecated, deprecated_in_future)]
268/// let ninf = std::f64::NEG_INFINITY;
269///
270/// // intended way
271/// let ninf = f64::NEG_INFINITY;
272/// ```
273#[stable(feature = "rust1", since = "1.0.0")]
274#[deprecated(since = "TBD", note = "replaced by the `NEG_INFINITY` associated constant on `f64`")]
275#[rustc_diagnostic_item = "f64_legacy_const_neg_infinity"]
276pub const NEG_INFINITY: f64 = f64::NEG_INFINITY;
277
278/// Basic mathematical constants.
279#[stable(feature = "rust1", since = "1.0.0")]
280#[rustc_diagnostic_item = "f64_consts_mod"]
281pub mod consts {
282 // FIXME: replace with mathematical constants from cmath.
283
284 /// Archimedes' constant (π)
285 #[stable(feature = "rust1", since = "1.0.0")]
286 pub const PI: f64 = 3.14159265358979323846264338327950288_f64;
287
288 /// The full circle constant (τ)
289 ///
290 /// Equal to 2π.
291 #[stable(feature = "tau_constant", since = "1.47.0")]
292 pub const TAU: f64 = 6.28318530717958647692528676655900577_f64;
293
294 /// The golden ratio (φ)
295 #[stable(feature = "euler_gamma_golden_ratio", since = "1.94.0")]
296 pub const GOLDEN_RATIO: f64 = 1.618033988749894848204586834365638118_f64;
297
298 /// The Euler-Mascheroni constant (γ)
299 #[stable(feature = "euler_gamma_golden_ratio", since = "1.94.0")]
300 pub const EULER_GAMMA: f64 = 0.577215664901532860606512090082402431_f64;
301
302 /// π/2
303 #[stable(feature = "rust1", since = "1.0.0")]
304 pub const FRAC_PI_2: f64 = 1.57079632679489661923132169163975144_f64;
305
306 /// π/3
307 #[stable(feature = "rust1", since = "1.0.0")]
308 pub const FRAC_PI_3: f64 = 1.04719755119659774615421446109316763_f64;
309
310 /// π/4
311 #[stable(feature = "rust1", since = "1.0.0")]
312 pub const FRAC_PI_4: f64 = 0.785398163397448309615660845819875721_f64;
313
314 /// π/6
315 #[stable(feature = "rust1", since = "1.0.0")]
316 pub const FRAC_PI_6: f64 = 0.52359877559829887307710723054658381_f64;
317
318 /// π/8
319 #[stable(feature = "rust1", since = "1.0.0")]
320 pub const FRAC_PI_8: f64 = 0.39269908169872415480783042290993786_f64;
321
322 /// 1/π
323 #[stable(feature = "rust1", since = "1.0.0")]
324 pub const FRAC_1_PI: f64 = 0.318309886183790671537767526745028724_f64;
325
326 /// 1/sqrt(π)
327 #[unstable(feature = "more_float_constants", issue = "146939")]
328 pub const FRAC_1_SQRT_PI: f64 = 0.564189583547756286948079451560772586_f64;
329
330 /// 1/sqrt(2π)
331 #[doc(alias = "FRAC_1_SQRT_TAU")]
332 #[unstable(feature = "more_float_constants", issue = "146939")]
333 pub const FRAC_1_SQRT_2PI: f64 = 0.398942280401432677939946059934381868_f64;
334
335 /// 2/π
336 #[stable(feature = "rust1", since = "1.0.0")]
337 pub const FRAC_2_PI: f64 = 0.636619772367581343075535053490057448_f64;
338
339 /// 2/sqrt(π)
340 #[stable(feature = "rust1", since = "1.0.0")]
341 pub const FRAC_2_SQRT_PI: f64 = 1.12837916709551257389615890312154517_f64;
342
343 /// sqrt(2)
344 #[stable(feature = "rust1", since = "1.0.0")]
345 pub const SQRT_2: f64 = 1.41421356237309504880168872420969808_f64;
346
347 /// 1/sqrt(2)
348 #[stable(feature = "rust1", since = "1.0.0")]
349 pub const FRAC_1_SQRT_2: f64 = 0.707106781186547524400844362104849039_f64;
350
351 /// sqrt(3)
352 #[unstable(feature = "more_float_constants", issue = "146939")]
353 pub const SQRT_3: f64 = 1.732050807568877293527446341505872367_f64;
354
355 /// 1/sqrt(3)
356 #[unstable(feature = "more_float_constants", issue = "146939")]
357 pub const FRAC_1_SQRT_3: f64 = 0.577350269189625764509148780501957456_f64;
358
359 /// sqrt(5)
360 #[unstable(feature = "more_float_constants", issue = "146939")]
361 pub const SQRT_5: f64 = 2.23606797749978969640917366873127623_f64;
362
363 /// 1/sqrt(5)
364 #[unstable(feature = "more_float_constants", issue = "146939")]
365 pub const FRAC_1_SQRT_5: f64 = 0.44721359549995793928183473374625524_f64;
366
367 /// Euler's number (e)
368 #[stable(feature = "rust1", since = "1.0.0")]
369 pub const E: f64 = 2.71828182845904523536028747135266250_f64;
370
371 /// log<sub>2</sub>(10)
372 #[stable(feature = "extra_log_consts", since = "1.43.0")]
373 pub const LOG2_10: f64 = 3.32192809488736234787031942948939018_f64;
374
375 /// log<sub>2</sub>(e)
376 #[stable(feature = "rust1", since = "1.0.0")]
377 pub const LOG2_E: f64 = 1.44269504088896340735992468100189214_f64;
378
379 /// log<sub>10</sub>(2)
380 #[stable(feature = "extra_log_consts", since = "1.43.0")]
381 pub const LOG10_2: f64 = 0.301029995663981195213738894724493027_f64;
382
383 /// log<sub>10</sub>(e)
384 #[stable(feature = "rust1", since = "1.0.0")]
385 pub const LOG10_E: f64 = 0.434294481903251827651128918916605082_f64;
386
387 /// ln(2)
388 #[stable(feature = "rust1", since = "1.0.0")]
389 pub const LN_2: f64 = 0.693147180559945309417232121458176568_f64;
390
391 /// ln(10)
392 #[stable(feature = "rust1", since = "1.0.0")]
393 pub const LN_10: f64 = 2.30258509299404568401799145468436421_f64;
394}
395
396#[doc(test(attr(allow(unused_features))))]
397impl f64 {
398 /// The radix or base of the internal representation of `f64`.
399 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
400 pub const RADIX: u32 = 2;
401
402 /// The size of this float type in bits.
403 #[unstable(feature = "float_bits_const", issue = "151073")]
404 pub const BITS: u32 = 64;
405
406 /// Number of significant digits in base 2.
407 ///
408 /// Note that the size of the mantissa in the bitwise representation is one
409 /// smaller than this since the leading 1 is not stored explicitly.
410 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
411 pub const MANTISSA_DIGITS: u32 = 53;
412 /// Approximate number of significant digits in base 10.
413 ///
414 /// This is the maximum <i>x</i> such that any decimal number with <i>x</i>
415 /// significant digits can be converted to `f64` and back without loss.
416 ///
417 /// Equal to floor(log<sub>10</sub> 2<sup>[`MANTISSA_DIGITS`] − 1</sup>).
418 ///
419 /// [`MANTISSA_DIGITS`]: f64::MANTISSA_DIGITS
420 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
421 pub const DIGITS: u32 = 15;
422
423 /// [Machine epsilon] value for `f64`.
424 ///
425 /// This is the difference between `1.0` and the next larger representable number.
426 ///
427 /// Equal to 2<sup>1 − [`MANTISSA_DIGITS`]</sup>.
428 ///
429 /// [Machine epsilon]: https://en.wikipedia.org/wiki/Machine_epsilon
430 /// [`MANTISSA_DIGITS`]: f64::MANTISSA_DIGITS
431 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
432 #[rustc_diagnostic_item = "f64_epsilon"]
433 pub const EPSILON: f64 = 2.2204460492503131e-16_f64;
434
435 /// Smallest finite `f64` value.
436 ///
437 /// Equal to −[`MAX`].
438 ///
439 /// [`MAX`]: f64::MAX
440 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
441 pub const MIN: f64 = -1.7976931348623157e+308_f64;
442 /// Smallest positive normal `f64` value.
443 ///
444 /// Equal to 2<sup>[`MIN_EXP`] − 1</sup>.
445 ///
446 /// [`MIN_EXP`]: f64::MIN_EXP
447 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
448 pub const MIN_POSITIVE: f64 = 2.2250738585072014e-308_f64;
449 /// Largest finite `f64` value.
450 ///
451 /// Equal to
452 /// (1 − 2<sup>−[`MANTISSA_DIGITS`]</sup>) 2<sup>[`MAX_EXP`]</sup>.
453 ///
454 /// [`MANTISSA_DIGITS`]: f64::MANTISSA_DIGITS
455 /// [`MAX_EXP`]: f64::MAX_EXP
456 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
457 pub const MAX: f64 = 1.7976931348623157e+308_f64;
458
459 /// One greater than the minimum possible *normal* power of 2 exponent
460 /// for a significand bounded by 1 ≤ x < 2 (i.e. the IEEE definition).
461 ///
462 /// This corresponds to the exact minimum possible *normal* power of 2 exponent
463 /// for a significand bounded by 0.5 ≤ x < 1 (i.e. the C definition).
464 /// In other words, all normal numbers representable by this type are
465 /// greater than or equal to 0.5 × 2<sup><i>MIN_EXP</i></sup>.
466 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
467 pub const MIN_EXP: i32 = -1021;
468 /// One greater than the maximum possible power of 2 exponent
469 /// for a significand bounded by 1 ≤ x < 2 (i.e. the IEEE definition).
470 ///
471 /// This corresponds to the exact maximum possible power of 2 exponent
472 /// for a significand bounded by 0.5 ≤ x < 1 (i.e. the C definition).
473 /// In other words, all numbers representable by this type are
474 /// strictly less than 2<sup><i>MAX_EXP</i></sup>.
475 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
476 pub const MAX_EXP: i32 = 1024;
477
478 /// Minimum <i>x</i> for which 10<sup><i>x</i></sup> is normal.
479 ///
480 /// Equal to ceil(log<sub>10</sub> [`MIN_POSITIVE`]).
481 ///
482 /// [`MIN_POSITIVE`]: f64::MIN_POSITIVE
483 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
484 pub const MIN_10_EXP: i32 = -307;
485 /// Maximum <i>x</i> for which 10<sup><i>x</i></sup> is normal.
486 ///
487 /// Equal to floor(log<sub>10</sub> [`MAX`]).
488 ///
489 /// [`MAX`]: f64::MAX
490 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
491 pub const MAX_10_EXP: i32 = 308;
492
493 /// Not a Number (NaN).
494 ///
495 /// Note that IEEE 754 doesn't define just a single NaN value; a plethora of bit patterns are
496 /// considered to be NaN. Furthermore, the standard makes a difference between a "signaling" and
497 /// a "quiet" NaN, and allows inspecting its "payload" (the unspecified bits in the bit pattern)
498 /// and its sign. See the [specification of NaN bit patterns](f32#nan-bit-patterns) for more
499 /// info.
500 ///
501 /// This constant is guaranteed to be a quiet NaN (on targets that follow the Rust assumptions
502 /// that the quiet/signaling bit being set to 1 indicates a quiet NaN). Beyond that, nothing is
503 /// guaranteed about the specific bit pattern chosen here: both payload and sign are arbitrary.
504 /// The concrete bit pattern may change across Rust versions and target platforms.
505 #[rustc_diagnostic_item = "f64_nan"]
506 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
507 #[allow(clippy::eq_op)]
508 pub const NAN: f64 = 0.0_f64 / 0.0_f64;
509 /// Infinity (∞).
510 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
511 pub const INFINITY: f64 = 1.0_f64 / 0.0_f64;
512 /// Negative infinity (−∞).
513 #[stable(feature = "assoc_int_consts", since = "1.43.0")]
514 pub const NEG_INFINITY: f64 = -1.0_f64 / 0.0_f64;
515
516 /// Maximum integer that can be represented exactly in an [`f64`] value,
517 /// with no other integer converting to the same floating point value.
518 ///
519 /// For an integer `x` which satisfies `MIN_EXACT_INTEGER <= x <= MAX_EXACT_INTEGER`,
520 /// there is a "one-to-one" mapping between [`i64`] and [`f64`] values.
521 /// `MAX_EXACT_INTEGER + 1` also converts losslessly to [`f64`] and back to
522 /// [`i64`], but `MAX_EXACT_INTEGER + 2` converts to the same [`f64`] value
523 /// (and back to `MAX_EXACT_INTEGER + 1` as an integer) so there is not a
524 /// "one-to-one" mapping.
525 ///
526 /// [`MAX_EXACT_INTEGER`]: f64::MAX_EXACT_INTEGER
527 /// [`MIN_EXACT_INTEGER`]: f64::MIN_EXACT_INTEGER
528 /// ```
529 /// #![feature(float_exact_integer_constants)]
530 /// # // FIXME(#152635): Float rounding on `i586` does not adhere to IEEE 754
531 /// # #[cfg(not(all(target_arch = "x86", not(target_feature = "sse"))))] {
532 /// let max_exact_int = f64::MAX_EXACT_INTEGER;
533 /// assert_eq!(max_exact_int, max_exact_int as f64 as i64);
534 /// assert_eq!(max_exact_int + 1, (max_exact_int + 1) as f64 as i64);
535 /// assert_ne!(max_exact_int + 2, (max_exact_int + 2) as f64 as i64);
536 ///
537 /// // Beyond `f64::MAX_EXACT_INTEGER`, multiple integers can map to one float value
538 /// assert_eq!((max_exact_int + 1) as f64, (max_exact_int + 2) as f64);
539 /// # }
540 /// ```
541 #[unstable(feature = "float_exact_integer_constants", issue = "152466")]
542 pub const MAX_EXACT_INTEGER: i64 = (1 << Self::MANTISSA_DIGITS) - 1;
543
544 /// Minimum integer that can be represented exactly in an [`f64`] value,
545 /// with no other integer converting to the same floating point value.
546 ///
547 /// For an integer `x` which satisfies `MIN_EXACT_INTEGER <= x <= MAX_EXACT_INTEGER`,
548 /// there is a "one-to-one" mapping between [`i64`] and [`f64`] values.
549 /// `MAX_EXACT_INTEGER + 1` also converts losslessly to [`f64`] and back to
550 /// [`i64`], but `MAX_EXACT_INTEGER + 2` converts to the same [`f64`] value
551 /// (and back to `MAX_EXACT_INTEGER + 1` as an integer) so there is not a
552 /// "one-to-one" mapping.
553 ///
554 /// This constant is equivalent to `-MAX_EXACT_INTEGER`.
555 ///
556 /// [`MAX_EXACT_INTEGER`]: f64::MAX_EXACT_INTEGER
557 /// [`MIN_EXACT_INTEGER`]: f64::MIN_EXACT_INTEGER
558 /// ```
559 /// #![feature(float_exact_integer_constants)]
560 /// # // FIXME(#152635): Float rounding on `i586` does not adhere to IEEE 754
561 /// # #[cfg(not(all(target_arch = "x86", not(target_feature = "sse"))))] {
562 /// let min_exact_int = f64::MIN_EXACT_INTEGER;
563 /// assert_eq!(min_exact_int, min_exact_int as f64 as i64);
564 /// assert_eq!(min_exact_int - 1, (min_exact_int - 1) as f64 as i64);
565 /// assert_ne!(min_exact_int - 2, (min_exact_int - 2) as f64 as i64);
566 ///
567 /// // Below `f64::MIN_EXACT_INTEGER`, multiple integers can map to one float value
568 /// assert_eq!((min_exact_int - 1) as f64, (min_exact_int - 2) as f64);
569 /// # }
570 /// ```
571 #[unstable(feature = "float_exact_integer_constants", issue = "152466")]
572 pub const MIN_EXACT_INTEGER: i64 = -Self::MAX_EXACT_INTEGER;
573
574 /// Sign bit
575 pub(crate) const SIGN_MASK: u64 = 0x8000_0000_0000_0000;
576
577 /// Exponent mask
578 pub(crate) const EXP_MASK: u64 = 0x7ff0_0000_0000_0000;
579
580 /// Mantissa mask
581 pub(crate) const MAN_MASK: u64 = 0x000f_ffff_ffff_ffff;
582
583 /// Minimum representable positive value (min subnormal)
584 const TINY_BITS: u64 = 0x1;
585
586 /// Minimum representable negative value (min negative subnormal)
587 const NEG_TINY_BITS: u64 = Self::TINY_BITS | Self::SIGN_MASK;
588
589 /// Returns `true` if this value is NaN.
590 ///
591 /// ```
592 /// let nan = f64::NAN;
593 /// let f = 7.0_f64;
594 ///
595 /// assert!(nan.is_nan());
596 /// assert!(!f.is_nan());
597 /// ```
598 #[must_use]
599 #[stable(feature = "rust1", since = "1.0.0")]
600 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
601 #[inline]
602 #[allow(clippy::eq_op)] // > if you intended to check if the operand is NaN, use `.is_nan()` instead :)
603 pub const fn is_nan(self) -> bool {
604 self != self
605 }
606
607 /// Returns `true` if this value is positive infinity or negative infinity, and
608 /// `false` otherwise.
609 ///
610 /// ```
611 /// let f = 7.0f64;
612 /// let inf = f64::INFINITY;
613 /// let neg_inf = f64::NEG_INFINITY;
614 /// let nan = f64::NAN;
615 ///
616 /// assert!(!f.is_infinite());
617 /// assert!(!nan.is_infinite());
618 ///
619 /// assert!(inf.is_infinite());
620 /// assert!(neg_inf.is_infinite());
621 /// ```
622 #[must_use]
623 #[stable(feature = "rust1", since = "1.0.0")]
624 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
625 #[inline]
626 pub const fn is_infinite(self) -> bool {
627 // Getting clever with transmutation can result in incorrect answers on some FPUs
628 // FIXME: alter the Rust <-> Rust calling convention to prevent this problem.
629 // See https://github.com/rust-lang/rust/issues/72327
630 (self == f64::INFINITY) | (self == f64::NEG_INFINITY)
631 }
632
633 /// Returns `true` if this number is neither infinite nor NaN.
634 ///
635 /// ```
636 /// let f = 7.0f64;
637 /// let inf: f64 = f64::INFINITY;
638 /// let neg_inf: f64 = f64::NEG_INFINITY;
639 /// let nan: f64 = f64::NAN;
640 ///
641 /// assert!(f.is_finite());
642 ///
643 /// assert!(!nan.is_finite());
644 /// assert!(!inf.is_finite());
645 /// assert!(!neg_inf.is_finite());
646 /// ```
647 #[must_use]
648 #[stable(feature = "rust1", since = "1.0.0")]
649 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
650 #[inline]
651 pub const fn is_finite(self) -> bool {
652 // There's no need to handle NaN separately: if self is NaN,
653 // the comparison is not true, exactly as desired.
654 self.abs() < Self::INFINITY
655 }
656
657 /// Returns `true` if the number is [subnormal].
658 ///
659 /// ```
660 /// let min = f64::MIN_POSITIVE; // 2.2250738585072014e-308_f64
661 /// let max = f64::MAX;
662 /// let lower_than_min = 1.0e-308_f64;
663 /// let zero = 0.0_f64;
664 ///
665 /// assert!(!min.is_subnormal());
666 /// assert!(!max.is_subnormal());
667 ///
668 /// assert!(!zero.is_subnormal());
669 /// assert!(!f64::NAN.is_subnormal());
670 /// assert!(!f64::INFINITY.is_subnormal());
671 /// // Values between `0` and `min` are Subnormal.
672 /// assert!(lower_than_min.is_subnormal());
673 /// ```
674 /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
675 #[must_use]
676 #[stable(feature = "is_subnormal", since = "1.53.0")]
677 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
678 #[inline]
679 pub const fn is_subnormal(self) -> bool {
680 matches!(self.classify(), FpCategory::Subnormal)
681 }
682
683 /// Returns `true` if the number is neither zero, infinite,
684 /// [subnormal], or NaN.
685 ///
686 /// ```
687 /// let min = f64::MIN_POSITIVE; // 2.2250738585072014e-308f64
688 /// let max = f64::MAX;
689 /// let lower_than_min = 1.0e-308_f64;
690 /// let zero = 0.0f64;
691 ///
692 /// assert!(min.is_normal());
693 /// assert!(max.is_normal());
694 ///
695 /// assert!(!zero.is_normal());
696 /// assert!(!f64::NAN.is_normal());
697 /// assert!(!f64::INFINITY.is_normal());
698 /// // Values between `0` and `min` are Subnormal.
699 /// assert!(!lower_than_min.is_normal());
700 /// ```
701 /// [subnormal]: https://en.wikipedia.org/wiki/Denormal_number
702 #[must_use]
703 #[stable(feature = "rust1", since = "1.0.0")]
704 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
705 #[inline]
706 pub const fn is_normal(self) -> bool {
707 matches!(self.classify(), FpCategory::Normal)
708 }
709
710 /// Returns the floating point category of the number. If only one property
711 /// is going to be tested, it is generally faster to use the specific
712 /// predicate instead.
713 ///
714 /// ```
715 /// use std::num::FpCategory;
716 ///
717 /// let num = 12.4_f64;
718 /// let inf = f64::INFINITY;
719 ///
720 /// assert_eq!(num.classify(), FpCategory::Normal);
721 /// assert_eq!(inf.classify(), FpCategory::Infinite);
722 /// ```
723 #[stable(feature = "rust1", since = "1.0.0")]
724 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
725 #[must_use]
726 pub const fn classify(self) -> FpCategory {
727 // We used to have complicated logic here that avoids the simple bit-based tests to work
728 // around buggy codegen for x87 targets (see
729 // https://github.com/rust-lang/rust/issues/114479). However, some LLVM versions later, none
730 // of our tests is able to find any difference between the complicated and the naive
731 // version, so now we are back to the naive version.
732 let b = self.to_bits();
733 match (b & Self::MAN_MASK, b & Self::EXP_MASK) {
734 (0, Self::EXP_MASK) => FpCategory::Infinite,
735 (_, Self::EXP_MASK) => FpCategory::Nan,
736 (0, 0) => FpCategory::Zero,
737 (_, 0) => FpCategory::Subnormal,
738 _ => FpCategory::Normal,
739 }
740 }
741
742 /// Returns `true` if `self` has a positive sign, including `+0.0`, NaNs with
743 /// positive sign bit and positive infinity.
744 ///
745 /// Note that IEEE 754 doesn't assign any meaning to the sign bit in case of
746 /// a NaN, and as Rust doesn't guarantee that the bit pattern of NaNs are
747 /// conserved over arithmetic operations, the result of `is_sign_positive` on
748 /// a NaN might produce an unexpected or non-portable result. See the [specification
749 /// of NaN bit patterns](f32#nan-bit-patterns) for more info. Use `self.signum() == 1.0`
750 /// if you need fully portable behavior (will return `false` for all NaNs).
751 ///
752 /// ```
753 /// let f = 7.0_f64;
754 /// let g = -7.0_f64;
755 ///
756 /// assert!(f.is_sign_positive());
757 /// assert!(!g.is_sign_positive());
758 /// ```
759 #[must_use]
760 #[stable(feature = "rust1", since = "1.0.0")]
761 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
762 #[inline]
763 pub const fn is_sign_positive(self) -> bool {
764 !self.is_sign_negative()
765 }
766
767 #[must_use]
768 #[stable(feature = "rust1", since = "1.0.0")]
769 #[deprecated(since = "1.0.0", note = "renamed to is_sign_positive")]
770 #[inline]
771 #[doc(hidden)]
772 pub fn is_positive(self) -> bool {
773 self.is_sign_positive()
774 }
775
776 /// Returns `true` if `self` has a negative sign, including `-0.0`, NaNs with
777 /// negative sign bit and negative infinity.
778 ///
779 /// Note that IEEE 754 doesn't assign any meaning to the sign bit in case of
780 /// a NaN, and as Rust doesn't guarantee that the bit pattern of NaNs are
781 /// conserved over arithmetic operations, the result of `is_sign_negative` on
782 /// a NaN might produce an unexpected or non-portable result. See the [specification
783 /// of NaN bit patterns](f32#nan-bit-patterns) for more info. Use `self.signum() == -1.0`
784 /// if you need fully portable behavior (will return `false` for all NaNs).
785 ///
786 /// ```
787 /// let f = 7.0_f64;
788 /// let g = -7.0_f64;
789 ///
790 /// assert!(!f.is_sign_negative());
791 /// assert!(g.is_sign_negative());
792 /// ```
793 #[must_use]
794 #[stable(feature = "rust1", since = "1.0.0")]
795 #[rustc_const_stable(feature = "const_float_classify", since = "1.83.0")]
796 #[inline]
797 pub const fn is_sign_negative(self) -> bool {
798 // IEEE754 says: isSignMinus(x) is true if and only if x has negative sign. isSignMinus
799 // applies to zeros and NaNs as well.
800 self.to_bits() & Self::SIGN_MASK != 0
801 }
802
803 #[must_use]
804 #[stable(feature = "rust1", since = "1.0.0")]
805 #[deprecated(since = "1.0.0", note = "renamed to is_sign_negative")]
806 #[inline]
807 #[doc(hidden)]
808 pub fn is_negative(self) -> bool {
809 self.is_sign_negative()
810 }
811
812 /// Returns the least number greater than `self`.
813 ///
814 /// Let `TINY` be the smallest representable positive `f64`. Then,
815 /// - if `self.is_nan()`, this returns `self`;
816 /// - if `self` is [`NEG_INFINITY`], this returns [`MIN`];
817 /// - if `self` is `-TINY`, this returns -0.0;
818 /// - if `self` is -0.0 or +0.0, this returns `TINY`;
819 /// - if `self` is [`MAX`] or [`INFINITY`], this returns [`INFINITY`];
820 /// - otherwise the unique least value greater than `self` is returned.
821 ///
822 /// The identity `x.next_up() == -(-x).next_down()` holds for all non-NaN `x`. When `x`
823 /// is finite `x == x.next_up().next_down()` also holds.
824 ///
825 /// ```rust
826 /// // f64::EPSILON is the difference between 1.0 and the next number up.
827 /// assert_eq!(1.0f64.next_up(), 1.0 + f64::EPSILON);
828 /// // But not for most numbers.
829 /// assert!(0.1f64.next_up() < 0.1 + f64::EPSILON);
830 /// assert_eq!(9007199254740992f64.next_up(), 9007199254740994.0);
831 /// ```
832 ///
833 /// This operation corresponds to IEEE-754 `nextUp`.
834 ///
835 /// [`NEG_INFINITY`]: Self::NEG_INFINITY
836 /// [`INFINITY`]: Self::INFINITY
837 /// [`MIN`]: Self::MIN
838 /// [`MAX`]: Self::MAX
839 #[inline]
840 #[doc(alias = "nextUp")]
841 #[stable(feature = "float_next_up_down", since = "1.86.0")]
842 #[rustc_const_stable(feature = "float_next_up_down", since = "1.86.0")]
843 #[must_use = "method returns a new number and does not mutate the original value"]
844 pub const fn next_up(self) -> Self {
845 // Some targets violate Rust's assumption of IEEE semantics, e.g. by flushing
846 // denormals to zero. This is in general unsound and unsupported, but here
847 // we do our best to still produce the correct result on such targets.
848 let bits = self.to_bits();
849 if self.is_nan() || bits == Self::INFINITY.to_bits() {
850 return self;
851 }
852
853 let abs = bits & !Self::SIGN_MASK;
854 let next_bits = if abs == 0 {
855 Self::TINY_BITS
856 } else if bits == abs {
857 bits + 1
858 } else {
859 bits - 1
860 };
861 Self::from_bits(next_bits)
862 }
863
864 /// Returns the greatest number less than `self`.
865 ///
866 /// Let `TINY` be the smallest representable positive `f64`. Then,
867 /// - if `self.is_nan()`, this returns `self`;
868 /// - if `self` is [`INFINITY`], this returns [`MAX`];
869 /// - if `self` is `TINY`, this returns 0.0;
870 /// - if `self` is -0.0 or +0.0, this returns `-TINY`;
871 /// - if `self` is [`MIN`] or [`NEG_INFINITY`], this returns [`NEG_INFINITY`];
872 /// - otherwise the unique greatest value less than `self` is returned.
873 ///
874 /// The identity `x.next_down() == -(-x).next_up()` holds for all non-NaN `x`. When `x`
875 /// is finite `x == x.next_down().next_up()` also holds.
876 ///
877 /// ```rust
878 /// let x = 1.0f64;
879 /// // Clamp value into range [0, 1).
880 /// let clamped = x.clamp(0.0, 1.0f64.next_down());
881 /// assert!(clamped < 1.0);
882 /// assert_eq!(clamped.next_up(), 1.0);
883 /// ```
884 ///
885 /// This operation corresponds to IEEE-754 `nextDown`.
886 ///
887 /// [`NEG_INFINITY`]: Self::NEG_INFINITY
888 /// [`INFINITY`]: Self::INFINITY
889 /// [`MIN`]: Self::MIN
890 /// [`MAX`]: Self::MAX
891 #[inline]
892 #[doc(alias = "nextDown")]
893 #[stable(feature = "float_next_up_down", since = "1.86.0")]
894 #[rustc_const_stable(feature = "float_next_up_down", since = "1.86.0")]
895 #[must_use = "method returns a new number and does not mutate the original value"]
896 pub const fn next_down(self) -> Self {
897 // Some targets violate Rust's assumption of IEEE semantics, e.g. by flushing
898 // denormals to zero. This is in general unsound and unsupported, but here
899 // we do our best to still produce the correct result on such targets.
900 let bits = self.to_bits();
901 if self.is_nan() || bits == Self::NEG_INFINITY.to_bits() {
902 return self;
903 }
904
905 let abs = bits & !Self::SIGN_MASK;
906 let next_bits = if abs == 0 {
907 Self::NEG_TINY_BITS
908 } else if bits == abs {
909 bits - 1
910 } else {
911 bits + 1
912 };
913 Self::from_bits(next_bits)
914 }
915
916 /// Takes the reciprocal (inverse) of a number, `1/x`.
917 ///
918 /// ```
919 /// let x = 2.0_f64;
920 /// let abs_difference = (x.recip() - (1.0 / x)).abs();
921 ///
922 /// assert!(abs_difference < 1e-10);
923 /// ```
924 #[must_use = "this returns the result of the operation, without modifying the original"]
925 #[stable(feature = "rust1", since = "1.0.0")]
926 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
927 #[inline]
928 pub const fn recip(self) -> f64 {
929 1.0 / self
930 }
931
932 /// Converts radians to degrees.
933 ///
934 /// # Unspecified precision
935 ///
936 /// The precision of this function is non-deterministic. This means it varies by platform,
937 /// Rust version, and can even differ within the same execution from one invocation to the next.
938 ///
939 /// # Examples
940 ///
941 /// ```
942 /// let angle = std::f64::consts::PI;
943 ///
944 /// let abs_difference = (angle.to_degrees() - 180.0).abs();
945 ///
946 /// assert!(abs_difference < 1e-10);
947 /// ```
948 #[must_use = "this returns the result of the operation, \
949 without modifying the original"]
950 #[stable(feature = "rust1", since = "1.0.0")]
951 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
952 #[inline]
953 pub const fn to_degrees(self) -> f64 {
954 // The division here is correctly rounded with respect to the true value of 180/π.
955 // Although π is irrational and already rounded, the double rounding happens
956 // to produce correct result for f64.
957 const PIS_IN_180: f64 = 180.0 / consts::PI;
958 self * PIS_IN_180
959 }
960
961 /// Converts degrees to radians.
962 ///
963 /// # Unspecified precision
964 ///
965 /// The precision of this function is non-deterministic. This means it varies by platform,
966 /// Rust version, and can even differ within the same execution from one invocation to the next.
967 ///
968 /// # Examples
969 ///
970 /// ```
971 /// let angle = 180.0_f64;
972 ///
973 /// let abs_difference = (angle.to_radians() - std::f64::consts::PI).abs();
974 ///
975 /// assert!(abs_difference < 1e-10);
976 /// ```
977 #[must_use = "this returns the result of the operation, \
978 without modifying the original"]
979 #[stable(feature = "rust1", since = "1.0.0")]
980 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
981 #[inline]
982 pub const fn to_radians(self) -> f64 {
983 // The division here is correctly rounded with respect to the true value of π/180.
984 // Although π is irrational and already rounded, the double rounding happens
985 // to produce correct result for f64.
986 const RADS_PER_DEG: f64 = consts::PI / 180.0;
987 self * RADS_PER_DEG
988 }
989
990 /// Returns the maximum of the two numbers, ignoring NaN.
991 ///
992 /// If exactly one of the arguments is NaN (quiet or signaling), then the other argument is
993 /// returned. If both arguments are NaN, the return value is NaN, with the bit pattern picked
994 /// using the usual [rules for arithmetic operations](f32#nan-bit-patterns). If the inputs
995 /// compare equal (such as for the case of `+0.0` and `-0.0`), either input may be returned
996 /// non-deterministically.
997 ///
998 /// The handling of NaNs follows the IEEE 754-2019 semantics for `maximumNumber`, treating all
999 /// NaNs the same way to ensure the operation is associative. The handling of signed zeros
1000 /// follows the IEEE 754-2008 semantics for `maxNum`.
1001 ///
1002 /// ```
1003 /// let x = 1.0_f64;
1004 /// let y = 2.0_f64;
1005 ///
1006 /// assert_eq!(x.max(y), y);
1007 /// assert_eq!(x.max(f64::NAN), x);
1008 /// ```
1009 #[must_use = "this returns the result of the comparison, without modifying either input"]
1010 #[stable(feature = "rust1", since = "1.0.0")]
1011 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1012 #[inline]
1013 pub const fn max(self, other: f64) -> f64 {
1014 intrinsics::maximum_number_nsz_f64(self, other)
1015 }
1016
1017 /// Returns the minimum of the two numbers, ignoring NaN.
1018 ///
1019 /// If exactly one of the arguments is NaN (quiet or signaling), then the other argument is
1020 /// returned. If both arguments are NaN, the return value is NaN, with the bit pattern picked
1021 /// using the usual [rules for arithmetic operations](f32#nan-bit-patterns). If the inputs
1022 /// compare equal (such as for the case of `+0.0` and `-0.0`), either input may be returned
1023 /// non-deterministically.
1024 ///
1025 /// The handling of NaNs follows the IEEE 754-2019 semantics for `minimumNumber`, treating all
1026 /// NaNs the same way to ensure the operation is associative. The handling of signed zeros
1027 /// follows the IEEE 754-2008 semantics for `minNum`.
1028 ///
1029 /// ```
1030 /// let x = 1.0_f64;
1031 /// let y = 2.0_f64;
1032 ///
1033 /// assert_eq!(x.min(y), x);
1034 /// assert_eq!(x.min(f64::NAN), x);
1035 /// ```
1036 #[must_use = "this returns the result of the comparison, without modifying either input"]
1037 #[stable(feature = "rust1", since = "1.0.0")]
1038 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1039 #[inline]
1040 pub const fn min(self, other: f64) -> f64 {
1041 intrinsics::minimum_number_nsz_f64(self, other)
1042 }
1043
1044 /// Returns the maximum of the two numbers, propagating NaN.
1045 ///
1046 /// If at least one of the arguments is NaN, the return value is NaN, with the bit pattern
1047 /// picked using the usual [rules for arithmetic operations](f32#nan-bit-patterns). Furthermore,
1048 /// `-0.0` is considered to be less than `+0.0`, making this function fully deterministic for
1049 /// non-NaN inputs.
1050 ///
1051 /// This is in contrast to [`f64::max`] which only returns NaN when *both* arguments are NaN,
1052 /// and which does not reliably order `-0.0` and `+0.0`.
1053 ///
1054 /// This follows the IEEE 754-2019 semantics for `maximum`.
1055 ///
1056 /// ```
1057 /// #![feature(float_minimum_maximum)]
1058 /// let x = 1.0_f64;
1059 /// let y = 2.0_f64;
1060 ///
1061 /// assert_eq!(x.maximum(y), y);
1062 /// assert!(x.maximum(f64::NAN).is_nan());
1063 /// ```
1064 #[must_use = "this returns the result of the comparison, without modifying either input"]
1065 #[unstable(feature = "float_minimum_maximum", issue = "91079")]
1066 #[inline]
1067 pub const fn maximum(self, other: f64) -> f64 {
1068 intrinsics::maximumf64(self, other)
1069 }
1070
1071 /// Returns the minimum of the two numbers, propagating NaN.
1072 ///
1073 /// If at least one of the arguments is NaN, the return value is NaN, with the bit pattern
1074 /// picked using the usual [rules for arithmetic operations](f32#nan-bit-patterns). Furthermore,
1075 /// `-0.0` is considered to be less than `+0.0`, making this function fully deterministic for
1076 /// non-NaN inputs.
1077 ///
1078 /// This is in contrast to [`f64::min`] which only returns NaN when *both* arguments are NaN,
1079 /// and which does not reliably order `-0.0` and `+0.0`.
1080 ///
1081 /// This follows the IEEE 754-2019 semantics for `minimum`.
1082 ///
1083 /// ```
1084 /// #![feature(float_minimum_maximum)]
1085 /// let x = 1.0_f64;
1086 /// let y = 2.0_f64;
1087 ///
1088 /// assert_eq!(x.minimum(y), x);
1089 /// assert!(x.minimum(f64::NAN).is_nan());
1090 /// ```
1091 #[must_use = "this returns the result of the comparison, without modifying either input"]
1092 #[unstable(feature = "float_minimum_maximum", issue = "91079")]
1093 #[inline]
1094 pub const fn minimum(self, other: f64) -> f64 {
1095 intrinsics::minimumf64(self, other)
1096 }
1097
1098 /// Calculates the midpoint (average) between `self` and `rhs`.
1099 ///
1100 /// This returns NaN when *either* argument is NaN or if a combination of
1101 /// +inf and -inf is provided as arguments.
1102 ///
1103 /// # Examples
1104 ///
1105 /// ```
1106 /// assert_eq!(1f64.midpoint(4.0), 2.5);
1107 /// assert_eq!((-5.5f64).midpoint(8.0), 1.25);
1108 /// ```
1109 #[inline]
1110 #[doc(alias = "average")]
1111 #[stable(feature = "num_midpoint", since = "1.85.0")]
1112 #[rustc_const_stable(feature = "num_midpoint", since = "1.85.0")]
1113 #[must_use = "this returns the result of the operation, \
1114 without modifying the original"]
1115 pub const fn midpoint(self, other: f64) -> f64 {
1116 const HI: f64 = f64::MAX / 2.;
1117
1118 let (a, b) = (self, other);
1119 let abs_a = a.abs();
1120 let abs_b = b.abs();
1121
1122 if abs_a <= HI && abs_b <= HI {
1123 // Overflow is impossible
1124 (a + b) / 2.
1125 } else {
1126 (a / 2.) + (b / 2.)
1127 }
1128 }
1129
1130 /// Rounds toward zero and converts to any primitive integer type,
1131 /// assuming that the value is finite and fits in that type.
1132 ///
1133 /// ```
1134 /// let value = 4.6_f64;
1135 /// let rounded = unsafe { value.to_int_unchecked::<u16>() };
1136 /// assert_eq!(rounded, 4);
1137 ///
1138 /// let value = -128.9_f64;
1139 /// let rounded = unsafe { value.to_int_unchecked::<i8>() };
1140 /// assert_eq!(rounded, i8::MIN);
1141 /// ```
1142 ///
1143 /// # Safety
1144 ///
1145 /// The value must:
1146 ///
1147 /// * Not be `NaN`
1148 /// * Not be infinite
1149 /// * Be representable in the return type `Int`, after truncating off its fractional part
1150 #[must_use = "this returns the result of the operation, \
1151 without modifying the original"]
1152 #[stable(feature = "float_approx_unchecked_to", since = "1.44.0")]
1153 #[inline]
1154 pub unsafe fn to_int_unchecked<Int>(self) -> Int
1155 where
1156 Self: FloatToInt<Int>,
1157 {
1158 // SAFETY: the caller must uphold the safety contract for
1159 // `FloatToInt::to_int_unchecked`.
1160 unsafe { FloatToInt::<Int>::to_int_unchecked(self) }
1161 }
1162
1163 /// Raw transmutation to `u64`.
1164 ///
1165 /// This is currently identical to `transmute::<f64, u64>(self)` on all platforms.
1166 ///
1167 /// See [`from_bits`](Self::from_bits) for some discussion of the
1168 /// portability of this operation (there are almost no issues).
1169 ///
1170 /// Note that this function is distinct from `as` casting, which attempts to
1171 /// preserve the *numeric* value, and not the bitwise value.
1172 ///
1173 /// # Examples
1174 ///
1175 /// ```
1176 /// assert!((1f64).to_bits() != 1f64 as u64); // to_bits() is not casting!
1177 /// assert_eq!((12.5f64).to_bits(), 0x4029000000000000);
1178 /// ```
1179 #[must_use = "this returns the result of the operation, \
1180 without modifying the original"]
1181 #[stable(feature = "float_bits_conv", since = "1.20.0")]
1182 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1183 #[allow(unnecessary_transmutes)]
1184 #[inline]
1185 pub const fn to_bits(self) -> u64 {
1186 // SAFETY: `u64` is a plain old datatype so we can always transmute to it.
1187 unsafe { mem::transmute(self) }
1188 }
1189
1190 /// Raw transmutation from `u64`.
1191 ///
1192 /// This is currently identical to `transmute::<u64, f64>(v)` on all platforms.
1193 /// It turns out this is incredibly portable, for two reasons:
1194 ///
1195 /// * Floats and Ints have the same endianness on all supported platforms.
1196 /// * IEEE 754 very precisely specifies the bit layout of floats.
1197 ///
1198 /// However there is one caveat: prior to the 2008 version of IEEE 754, how
1199 /// to interpret the NaN signaling bit wasn't actually specified. Most platforms
1200 /// (notably x86 and ARM) picked the interpretation that was ultimately
1201 /// standardized in 2008, but some didn't (notably MIPS). As a result, all
1202 /// signaling NaNs on MIPS are quiet NaNs on x86, and vice-versa.
1203 ///
1204 /// Rather than trying to preserve signaling-ness cross-platform, this
1205 /// implementation favors preserving the exact bits. This means that
1206 /// any payloads encoded in NaNs will be preserved even if the result of
1207 /// this method is sent over the network from an x86 machine to a MIPS one.
1208 ///
1209 /// If the results of this method are only manipulated by the same
1210 /// architecture that produced them, then there is no portability concern.
1211 ///
1212 /// If the input isn't NaN, then there is no portability concern.
1213 ///
1214 /// If you don't care about signaling-ness (very likely), then there is no
1215 /// portability concern.
1216 ///
1217 /// Note that this function is distinct from `as` casting, which attempts to
1218 /// preserve the *numeric* value, and not the bitwise value.
1219 ///
1220 /// # Examples
1221 ///
1222 /// ```
1223 /// let v = f64::from_bits(0x4029000000000000);
1224 /// assert_eq!(v, 12.5);
1225 /// ```
1226 #[stable(feature = "float_bits_conv", since = "1.20.0")]
1227 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1228 #[must_use]
1229 #[inline]
1230 #[allow(unnecessary_transmutes)]
1231 pub const fn from_bits(v: u64) -> Self {
1232 // It turns out the safety issues with sNaN were overblown! Hooray!
1233 // SAFETY: `u64` is a plain old datatype so we can always transmute from it.
1234 unsafe { mem::transmute(v) }
1235 }
1236
1237 /// Returns the memory representation of this floating point number as a byte array in
1238 /// big-endian (network) byte order.
1239 ///
1240 /// See [`from_bits`](Self::from_bits) for some discussion of the
1241 /// portability of this operation (there are almost no issues).
1242 ///
1243 /// # Examples
1244 ///
1245 /// ```
1246 /// let bytes = 12.5f64.to_be_bytes();
1247 /// assert_eq!(bytes, [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
1248 /// ```
1249 #[must_use = "this returns the result of the operation, \
1250 without modifying the original"]
1251 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1252 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1253 #[inline]
1254 pub const fn to_be_bytes(self) -> [u8; 8] {
1255 self.to_bits().to_be_bytes()
1256 }
1257
1258 /// Returns the memory representation of this floating point number as a byte array in
1259 /// little-endian byte order.
1260 ///
1261 /// See [`from_bits`](Self::from_bits) for some discussion of the
1262 /// portability of this operation (there are almost no issues).
1263 ///
1264 /// # Examples
1265 ///
1266 /// ```
1267 /// let bytes = 12.5f64.to_le_bytes();
1268 /// assert_eq!(bytes, [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]);
1269 /// ```
1270 #[must_use = "this returns the result of the operation, \
1271 without modifying the original"]
1272 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1273 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1274 #[inline]
1275 pub const fn to_le_bytes(self) -> [u8; 8] {
1276 self.to_bits().to_le_bytes()
1277 }
1278
1279 /// Returns the memory representation of this floating point number as a byte array in
1280 /// native byte order.
1281 ///
1282 /// As the target platform's native endianness is used, portable code
1283 /// should use [`to_be_bytes`] or [`to_le_bytes`], as appropriate, instead.
1284 ///
1285 /// [`to_be_bytes`]: f64::to_be_bytes
1286 /// [`to_le_bytes`]: f64::to_le_bytes
1287 ///
1288 /// See [`from_bits`](Self::from_bits) for some discussion of the
1289 /// portability of this operation (there are almost no issues).
1290 ///
1291 /// # Examples
1292 ///
1293 /// ```
1294 /// let bytes = 12.5f64.to_ne_bytes();
1295 /// assert_eq!(
1296 /// bytes,
1297 /// if cfg!(target_endian = "big") {
1298 /// [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
1299 /// } else {
1300 /// [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]
1301 /// }
1302 /// );
1303 /// ```
1304 #[must_use = "this returns the result of the operation, \
1305 without modifying the original"]
1306 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1307 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1308 #[inline]
1309 pub const fn to_ne_bytes(self) -> [u8; 8] {
1310 self.to_bits().to_ne_bytes()
1311 }
1312
1313 /// Creates a floating point value from its representation as a byte array in big endian.
1314 ///
1315 /// See [`from_bits`](Self::from_bits) for some discussion of the
1316 /// portability of this operation (there are almost no issues).
1317 ///
1318 /// # Examples
1319 ///
1320 /// ```
1321 /// let value = f64::from_be_bytes([0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
1322 /// assert_eq!(value, 12.5);
1323 /// ```
1324 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1325 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1326 #[must_use]
1327 #[inline]
1328 pub const fn from_be_bytes(bytes: [u8; 8]) -> Self {
1329 Self::from_bits(u64::from_be_bytes(bytes))
1330 }
1331
1332 /// Creates a floating point value from its representation as a byte array in little endian.
1333 ///
1334 /// See [`from_bits`](Self::from_bits) for some discussion of the
1335 /// portability of this operation (there are almost no issues).
1336 ///
1337 /// # Examples
1338 ///
1339 /// ```
1340 /// let value = f64::from_le_bytes([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]);
1341 /// assert_eq!(value, 12.5);
1342 /// ```
1343 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1344 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1345 #[must_use]
1346 #[inline]
1347 pub const fn from_le_bytes(bytes: [u8; 8]) -> Self {
1348 Self::from_bits(u64::from_le_bytes(bytes))
1349 }
1350
1351 /// Creates a floating point value from its representation as a byte array in native endian.
1352 ///
1353 /// As the target platform's native endianness is used, portable code
1354 /// likely wants to use [`from_be_bytes`] or [`from_le_bytes`], as
1355 /// appropriate instead.
1356 ///
1357 /// [`from_be_bytes`]: f64::from_be_bytes
1358 /// [`from_le_bytes`]: f64::from_le_bytes
1359 ///
1360 /// See [`from_bits`](Self::from_bits) for some discussion of the
1361 /// portability of this operation (there are almost no issues).
1362 ///
1363 /// # Examples
1364 ///
1365 /// ```
1366 /// let value = f64::from_ne_bytes(if cfg!(target_endian = "big") {
1367 /// [0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]
1368 /// } else {
1369 /// [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40]
1370 /// });
1371 /// assert_eq!(value, 12.5);
1372 /// ```
1373 #[stable(feature = "float_to_from_bytes", since = "1.40.0")]
1374 #[rustc_const_stable(feature = "const_float_bits_conv", since = "1.83.0")]
1375 #[must_use]
1376 #[inline]
1377 pub const fn from_ne_bytes(bytes: [u8; 8]) -> Self {
1378 Self::from_bits(u64::from_ne_bytes(bytes))
1379 }
1380
1381 /// Returns the ordering between `self` and `other`.
1382 ///
1383 /// Unlike the standard partial comparison between floating point numbers,
1384 /// this comparison always produces an ordering in accordance to
1385 /// the `totalOrder` predicate as defined in the IEEE 754 (2008 revision)
1386 /// floating point standard. The values are ordered in the following sequence:
1387 ///
1388 /// - negative quiet NaN
1389 /// - negative signaling NaN
1390 /// - negative infinity
1391 /// - negative numbers
1392 /// - negative subnormal numbers
1393 /// - negative zero
1394 /// - positive zero
1395 /// - positive subnormal numbers
1396 /// - positive numbers
1397 /// - positive infinity
1398 /// - positive signaling NaN
1399 /// - positive quiet NaN.
1400 ///
1401 /// The ordering established by this function does not always agree with the
1402 /// [`PartialOrd`] and [`PartialEq`] implementations of `f64`. For example,
1403 /// they consider negative and positive zero equal, while `total_cmp`
1404 /// doesn't.
1405 ///
1406 /// The interpretation of the signaling NaN bit follows the definition in
1407 /// the IEEE 754 standard, which may not match the interpretation by some of
1408 /// the older, non-conformant (e.g. MIPS) hardware implementations.
1409 ///
1410 /// # Example
1411 ///
1412 /// ```
1413 /// struct GoodBoy {
1414 /// name: String,
1415 /// weight: f64,
1416 /// }
1417 ///
1418 /// let mut bois = vec![
1419 /// GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
1420 /// GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
1421 /// GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
1422 /// GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
1423 /// GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
1424 /// GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
1425 /// ];
1426 ///
1427 /// bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));
1428 ///
1429 /// // `f64::NAN` could be positive or negative, which will affect the sort order.
1430 /// if f64::NAN.is_sign_negative() {
1431 /// assert!(bois.into_iter().map(|b| b.weight)
1432 /// .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
1433 /// .all(|(a, b)| a.to_bits() == b.to_bits()))
1434 /// } else {
1435 /// assert!(bois.into_iter().map(|b| b.weight)
1436 /// .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
1437 /// .all(|(a, b)| a.to_bits() == b.to_bits()))
1438 /// }
1439 /// ```
1440 #[stable(feature = "total_cmp", since = "1.62.0")]
1441 #[rustc_const_unstable(feature = "const_cmp", issue = "143800")]
1442 #[must_use]
1443 #[inline]
1444 pub const fn total_cmp(&self, other: &Self) -> crate::cmp::Ordering {
1445 let mut left = self.to_bits() as i64;
1446 let mut right = other.to_bits() as i64;
1447
1448 // In case of negatives, flip all the bits except the sign
1449 // to achieve a similar layout as two's complement integers
1450 //
1451 // Why does this work? IEEE 754 floats consist of three fields:
1452 // Sign bit, exponent and mantissa. The set of exponent and mantissa
1453 // fields as a whole have the property that their bitwise order is
1454 // equal to the numeric magnitude where the magnitude is defined.
1455 // The magnitude is not normally defined on NaN values, but
1456 // IEEE 754 totalOrder defines the NaN values also to follow the
1457 // bitwise order. This leads to order explained in the doc comment.
1458 // However, the representation of magnitude is the same for negative
1459 // and positive numbers – only the sign bit is different.
1460 // To easily compare the floats as signed integers, we need to
1461 // flip the exponent and mantissa bits in case of negative numbers.
1462 // We effectively convert the numbers to "two's complement" form.
1463 //
1464 // To do the flipping, we construct a mask and XOR against it.
1465 // We branchlessly calculate an "all-ones except for the sign bit"
1466 // mask from negative-signed values: right shifting sign-extends
1467 // the integer, so we "fill" the mask with sign bits, and then
1468 // convert to unsigned to push one more zero bit.
1469 // On positive values, the mask is all zeros, so it's a no-op.
1470 left ^= (((left >> 63) as u64) >> 1) as i64;
1471 right ^= (((right >> 63) as u64) >> 1) as i64;
1472
1473 left.cmp(&right)
1474 }
1475
1476 /// Restrict a value to a certain interval unless it is NaN.
1477 ///
1478 /// Returns `max` if `self` is greater than `max`, and `min` if `self` is
1479 /// less than `min`. Otherwise this returns `self`.
1480 ///
1481 /// Note that this function returns NaN if the initial value was NaN as
1482 /// well. If the result is zero and among the three inputs `self`, `min`, and `max` there are
1483 /// zeros with different sign, either `0.0` or `-0.0` is returned non-deterministically.
1484 ///
1485 /// # Panics
1486 ///
1487 /// Panics if `min > max`, `min` is NaN, or `max` is NaN.
1488 ///
1489 /// # Examples
1490 ///
1491 /// ```
1492 /// assert!((-3.0f64).clamp(-2.0, 1.0) == -2.0);
1493 /// assert!((0.0f64).clamp(-2.0, 1.0) == 0.0);
1494 /// assert!((2.0f64).clamp(-2.0, 1.0) == 1.0);
1495 /// assert!((f64::NAN).clamp(-2.0, 1.0).is_nan());
1496 ///
1497 /// // These always returns zero, but the sign (which is ignored by `==`) is non-deterministic.
1498 /// assert!((0.0f64).clamp(-0.0, -0.0) == 0.0);
1499 /// assert!((1.0f64).clamp(-0.0, 0.0) == 0.0);
1500 /// // This is definitely a negative zero.
1501 /// assert!((-1.0f64).clamp(-0.0, 1.0).is_sign_negative());
1502 /// ```
1503 #[must_use = "method returns a new number and does not mutate the original value"]
1504 #[stable(feature = "clamp", since = "1.50.0")]
1505 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1506 #[inline]
1507 pub const fn clamp(mut self, min: f64, max: f64) -> f64 {
1508 const_assert!(
1509 min <= max,
1510 "min > max, or either was NaN",
1511 "min > max, or either was NaN. min = {min:?}, max = {max:?}",
1512 min: f64,
1513 max: f64,
1514 );
1515
1516 if self < min {
1517 self = min;
1518 }
1519 if self > max {
1520 self = max;
1521 }
1522 self
1523 }
1524
1525 /// Clamps this number to a symmetric range centered around zero.
1526 ///
1527 /// The method clamps the number's magnitude (absolute value) to be at most `limit`.
1528 ///
1529 /// This is functionally equivalent to `self.clamp(-limit, limit)`, but is more
1530 /// explicit about the intent.
1531 ///
1532 /// # Panics
1533 ///
1534 /// Panics if `limit` is negative or NaN, as this indicates a logic error.
1535 ///
1536 /// # Examples
1537 ///
1538 /// ```
1539 /// #![feature(clamp_magnitude)]
1540 /// assert_eq!(5.0f64.clamp_magnitude(3.0), 3.0);
1541 /// assert_eq!((-5.0f64).clamp_magnitude(3.0), -3.0);
1542 /// assert_eq!(2.0f64.clamp_magnitude(3.0), 2.0);
1543 /// assert_eq!((-2.0f64).clamp_magnitude(3.0), -2.0);
1544 /// ```
1545 #[must_use = "this returns the clamped value and does not modify the original"]
1546 #[unstable(feature = "clamp_magnitude", issue = "148519")]
1547 #[inline]
1548 pub fn clamp_magnitude(self, limit: f64) -> f64 {
1549 assert!(limit >= 0.0, "limit must be non-negative");
1550 let limit = limit.abs(); // Canonicalises -0.0 to 0.0
1551 self.clamp(-limit, limit)
1552 }
1553
1554 /// Computes the absolute value of `self`.
1555 ///
1556 /// This function always returns the precise result.
1557 ///
1558 /// # Examples
1559 ///
1560 /// ```
1561 /// let x = 3.5_f64;
1562 /// let y = -3.5_f64;
1563 ///
1564 /// assert_eq!(x.abs(), x);
1565 /// assert_eq!(y.abs(), -y);
1566 ///
1567 /// assert!(f64::NAN.abs().is_nan());
1568 /// ```
1569 #[must_use = "method returns a new number and does not mutate the original value"]
1570 #[stable(feature = "rust1", since = "1.0.0")]
1571 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1572 #[inline]
1573 pub const fn abs(self) -> f64 {
1574 intrinsics::fabs(self)
1575 }
1576
1577 /// Returns a number that represents the sign of `self`.
1578 ///
1579 /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
1580 /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
1581 /// - NaN if the number is NaN
1582 ///
1583 /// # Examples
1584 ///
1585 /// ```
1586 /// let f = 3.5_f64;
1587 ///
1588 /// assert_eq!(f.signum(), 1.0);
1589 /// assert_eq!(f64::NEG_INFINITY.signum(), -1.0);
1590 ///
1591 /// assert!(f64::NAN.signum().is_nan());
1592 /// ```
1593 #[must_use = "method returns a new number and does not mutate the original value"]
1594 #[stable(feature = "rust1", since = "1.0.0")]
1595 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1596 #[inline]
1597 pub const fn signum(self) -> f64 {
1598 if self.is_nan() { Self::NAN } else { 1.0_f64.copysign(self) }
1599 }
1600
1601 /// Returns a number composed of the magnitude of `self` and the sign of
1602 /// `sign`.
1603 ///
1604 /// Equal to `self` if the sign of `self` and `sign` are the same, otherwise equal to `-self`.
1605 /// If `self` is a NaN, then a NaN with the same payload as `self` and the sign bit of `sign` is
1606 /// returned.
1607 ///
1608 /// If `sign` is a NaN, then this operation will still carry over its sign into the result. Note
1609 /// that IEEE 754 doesn't assign any meaning to the sign bit in case of a NaN, and as Rust
1610 /// doesn't guarantee that the bit pattern of NaNs are conserved over arithmetic operations, the
1611 /// result of `copysign` with `sign` being a NaN might produce an unexpected or non-portable
1612 /// result. See the [specification of NaN bit patterns](primitive@f32#nan-bit-patterns) for more
1613 /// info.
1614 ///
1615 /// # Examples
1616 ///
1617 /// ```
1618 /// let f = 3.5_f64;
1619 ///
1620 /// assert_eq!(f.copysign(0.42), 3.5_f64);
1621 /// assert_eq!(f.copysign(-0.42), -3.5_f64);
1622 /// assert_eq!((-f).copysign(0.42), 3.5_f64);
1623 /// assert_eq!((-f).copysign(-0.42), -3.5_f64);
1624 ///
1625 /// assert!(f64::NAN.copysign(1.0).is_nan());
1626 /// ```
1627 #[must_use = "method returns a new number and does not mutate the original value"]
1628 #[stable(feature = "copysign", since = "1.35.0")]
1629 #[rustc_const_stable(feature = "const_float_methods", since = "1.85.0")]
1630 #[inline]
1631 pub const fn copysign(self, sign: f64) -> f64 {
1632 intrinsics::copysignf64(self, sign)
1633 }
1634
1635 /// Float addition that allows optimizations based on algebraic rules.
1636 ///
1637 /// See [algebraic operators](primitive@f32#algebraic-operators) for more info.
1638 #[must_use = "method returns a new number and does not mutate the original value"]
1639 #[unstable(feature = "float_algebraic", issue = "136469")]
1640 #[rustc_const_unstable(feature = "float_algebraic", issue = "136469")]
1641 #[inline]
1642 pub const fn algebraic_add(self, rhs: f64) -> f64 {
1643 intrinsics::fadd_algebraic(self, rhs)
1644 }
1645
1646 /// Float subtraction that allows optimizations based on algebraic rules.
1647 ///
1648 /// See [algebraic operators](primitive@f32#algebraic-operators) for more info.
1649 #[must_use = "method returns a new number and does not mutate the original value"]
1650 #[unstable(feature = "float_algebraic", issue = "136469")]
1651 #[rustc_const_unstable(feature = "float_algebraic", issue = "136469")]
1652 #[inline]
1653 pub const fn algebraic_sub(self, rhs: f64) -> f64 {
1654 intrinsics::fsub_algebraic(self, rhs)
1655 }
1656
1657 /// Float multiplication that allows optimizations based on algebraic rules.
1658 ///
1659 /// See [algebraic operators](primitive@f32#algebraic-operators) for more info.
1660 #[must_use = "method returns a new number and does not mutate the original value"]
1661 #[unstable(feature = "float_algebraic", issue = "136469")]
1662 #[rustc_const_unstable(feature = "float_algebraic", issue = "136469")]
1663 #[inline]
1664 pub const fn algebraic_mul(self, rhs: f64) -> f64 {
1665 intrinsics::fmul_algebraic(self, rhs)
1666 }
1667
1668 /// Float division that allows optimizations based on algebraic rules.
1669 ///
1670 /// See [algebraic operators](primitive@f32#algebraic-operators) for more info.
1671 #[must_use = "method returns a new number and does not mutate the original value"]
1672 #[unstable(feature = "float_algebraic", issue = "136469")]
1673 #[rustc_const_unstable(feature = "float_algebraic", issue = "136469")]
1674 #[inline]
1675 pub const fn algebraic_div(self, rhs: f64) -> f64 {
1676 intrinsics::fdiv_algebraic(self, rhs)
1677 }
1678
1679 /// Float remainder that allows optimizations based on algebraic rules.
1680 ///
1681 /// See [algebraic operators](primitive@f32#algebraic-operators) for more info.
1682 #[must_use = "method returns a new number and does not mutate the original value"]
1683 #[unstable(feature = "float_algebraic", issue = "136469")]
1684 #[rustc_const_unstable(feature = "float_algebraic", issue = "136469")]
1685 #[inline]
1686 pub const fn algebraic_rem(self, rhs: f64) -> f64 {
1687 intrinsics::frem_algebraic(self, rhs)
1688 }
1689}
1690
1691#[unstable(feature = "core_float_math", issue = "137578")]
1692/// Experimental implementations of floating point functions in `core`.
1693///
1694/// _The standalone functions in this module are for testing only.
1695/// They will be stabilized as inherent methods._
1696pub mod math {
1697 use crate::intrinsics;
1698 use crate::num::imp::libm;
1699
1700 /// Experimental version of `floor` in `core`. See [`f64::floor`] for details.
1701 ///
1702 /// # Examples
1703 ///
1704 /// ```
1705 /// #![feature(core_float_math)]
1706 ///
1707 /// use core::f64;
1708 ///
1709 /// let f = 3.7_f64;
1710 /// let g = 3.0_f64;
1711 /// let h = -3.7_f64;
1712 ///
1713 /// assert_eq!(f64::math::floor(f), 3.0);
1714 /// assert_eq!(f64::math::floor(g), 3.0);
1715 /// assert_eq!(f64::math::floor(h), -4.0);
1716 /// ```
1717 ///
1718 /// _This standalone function is for testing only.
1719 /// It will be stabilized as an inherent method._
1720 ///
1721 /// [`f64::floor`]: ../../../std/primitive.f64.html#method.floor
1722 #[inline]
1723 #[unstable(feature = "core_float_math", issue = "137578")]
1724 #[must_use = "method returns a new number and does not mutate the original value"]
1725 pub const fn floor(x: f64) -> f64 {
1726 intrinsics::floorf64(x)
1727 }
1728
1729 /// Experimental version of `ceil` in `core`. See [`f64::ceil`] for details.
1730 ///
1731 /// # Examples
1732 ///
1733 /// ```
1734 /// #![feature(core_float_math)]
1735 ///
1736 /// use core::f64;
1737 ///
1738 /// let f = 3.01_f64;
1739 /// let g = 4.0_f64;
1740 ///
1741 /// assert_eq!(f64::math::ceil(f), 4.0);
1742 /// assert_eq!(f64::math::ceil(g), 4.0);
1743 /// ```
1744 ///
1745 /// _This standalone function is for testing only.
1746 /// It will be stabilized as an inherent method._
1747 ///
1748 /// [`f64::ceil`]: ../../../std/primitive.f64.html#method.ceil
1749 #[inline]
1750 #[doc(alias = "ceiling")]
1751 #[unstable(feature = "core_float_math", issue = "137578")]
1752 #[must_use = "method returns a new number and does not mutate the original value"]
1753 pub const fn ceil(x: f64) -> f64 {
1754 intrinsics::ceilf64(x)
1755 }
1756
1757 /// Experimental version of `round` in `core`. See [`f64::round`] for details.
1758 ///
1759 /// # Examples
1760 ///
1761 /// ```
1762 /// #![feature(core_float_math)]
1763 ///
1764 /// use core::f64;
1765 ///
1766 /// let f = 3.3_f64;
1767 /// let g = -3.3_f64;
1768 /// let h = -3.7_f64;
1769 /// let i = 3.5_f64;
1770 /// let j = 4.5_f64;
1771 ///
1772 /// assert_eq!(f64::math::round(f), 3.0);
1773 /// assert_eq!(f64::math::round(g), -3.0);
1774 /// assert_eq!(f64::math::round(h), -4.0);
1775 /// assert_eq!(f64::math::round(i), 4.0);
1776 /// assert_eq!(f64::math::round(j), 5.0);
1777 /// ```
1778 ///
1779 /// _This standalone function is for testing only.
1780 /// It will be stabilized as an inherent method._
1781 ///
1782 /// [`f64::round`]: ../../../std/primitive.f64.html#method.round
1783 #[inline]
1784 #[unstable(feature = "core_float_math", issue = "137578")]
1785 #[must_use = "method returns a new number and does not mutate the original value"]
1786 pub const fn round(x: f64) -> f64 {
1787 intrinsics::roundf64(x)
1788 }
1789
1790 /// Experimental version of `round_ties_even` in `core`. See [`f64::round_ties_even`] for
1791 /// details.
1792 ///
1793 /// # Examples
1794 ///
1795 /// ```
1796 /// #![feature(core_float_math)]
1797 ///
1798 /// use core::f64;
1799 ///
1800 /// let f = 3.3_f64;
1801 /// let g = -3.3_f64;
1802 /// let h = 3.5_f64;
1803 /// let i = 4.5_f64;
1804 ///
1805 /// assert_eq!(f64::math::round_ties_even(f), 3.0);
1806 /// assert_eq!(f64::math::round_ties_even(g), -3.0);
1807 /// assert_eq!(f64::math::round_ties_even(h), 4.0);
1808 /// assert_eq!(f64::math::round_ties_even(i), 4.0);
1809 /// ```
1810 ///
1811 /// _This standalone function is for testing only.
1812 /// It will be stabilized as an inherent method._
1813 ///
1814 /// [`f64::round_ties_even`]: ../../../std/primitive.f64.html#method.round_ties_even
1815 #[inline]
1816 #[unstable(feature = "core_float_math", issue = "137578")]
1817 #[must_use = "method returns a new number and does not mutate the original value"]
1818 pub const fn round_ties_even(x: f64) -> f64 {
1819 intrinsics::round_ties_even_f64(x)
1820 }
1821
1822 /// Experimental version of `trunc` in `core`. See [`f64::trunc`] for details.
1823 ///
1824 /// # Examples
1825 ///
1826 /// ```
1827 /// #![feature(core_float_math)]
1828 ///
1829 /// use core::f64;
1830 ///
1831 /// let f = 3.7_f64;
1832 /// let g = 3.0_f64;
1833 /// let h = -3.7_f64;
1834 ///
1835 /// assert_eq!(f64::math::trunc(f), 3.0);
1836 /// assert_eq!(f64::math::trunc(g), 3.0);
1837 /// assert_eq!(f64::math::trunc(h), -3.0);
1838 /// ```
1839 ///
1840 /// _This standalone function is for testing only.
1841 /// It will be stabilized as an inherent method._
1842 ///
1843 /// [`f64::trunc`]: ../../../std/primitive.f64.html#method.trunc
1844 #[inline]
1845 #[doc(alias = "truncate")]
1846 #[unstable(feature = "core_float_math", issue = "137578")]
1847 #[must_use = "method returns a new number and does not mutate the original value"]
1848 pub const fn trunc(x: f64) -> f64 {
1849 intrinsics::truncf64(x)
1850 }
1851
1852 /// Experimental version of `fract` in `core`. See [`f64::fract`] for details.
1853 ///
1854 /// # Examples
1855 ///
1856 /// ```
1857 /// #![feature(core_float_math)]
1858 ///
1859 /// use core::f64;
1860 ///
1861 /// let x = 3.6_f64;
1862 /// let y = -3.6_f64;
1863 /// let abs_difference_x = (f64::math::fract(x) - 0.6).abs();
1864 /// let abs_difference_y = (f64::math::fract(y) - (-0.6)).abs();
1865 ///
1866 /// assert!(abs_difference_x < 1e-10);
1867 /// assert!(abs_difference_y < 1e-10);
1868 /// ```
1869 ///
1870 /// _This standalone function is for testing only.
1871 /// It will be stabilized as an inherent method._
1872 ///
1873 /// [`f64::fract`]: ../../../std/primitive.f64.html#method.fract
1874 #[inline]
1875 #[unstable(feature = "core_float_math", issue = "137578")]
1876 #[must_use = "method returns a new number and does not mutate the original value"]
1877 pub const fn fract(x: f64) -> f64 {
1878 x - trunc(x)
1879 }
1880
1881 /// Experimental version of `mul_add` in `core`. See [`f64::mul_add`] for details.
1882 ///
1883 /// # Examples
1884 ///
1885 /// ```
1886 /// # #![allow(unused_features)]
1887 /// #![feature(core_float_math)]
1888 ///
1889 /// # // FIXME(#140515): mingw has an incorrect fma
1890 /// # // https://sourceforge.net/p/mingw-w64/bugs/848/
1891 /// # #[cfg(all(target_os = "windows", target_env = "gnu", not(target_abi = "llvm")))] {
1892 /// use core::f64;
1893 ///
1894 /// let m = 10.0_f64;
1895 /// let x = 4.0_f64;
1896 /// let b = 60.0_f64;
1897 ///
1898 /// assert_eq!(f64::math::mul_add(m, x, b), 100.0);
1899 /// assert_eq!(m * x + b, 100.0);
1900 ///
1901 /// let one_plus_eps = 1.0_f64 + f64::EPSILON;
1902 /// let one_minus_eps = 1.0_f64 - f64::EPSILON;
1903 /// let minus_one = -1.0_f64;
1904 ///
1905 /// // The exact result (1 + eps) * (1 - eps) = 1 - eps * eps.
1906 /// assert_eq!(
1907 /// f64::math::mul_add(one_plus_eps, one_minus_eps, minus_one),
1908 /// -f64::EPSILON * f64::EPSILON
1909 /// );
1910 /// // Different rounding with the non-fused multiply and add.
1911 /// assert_eq!(one_plus_eps * one_minus_eps + minus_one, 0.0);
1912 /// # }
1913 /// ```
1914 ///
1915 /// _This standalone function is for testing only.
1916 /// It will be stabilized as an inherent method._
1917 ///
1918 /// [`f64::mul_add`]: ../../../std/primitive.f64.html#method.mul_add
1919 #[inline]
1920 #[doc(alias = "fma", alias = "fusedMultiplyAdd")]
1921 #[unstable(feature = "core_float_math", issue = "137578")]
1922 #[must_use = "method returns a new number and does not mutate the original value"]
1923 pub const fn mul_add(x: f64, a: f64, b: f64) -> f64 {
1924 intrinsics::fmaf64(x, a, b)
1925 }
1926
1927 /// Experimental version of `div_euclid` in `core`. See [`f64::div_euclid`] for details.
1928 ///
1929 /// # Examples
1930 ///
1931 /// ```
1932 /// #![feature(core_float_math)]
1933 ///
1934 /// use core::f64;
1935 ///
1936 /// let a: f64 = 7.0;
1937 /// let b = 4.0;
1938 /// assert_eq!(f64::math::div_euclid(a, b), 1.0); // 7.0 > 4.0 * 1.0
1939 /// assert_eq!(f64::math::div_euclid(-a, b), -2.0); // -7.0 >= 4.0 * -2.0
1940 /// assert_eq!(f64::math::div_euclid(a, -b), -1.0); // 7.0 >= -4.0 * -1.0
1941 /// assert_eq!(f64::math::div_euclid(-a, -b), 2.0); // -7.0 >= -4.0 * 2.0
1942 /// ```
1943 ///
1944 /// _This standalone function is for testing only.
1945 /// It will be stabilized as an inherent method._
1946 ///
1947 /// [`f64::div_euclid`]: ../../../std/primitive.f64.html#method.div_euclid
1948 #[inline]
1949 #[unstable(feature = "core_float_math", issue = "137578")]
1950 #[must_use = "method returns a new number and does not mutate the original value"]
1951 pub fn div_euclid(x: f64, rhs: f64) -> f64 {
1952 let q = trunc(x / rhs);
1953 if x % rhs < 0.0 {
1954 return if rhs > 0.0 { q - 1.0 } else { q + 1.0 };
1955 }
1956 q
1957 }
1958
1959 /// Experimental version of `rem_euclid` in `core`. See [`f64::rem_euclid`] for details.
1960 ///
1961 /// # Examples
1962 ///
1963 /// ```
1964 /// #![feature(core_float_math)]
1965 ///
1966 /// use core::f64;
1967 ///
1968 /// let a: f64 = 7.0;
1969 /// let b = 4.0;
1970 /// assert_eq!(f64::math::rem_euclid(a, b), 3.0);
1971 /// assert_eq!(f64::math::rem_euclid(-a, b), 1.0);
1972 /// assert_eq!(f64::math::rem_euclid(a, -b), 3.0);
1973 /// assert_eq!(f64::math::rem_euclid(-a, -b), 1.0);
1974 /// // limitation due to round-off error
1975 /// assert!(f64::math::rem_euclid(-f64::EPSILON, 3.0) != 0.0);
1976 /// ```
1977 ///
1978 /// _This standalone function is for testing only.
1979 /// It will be stabilized as an inherent method._
1980 ///
1981 /// [`f64::rem_euclid`]: ../../../std/primitive.f64.html#method.rem_euclid
1982 #[inline]
1983 #[doc(alias = "modulo", alias = "mod")]
1984 #[unstable(feature = "core_float_math", issue = "137578")]
1985 #[must_use = "method returns a new number and does not mutate the original value"]
1986 pub fn rem_euclid(x: f64, rhs: f64) -> f64 {
1987 let r = x % rhs;
1988 if r < 0.0 { r + rhs.abs() } else { r }
1989 }
1990
1991 /// Experimental version of `powi` in `core`. See [`f64::powi`] for details.
1992 ///
1993 /// # Examples
1994 ///
1995 /// ```
1996 /// #![feature(core_float_math)]
1997 ///
1998 /// use core::f64;
1999 ///
2000 /// let x = 2.0_f64;
2001 /// let abs_difference = (f64::math::powi(x, 2) - (x * x)).abs();
2002 /// assert!(abs_difference <= 1e-6);
2003 ///
2004 /// assert_eq!(f64::math::powi(f64::NAN, 0), 1.0);
2005 /// ```
2006 ///
2007 /// _This standalone function is for testing only.
2008 /// It will be stabilized as an inherent method._
2009 ///
2010 /// [`f64::powi`]: ../../../std/primitive.f64.html#method.powi
2011 #[inline]
2012 #[unstable(feature = "core_float_math", issue = "137578")]
2013 #[must_use = "method returns a new number and does not mutate the original value"]
2014 pub fn powi(x: f64, n: i32) -> f64 {
2015 intrinsics::powif64(x, n)
2016 }
2017
2018 /// Experimental version of `sqrt` in `core`. See [`f64::sqrt`] for details.
2019 ///
2020 /// # Examples
2021 ///
2022 /// ```
2023 /// #![feature(core_float_math)]
2024 ///
2025 /// use core::f64;
2026 ///
2027 /// let positive = 4.0_f64;
2028 /// let negative = -4.0_f64;
2029 /// let negative_zero = -0.0_f64;
2030 ///
2031 /// assert_eq!(f64::math::sqrt(positive), 2.0);
2032 /// assert!(f64::math::sqrt(negative).is_nan());
2033 /// assert_eq!(f64::math::sqrt(negative_zero), negative_zero);
2034 /// ```
2035 ///
2036 /// _This standalone function is for testing only.
2037 /// It will be stabilized as an inherent method._
2038 ///
2039 /// [`f64::sqrt`]: ../../../std/primitive.f64.html#method.sqrt
2040 #[inline]
2041 #[doc(alias = "squareRoot")]
2042 #[unstable(feature = "core_float_math", issue = "137578")]
2043 #[must_use = "method returns a new number and does not mutate the original value"]
2044 pub fn sqrt(x: f64) -> f64 {
2045 intrinsics::sqrtf64(x)
2046 }
2047
2048 /// Experimental version of `abs_sub` in `core`. See [`f64::abs_sub`] for details.
2049 ///
2050 /// # Examples
2051 ///
2052 /// ```
2053 /// #![feature(core_float_math)]
2054 ///
2055 /// use core::f64;
2056 ///
2057 /// let x = 3.0_f64;
2058 /// let y = -3.0_f64;
2059 ///
2060 /// let abs_difference_x = (f64::math::abs_sub(x, 1.0) - 2.0).abs();
2061 /// let abs_difference_y = (f64::math::abs_sub(y, 1.0) - 0.0).abs();
2062 ///
2063 /// assert!(abs_difference_x < 1e-10);
2064 /// assert!(abs_difference_y < 1e-10);
2065 /// ```
2066 ///
2067 /// _This standalone function is for testing only.
2068 /// It will be stabilized as an inherent method._
2069 ///
2070 /// [`f64::abs_sub`]: ../../../std/primitive.f64.html#method.abs_sub
2071 #[inline]
2072 #[unstable(feature = "core_float_math", issue = "137578")]
2073 #[deprecated(
2074 since = "1.10.0",
2075 note = "you probably meant `(self - other).abs()`: \
2076 this operation is `(self - other).max(0.0)` \
2077 except that `abs_sub` also propagates NaNs (also \
2078 known as `fdim` in C). If you truly need the positive \
2079 difference, consider using that expression or the C function \
2080 `fdim`, depending on how you wish to handle NaN (please consider \
2081 filing an issue describing your use-case too)."
2082 )]
2083 #[must_use = "method returns a new number and does not mutate the original value"]
2084 pub fn abs_sub(x: f64, other: f64) -> f64 {
2085 libm::fdim(x, other)
2086 }
2087
2088 /// Experimental version of `cbrt` in `core`. See [`f64::cbrt`] for details.
2089 ///
2090 /// # Examples
2091 ///
2092 /// ```
2093 /// #![feature(core_float_math)]
2094 ///
2095 /// use core::f64;
2096 ///
2097 /// let x = 8.0_f64;
2098 ///
2099 /// // x^(1/3) - 2 == 0
2100 /// let abs_difference = (f64::math::cbrt(x) - 2.0).abs();
2101 ///
2102 /// assert!(abs_difference < 1e-10);
2103 /// ```
2104 ///
2105 /// _This standalone function is for testing only.
2106 /// It will be stabilized as an inherent method._
2107 ///
2108 /// [`f64::cbrt`]: ../../../std/primitive.f64.html#method.cbrt
2109 #[inline]
2110 #[unstable(feature = "core_float_math", issue = "137578")]
2111 #[must_use = "method returns a new number and does not mutate the original value"]
2112 pub fn cbrt(x: f64) -> f64 {
2113 libm::cbrt(x)
2114 }
2115}