Struct OrderedF32 

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

A wrapper around f32 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 OrderedF32

pub fn value(&self) -> f32

pub fn zero() -> OrderedF32

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2

pub const BITS: u32 = 32

pub const MANTISSA_DIGITS: u32 = 24

pub const DIGITS: u32 = 6

pub const EPSILON: f32 = 1.19209290e-07_f32

pub const MIN: f32 = -3.40282347e+38_f32

pub const MIN_POSITIVE: f32 = 1.17549435e-38_f32

pub const MAX: f32 = 3.40282347e+38_f32

pub const MIN_EXP: i32 = -125

pub const MAX_EXP: i32 = 128

pub const MIN_10_EXP: i32 = -37

pub const MAX_10_EXP: i32 = 38

pub const NAN: f32

pub const INFINITY: f32

pub const NEG_INFINITY: f32

pub const MAX_EXACT_INTEGER: i32

pub const MIN_EXACT_INTEGER: i32

pub fn total_cmp(&self, other: &f32) -> 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 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

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

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: f32::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f32::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

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

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

Trait Implementations

impl Clone for OrderedF32

fn clone(&self) -> OrderedF32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderedF32

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

Formats the value using the given formatter.

impl Default for OrderedF32

fn default() -> OrderedF32

Returns the “default value” for a type.

impl Deref for OrderedF32

type Target = f32

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for OrderedF32

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderedF32

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

Formats the value using the given formatter.

impl From<OrderedF32> for f32

fn from(v: OrderedF32) -> f32

Converts to this type from the input type.

impl Hash for OrderedF32

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 OrderedF32

fn into_value(self) -> Value

impl Ord for OrderedF32

fn cmp(&self, other: &OrderedF32) -> 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 OrderedF32

fn eq(&self, other: &OrderedF32) -> 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 OrderedF32

fn partial_cmp(&self, other: &OrderedF32) -> 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 OrderedF32

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<f32> for OrderedF32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(f: f32) -> Result<OrderedF32, <OrderedF32 as TryFrom<f32>>::Error>

Performs the conversion.

impl TryFromValue for OrderedF32

fn try_from_value(value: &Value) -> Result<OrderedF32, 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 OrderedF32

impl Eq for OrderedF32