mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-23 23:34:48 +00:00
review the total_cmp documentation
The documentation has been restructured to split out a brief summary paragraph out from the following elaborating paragraphs. I also attempted my hand at wording improvements and adding articles where I felt them missing, but being non-native english speaker these may need more thorough review.
This commit is contained in:
parent
8c7f2bf44f
commit
78efb075d9
@ -1008,29 +1008,37 @@ impl f32 {
|
||||
Self::from_bits(u32::from_ne_bytes(bytes))
|
||||
}
|
||||
|
||||
/// Returns an ordering between self and other values.
|
||||
/// Return the ordering between `self` and `other`.
|
||||
///
|
||||
/// Unlike the standard partial comparison between floating point numbers,
|
||||
/// this comparison always produces an ordering in accordance to
|
||||
/// the totalOrder predicate as defined in IEEE 754 (2008 revision)
|
||||
/// floating point standard. The values are ordered in following order:
|
||||
/// - Negative quiet NaN
|
||||
/// - Negative signaling NaN
|
||||
/// - Negative infinity
|
||||
/// - Negative numbers
|
||||
/// - Negative subnormal numbers
|
||||
/// - Negative zero
|
||||
/// - Positive zero
|
||||
/// - Positive subnormal numbers
|
||||
/// - Positive numbers
|
||||
/// - Positive infinity
|
||||
/// - Positive signaling NaN
|
||||
/// - Positive quiet NaN
|
||||
/// the `totalOrder` predicate as defined in the IEEE 754 (2008 revision)
|
||||
/// floating point standard. The values are ordered in the following sequence:
|
||||
///
|
||||
/// Note that this function does not always agree with the [`PartialOrd`]
|
||||
/// and [`PartialEq`] implementations of `f32`. In particular, they regard
|
||||
/// negative and positive zero as equal, while `total_cmp` doesn't.
|
||||
/// - negative quiet NaN
|
||||
/// - negative signaling NaN
|
||||
/// - negative infinity
|
||||
/// - negative numbers
|
||||
/// - negative subnormal numbers
|
||||
/// - negative zero
|
||||
/// - positive zero
|
||||
/// - positive subnormal numbers
|
||||
/// - positive numbers
|
||||
/// - positive infinity
|
||||
/// - positive signaling NaN
|
||||
/// - positive quiet NaN.
|
||||
///
|
||||
/// The ordering established by this function does not always agree with the
|
||||
/// [`PartialOrd`] and [`PartialEq`] implementations of `f32`. For example,
|
||||
/// they consider negative and positive zero equal, while `total_cmp`
|
||||
/// doesn't.
|
||||
///
|
||||
/// The interpretation of the signaling NaN bit follows the definition in
|
||||
/// the IEEE 754 standard, which may not match the interpretation by some of
|
||||
/// the older, non-conformant (e.g. MIPS) hardware implementations.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(total_cmp)]
|
||||
/// struct GoodBoy {
|
||||
|
@ -1024,29 +1024,37 @@ impl f64 {
|
||||
Self::from_bits(u64::from_ne_bytes(bytes))
|
||||
}
|
||||
|
||||
/// Returns an ordering between self and other values.
|
||||
/// Return the ordering between `self` and `other`.
|
||||
///
|
||||
/// Unlike the standard partial comparison between floating point numbers,
|
||||
/// this comparison always produces an ordering in accordance to
|
||||
/// the totalOrder predicate as defined in IEEE 754 (2008 revision)
|
||||
/// floating point standard. The values are ordered in following order:
|
||||
/// - Negative quiet NaN
|
||||
/// - Negative signaling NaN
|
||||
/// - Negative infinity
|
||||
/// - Negative numbers
|
||||
/// - Negative subnormal numbers
|
||||
/// - Negative zero
|
||||
/// - Positive zero
|
||||
/// - Positive subnormal numbers
|
||||
/// - Positive numbers
|
||||
/// - Positive infinity
|
||||
/// - Positive signaling NaN
|
||||
/// - Positive quiet NaN
|
||||
/// the `totalOrder` predicate as defined in the IEEE 754 (2008 revision)
|
||||
/// floating point standard. The values are ordered in the following sequence:
|
||||
///
|
||||
/// Note that this function does not always agree with the [`PartialOrd`]
|
||||
/// and [`PartialEq`] implementations of `f64`. In particular, they regard
|
||||
/// negative and positive zero as equal, while `total_cmp` doesn't.
|
||||
/// - negative quiet NaN
|
||||
/// - negative signaling NaN
|
||||
/// - negative infinity
|
||||
/// - negative numbers
|
||||
/// - negative subnormal numbers
|
||||
/// - negative zero
|
||||
/// - positive zero
|
||||
/// - positive subnormal numbers
|
||||
/// - positive numbers
|
||||
/// - positive infinity
|
||||
/// - positive signaling NaN
|
||||
/// - positive quiet NaN.
|
||||
///
|
||||
/// The ordering established by this function does not always agree with the
|
||||
/// [`PartialOrd`] and [`PartialEq`] implementations of `f64`. For example,
|
||||
/// they consider negative and positive zero equal, while `total_cmp`
|
||||
/// doesn't.
|
||||
///
|
||||
/// The interpretation of the signaling NaN bit follows the definition in
|
||||
/// the IEEE 754 standard, which may not match the interpretation by some of
|
||||
/// the older, non-conformant (e.g. MIPS) hardware implementations.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(total_cmp)]
|
||||
/// struct GoodBoy {
|
||||
|
Loading…
Reference in New Issue
Block a user