diff options
| author | bors <bors@rust-lang.org> | 2022-05-09 17:23:34 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2022-05-09 17:23:34 +0000 |
| commit | 0dd7e10282aaa7a3e1f5660f8bb043ee4ea07355 (patch) | |
| tree | 1fd25c23e04b5fd4a72d40f9113a726e1e12d88e /library/std/src/f64.rs | |
| parent | 0e345b76a5550d82caff5540649ee0ba6e3b4f3f (diff) | |
| parent | 59722228b981f86d5540a43d9eb2cd2c66da92e9 (diff) | |
| download | rust-0dd7e10282aaa7a3e1f5660f8bb043ee4ea07355.tar.gz rust-0dd7e10282aaa7a3e1f5660f8bb043ee4ea07355.zip | |
Auto merge of #96877 - matthiaskrgr:rollup-evlh6ot, r=matthiaskrgr
Rollup of 6 pull requests Successful merges: - #95483 (Improve floating point documentation) - #96008 (Warn on unused `#[doc(hidden)]` attributes on trait impl items) - #96841 (Revert "Implement [OsStr]::join", which was merged without FCP.) - #96844 (Actually fix ICE from #96583) - #96854 (Some subst cleanup) - #96858 (Remove unused param from search.js::checkPath) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Diffstat (limited to 'library/std/src/f64.rs')
| -rw-r--r-- | library/std/src/f64.rs | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/library/std/src/f64.rs b/library/std/src/f64.rs index 6f322aea6aa..a9aa84f70d1 100644 --- a/library/std/src/f64.rs +++ b/library/std/src/f64.rs @@ -29,7 +29,7 @@ pub use core::f64::{ #[cfg(not(test))] impl f64 { - /// Returns the largest integer less than or equal to a number. + /// Returns the largest integer less than or equal to `self`. /// /// # Examples /// @@ -50,7 +50,7 @@ impl f64 { unsafe { intrinsics::floorf64(self) } } - /// Returns the smallest integer greater than or equal to a number. + /// Returns the smallest integer greater than or equal to `self`. /// /// # Examples /// @@ -69,7 +69,7 @@ impl f64 { unsafe { intrinsics::ceilf64(self) } } - /// Returns the nearest integer to a number. Round half-way cases away from + /// Returns the nearest integer to `self`. Round half-way cases away from /// `0.0`. /// /// # Examples @@ -89,7 +89,8 @@ impl f64 { unsafe { intrinsics::roundf64(self) } } - /// Returns the integer part of a number. + /// Returns the integer part of `self`. + /// This means that non-integer numbers are always truncated towards zero. /// /// # Examples /// @@ -110,7 +111,7 @@ impl f64 { unsafe { intrinsics::truncf64(self) } } - /// Returns the fractional part of a number. + /// Returns the fractional part of `self`. /// /// # Examples /// @@ -131,8 +132,7 @@ impl f64 { self - self.trunc() } - /// Computes the absolute value of `self`. Returns `NAN` if the - /// number is `NAN`. + /// Computes the absolute value of `self`. /// /// # Examples /// @@ -160,7 +160,7 @@ impl f64 { /// /// - `1.0` if the number is positive, `+0.0` or `INFINITY` /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY` - /// - `NAN` if the number is `NAN` + /// - NaN if the number is NaN /// /// # Examples /// @@ -184,8 +184,10 @@ impl f64 { /// `sign`. /// /// Equal to `self` if the sign of `self` and `sign` are the same, otherwise - /// equal to `-self`. If `self` is a `NAN`, then a `NAN` with the sign of - /// `sign` is returned. + /// equal to `-self`. If `self` is a NaN, then a NaN with the sign bit of + /// `sign` is returned. Note, however, that conserving the sign bit on NaN + /// across arithmetical operations is not generally guaranteed. + /// See [explanation of NaN as a special value](primitive@f32) for more info. /// /// # Examples /// @@ -298,7 +300,9 @@ impl f64 { /// Raises a number to an integer power. /// - /// Using this function is generally faster than using `powf` + /// Using this function is generally faster than using `powf`. + /// It might have a different sequence of rounding operations than `powf`, + /// so the results are not guaranteed to agree. /// /// # Examples /// |
