Struct ZeroToOne

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

An f32 that is clamped between 0.0 and 1.0 and cannot be NaN or Infinity.

Because of these restrictions, this type implements Ord and Eq.

Implementations

impl ZeroToOne

pub const ONE: Self = _

The maximum value this type can contain.

pub fn new(value: f32) -> Self

Returns a new instance after clamping value between +0.0 and 1.0.

Panics

This function panics if value is not a number.

pub fn difference_between(self, other: Self) -> Self

Returns the difference between self and other as a positive number.

pub fn into_f32(self) -> f32

Returns the contained floating point value.

pub fn one_minus(self) -> Self

Returns the result of 1.0 - self.

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 Clone for ZeroToOne

fn clone(&self) -> ZeroToOne

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZeroToOne

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

Formats the value using the given formatter.

impl Default for ZeroToOne

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ZeroToOne

type Target = f32

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for ZeroToOne

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ZeroToOne

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

Formats the value using the given formatter.

impl Div<f32> for ZeroToOne

fn div(self, rhs: f32) -> Self::Output

Divides self by rhs.

If rhs is 0., the result will be ZeroToOne::ONE.

Panics

This function panics if rhs is not a number.

type Output = ZeroToOne

The resulting type after applying the / operator.

impl Div for ZeroToOne

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

Divides self by rhs.

If rhs is 0., the result will be ZeroToOne::ONE.

type Output = ZeroToOne

The resulting type after applying the / operator.

impl DivAssign<f32> for ZeroToOne

fn div_assign(&mut self, rhs: f32)

Divides self by rhs.

If rhs is 0., the result will be ZeroToOne::ONE.

Panics

This function panics if rhs is not a number.

impl DivAssign for ZeroToOne

fn div_assign(&mut self, rhs: Self)

Divides self by rhs.

If rhs is 0., the result will be ZeroToOne::ONE.

impl From<ZeroToOne> for Component

fn from(value: ZeroToOne) -> Self

Converts to this type from the input type.

impl From<ZeroToOne> for f32

fn from(value: ZeroToOne) -> Self

Converts to this type from the input type.

impl From<f32> for ZeroToOne

fn from(value: f32) -> Self

Returns a ZeroToOne clamped between 0.0 and 1.0.

Panics

This function panics if value is not a number.

impl From<f64> for ZeroToOne

fn from(value: f64) -> Self

Returns a ZeroToOne clamped between 0.0 and 1.0.

Panics

This function panics if value is not a number.

impl FromStr for ZeroToOne

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Lightness for ZeroToOne

fn into_lightness(self) -> ZeroToOne

Returns this value as a floating point clamped between 0 and 1.

impl LinearInterpolate for ZeroToOne

fn lerp(&self, target: &Self, percent: f32) -> Self

Interpolate linearly between self and target using percent.

impl Mul for ZeroToOne

type Output = ZeroToOne

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for ZeroToOne

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Ord for ZeroToOne

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 PartialEq<f32> for ZeroToOne

fn eq(&self, other: &f32) -> 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 PartialEq for ZeroToOne

fn eq(&self, other: &Self) -> 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<f32> for ZeroToOne

fn partial_cmp(&self, other: &f32) -> 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 PartialOrd for ZeroToOne

fn partial_cmp(&self, other: &Self) -> 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 PercentBetween for ZeroToOne

fn percent_between(&self, min: &Self, max: &Self) -> ZeroToOne

Return the percentage that self is between min and max.

impl Ranged for ZeroToOne

const MAX: Self = Self::ONE

The maximum value for this type.

const MIN: Self = Self::ZERO

The minimum value for this type.

impl RequireInvalidation for ZeroToOne

fn requires_invalidation(&self) -> bool

Cushy tracks two different states:

impl Serialize for ZeroToOne

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Component> for ZeroToOne

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl Zero for ZeroToOne

const ZERO: Self = _

The zero value for this type.

fn is_zero(&self) -> bool

Returns true if self represents 0.

impl Copy for ZeroToOne

impl Eq for ZeroToOne