Struct ClampedF64

source

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

Expand description

An f64 point value clamped between 0.0 and 1.0.

This upholds the invariant that the value is always clamped at construction time so that the caller is not required to make this check.

This is a drop-in replacement for cases where GLclampd is used.

Implementations§

source §

impl ClampedF64

source

pub const MIN: Self = _

The minimum value of a Clamped floating point value.

source

pub const MAX: Self = _

The maximum value of a Clamped floating point value.

source

pub fn clamp(value: f64) -> Self

Create a new Clamped floating point value.

The value will be clamped between 0.0 and 1.0.

§Parameters

value - The value to clamp.

source

pub fn new(value: f64) -> Result<Self, ClampedError>

Create a new Clamped floating point value if the value is clamped between 0.0 and 1.0.

If the value is not clamped between 0.0 and 1.0, a ClampedError is returned.

§Parameters

value - The value to clamp.

source

pub const unsafe fn new_unchecked(value: f64) -> Self

Create a new Clamped instance without clamping the value.

Consider using the safe equivalent Self::new, or the automatic clamping Self::clamp instead.

§Safety

The user is required to ensure that the value is clamped between 0.0 and 1.0, otherwise the behavior is undefined.

§Parameters

value - The value to clamp.

source §

impl ClampedF64

source

pub fn get(self) -> f64

Get the value as a floating point number.

source §

impl ClampedF64

source

pub fn saturating_add(self, rhs: Self) -> Self

Add two Clamped floating point values, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_sub(self, rhs: Self) -> Self

Subtract two Clamped floating point values, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_mul(self, rhs: Self) -> Self

Multiply two Clamped floating point values, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_div(self, rhs: Self) -> Self

Divide two Clamped floating point values, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_rem(self, rhs: Self) -> Self

Modulo two Clamped floating point values, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_add_assign(&mut self, rhs: Self)

Add a Clamped floating point value to the current value, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_sub_assign(&mut self, rhs: Self)

Subtract a Clamped floating point value from the current value, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_mul_assign(&mut self, rhs: Self)

Multiply a Clamped floating point value with the current value, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_div_assign(&mut self, rhs: Self)

Divide a Clamped floating point value with the current value, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

source

pub fn saturating_rem_assign(&mut self, rhs: Self)

Modulo a Clamped floating point value with the current value, clamping the result between 0.0 and 1.0.

§Parameters

rhs - The right-hand side value.

Methods from Deref<Target = f64>§

1.43.0 · source

pub const RADIX: u32 = 2u32

1.43.0 · source

pub const MANTISSA_DIGITS: u32 = 53u32

1.43.0 · source

pub const DIGITS: u32 = 15u32

1.43.0 · source

pub const EPSILON: f64 = 2.2204460492503131E-16f64

1.43.0 · source

pub const MIN: f64 = -1.7976931348623157E+308f64

1.43.0 · source

pub const MIN_POSITIVE: f64 = 2.2250738585072014E-308f64

1.43.0 · source

pub const MAX: f64 = 1.7976931348623157E+308f64

1.43.0 · source

pub const MIN_EXP: i32 = -1_021i32

1.43.0 · source

pub const MAX_EXP: i32 = 1_024i32

1.43.0 · source

pub const MIN_10_EXP: i32 = -307i32

1.43.0 · source

pub const MAX_10_EXP: i32 = 308i32

1.43.0 · source

pub const NAN: f64 = NaN_f64

1.43.0 · source

pub const INFINITY: f64 = +Inf_f64

1.43.0 · source

pub const NEG_INFINITY: f64 = -Inf_f64

1.62.0 · source

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()))
}