Struct BoundedFloat

pub struct BoundedFloat<const LOW: i16, const HIGH: i16> { /* private fields */ }

Implementations

impl<const LOW: i16, const HIGH: i16> BoundedFloat<LOW, HIGH>

pub const MIN: BoundedFloat<LOW, HIGH>

pub const MAX: BoundedFloat<LOW, HIGH>

pub fn new(val: f32) -> Option<Self>

Creates a bounded float value, if the given val is within the range given

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 24u32

pub const DIGITS: u32 = 6u32

pub const EPSILON: f32 = 1.1920929E-7f32

pub const MIN: f32 = -3.40282347E+38f32

pub const MIN_POSITIVE: f32 = 1.17549435E-38f32

pub const MAX: f32 = 3.40282347E+38f32

pub const MIN_EXP: i32 = -125i32

pub const MAX_EXP: i32 = 128i32

pub const MIN_10_EXP: i32 = -37i32

pub const MAX_10_EXP: i32 = 38i32

pub const NAN: f32 = NaN_f32

pub const INFINITY: f32 = +Inf_f32

pub const NEG_INFINITY: f32 = -Inf_f32

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<const LOW: i16, const HIGH: i16> Add for BoundedFloat<LOW, HIGH>

type Output = f32

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<const LOW: i16, const HIGH: i16> Clone for BoundedFloat<LOW, HIGH>

fn clone(&self) -> BoundedFloat<LOW, HIGH>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LOW: i16, const HIGH: i16> Debug for BoundedFloat<LOW, HIGH>

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

Formats the value using the given formatter.

impl<const LOW: i16, const HIGH: i16> Deref for BoundedFloat<LOW, HIGH>

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, const LOW: i16, const HIGH: i16> Deserialize<'de> for BoundedFloat<LOW, HIGH>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const LOW: i16, const HIGH: i16> Display for BoundedFloat<LOW, HIGH>

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

Formats the value using the given formatter.

impl<const LOW: i16, const HIGH: i16> Hash for BoundedFloat<LOW, HIGH>

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

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<const LOW: i16, const HIGH: i16> Ord for BoundedFloat<LOW, HIGH>

fn cmp(&self, other: &Self) -> 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<const LOW: i16, const HIGH: i16> PartialEq for BoundedFloat<LOW, HIGH>

fn eq(&self, other: &BoundedFloat<LOW, HIGH>) -> 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<const LOW: i16, const HIGH: i16> PartialOrd for BoundedFloat<LOW, HIGH>

fn partial_cmp(&self, other: &BoundedFloat<LOW, HIGH>) -> 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<const LOW: i16, const HIGH: i16> Serialize for BoundedFloat<LOW, HIGH>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const LOW: i16, const HIGH: i16> Sub for BoundedFloat<LOW, HIGH>

type Output = f32

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<const LOW: i16, const HIGH: i16> Copy for BoundedFloat<LOW, HIGH>

impl<const LOW: i16, const HIGH: i16> Eq for BoundedFloat<LOW, HIGH>

impl<const LOW: i16, const HIGH: i16> StructuralPartialEq for BoundedFloat<LOW, HIGH>