Struct solstice::ClampedF32

pub struct ClampedF32(_);

An non-NAN f32 value clamped between 0.0 and 1.0, inclusive. This type can be constructed with an f32 which will be clamped into the appropriate range.

Methods from Deref<Target = f32>

pub const RADIX: u32

pub const MANTISSA_DIGITS: u32

pub const DIGITS: u32

pub const EPSILON: f32

pub const MIN: f32

pub const MIN_POSITIVE: f32

pub const MAX: f32

pub const MIN_EXP: i32

pub const MAX_EXP: i32

pub const MIN_10_EXP: i32

pub const MAX_10_EXP: i32

pub const NAN: f32

pub const INFINITY: f32

pub const NEG_INFINITY: f32

pub fn as_ne_bytes(&self) -> &[u8; 4]

🔬 This is a nightly-only experimental API. (num_as_ne_bytes)

Return the memory representation of this floating point number as a byte array in native byte order.

to_ne_bytes should be preferred over this whenever possible.

Examples

#![feature(num_as_ne_bytes)]
let num = 12.5f32;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x41, 0x48, 0x00, 0x00]
    } else {
        &[0x00, 0x00, 0x48, 0x41]
    }
);

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

🔬 This is a nightly-only experimental API. (total_cmp)

Returns an ordering between self and other values. 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

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.

Example

#![feature(total_cmp)]
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));

Trait Implementations

impl Clone for ClampedF32

fn clone(&self) -> ClampedF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ClampedF32

impl Debug for ClampedF32

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

Formats the value using the given formatter.

impl Default for ClampedF32

fn default() -> ClampedF32

Returns the “default value” for a type.

impl Deref for ClampedF32

type Target = f32

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for ClampedF32

impl From<f32> for ClampedF32

fn from(v: f32) -> Self

Performs the conversion.

impl Ord for ClampedF32

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ClampedF32> for ClampedF32

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ClampedF32> for ClampedF32

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralPartialEq for ClampedF32