Struct OrderedF64 

pub struct OrderedF64(/* private fields */);

A wrapper around f64 that provides total ordering by rejecting NaN values. This type is sortable and can be used in collections that require Ord, such as BTreeMap and BTreeSet. It prevents NaN values from being stored, ensuring that all values are comparable and can be sorted consistently.

Implementations

impl OrderedF64

pub fn value(&self) -> f64

pub fn zero() -> OrderedF64

Methods from Deref<Target = f64>

pub const RADIX: u32 = 2

pub const BITS: u32 = 64

pub const MANTISSA_DIGITS: u32 = 53

pub const DIGITS: u32 = 15

pub const EPSILON: f64 = 2.2204460492503131e-16_f64

pub const MIN: f64 = -1.7976931348623157e+308_f64

pub const MIN_POSITIVE: f64 = 2.2250738585072014e-308_f64

pub const MAX: f64 = 1.7976931348623157e+308_f64

pub const MIN_EXP: i32 = -1021

pub const MAX_EXP: i32 = 1024

pub const MIN_10_EXP: i32 = -307

pub const MAX_10_EXP: i32 = 308

pub const NAN: f64

pub const INFINITY: f64

pub const NEG_INFINITY: f64

pub const MAX_EXACT_INTEGER: i64

pub const MIN_EXACT_INTEGER: i64

pub fn total_cmp(&self, other: &f64) -> Ordering

Returns 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 the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• 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

struct GoodBoy {
    name: String,
    weight: f64,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f64::NAN` could be positive or negative, which will affect the sort order.
if f64::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

impl Clone for OrderedF64

fn clone(&self) -> OrderedF64

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OrderedF64

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for OrderedF64

fn default() -> OrderedF64

Returns the “default value” for a type.

impl Deref for OrderedF64

type Target = f64

The resulting type after dereferencing.

fn deref(&self) -> &<OrderedF64 as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for OrderedF64

fn deserialize<D>( deserializer: D, ) -> Result<OrderedF64, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderedF64

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<OrderedF64> for f64

fn from(v: OrderedF64) -> f64

Converts to this type from the input type.

impl Hash for OrderedF64

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for OrderedF64

fn into_value(self) -> Value

impl Ord for OrderedF64

fn cmp(&self, other: &OrderedF64) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OrderedF64

fn eq(&self, other: &OrderedF64) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for OrderedF64

fn partial_cmp(&self, other: &OrderedF64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OrderedF64

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<f64> for OrderedF64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(f: f64) -> Result<OrderedF64, <OrderedF64 as TryFrom<f64>>::Error>

Performs the conversion.

impl TryFromValue for OrderedF64

fn try_from_value(value: &Value) -> Result<OrderedF64, FromValueError>

Attempt to extract a value of this type from a Value.

fn from_value(value: &Value) -> Option<Self>

Extract from Value, returning None for Undefined or type mismatch.

impl Copy for OrderedF64

impl Eq for OrderedF64