Struct ZeroOne 

pub struct ZeroOne<T>(/* private fields */);

A floating-point number which is within the range +0 to +1 (inclusive).

This may be used for alpha blending, reflectance, lerps, and anything else where values outside the range 0 to 1 is meaningless. It is closed under multiplication.

Because NaN and negative zero are excluded, this type implements Eq straightforwardly, and can reliably be used as a map key for caching, interning, etc.

Implementations

impl<T: FloatCore> ZeroOne<T>

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

Construct ZeroOne without checking the value.

Safety

value must be +0, 1, or some value in between those two. Note that value >= 0. && value <= 1. is not a sufficient condition, because it does not exclude negative zero.

pub const fn into_inner(self) -> T

Unwraps the value without modifying it.

pub fn complement(self) -> Self

Returns 1.0 - self.

The result cannot be out of range, so this operation is always successful.

impl<T: FloatCore + ConstZero + ConstOne> ZeroOne<T>

pub const ZERO: Self

The number zero, as a constant.

pub const ONE: Self

The number one, as a constant.

impl ZeroOne<f32>

pub const fn new_strict(value: f32) -> Self

Wraps the given value in ZeroOne.

• If value is in range, returns wrapped value.
• If value is zero of either sign, returns wrapped positive zero. This is lossy, but corresponds to the IEEE 754 idea that -0.0 == +0.0.
• If value is out of range or NaN, panics.

pub const fn new_clamped(value: f32) -> Self

Wraps the given value in ZeroOne.

• If the value is NaN, panics.
• If the value is out of range, replaces it with the nearest in-range value (0 or 1).

pub const fn is_zero(self) -> bool

Const version of self == ZeroOne::ZERO

pub const fn is_one(self) -> bool

Const version of self == ZeroOne::ONE

impl ZeroOne<f64>

pub const fn new_strict(value: f64) -> Self

Wraps the given value in ZeroOne.

• If value is in range, returns wrapped value.
• If value is zero of either sign, returns wrapped positive zero. This is lossy, but corresponds to the IEEE 754 idea that -0.0 == +0.0.
• If value is out of range or NaN, panics.

pub const fn new_clamped(value: f64) -> Self

Wraps the given value in ZeroOne.

• If the value is NaN, panics.
• If the value is out of range, replaces it with the nearest in-range value (0 or 1).

pub const fn is_zero(self) -> bool

Const version of self == ZeroOne::ZERO

pub const fn is_one(self) -> bool

Const version of self == ZeroOne::ONE

Trait Implementations

impl<T> AsRef<T> for ZeroOne<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for ZeroOne<T>

fn clone(&self) -> ZeroOne<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: FloatCore + ConstOne> ConstOne for ZeroOne<T>

const ONE: Self

The multiplicative identity element of Self, 1.

impl<T: Copy> Copy for ZeroOne<T>

impl<T: Debug> Debug for ZeroOne<T>

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

Formats the value using the given formatter.

impl<T: FloatCore + Zero> Default for ZeroOne<T>

fn default() -> Self

The default is zero, regardless of what T::default() is.

impl<T: Display> Display for ZeroOne<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> Eq for ZeroOne<T>

impl From<ZeroOne<f32>> for NotNan<f32>

fn from(value: ZeroOne<f32>) -> Self

Converts to this type from the input type.

impl From<ZeroOne<f32>> for f32

fn from(value: ZeroOne<f32>) -> Self

Converts to this type from the input type.

impl From<ZeroOne<f32>> for PositiveSign<f32>

fn from(value: ZeroOne<f32>) -> Self

Converts to this type from the input type.

impl From<ZeroOne<f64>> for NotNan<f64>

fn from(value: ZeroOne<f64>) -> Self

Converts to this type from the input type.

impl From<ZeroOne<f64>> for f64

fn from(value: ZeroOne<f64>) -> Self

Converts to this type from the input type.

impl From<ZeroOne<f64>> for PositiveSign<f64>

fn from(value: ZeroOne<f64>) -> Self

Converts to this type from the input type.

impl<T: FloatCore> From<bool> for ZeroOne<T>

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<T: PrimitiveFloat> Hash for ZeroOne<T>

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<T: FloatCore + Mul<Output = T>> Mul for ZeroOne<T>

type Output = ZeroOne<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: FloatCore> Mul<PositiveSign<T>> for ZeroOne<T>

where PositiveSign<T>: From<ZeroOne<T>>,

type Output = PositiveSign<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: FloatCore> Mul<ZeroOne<T>> for PositiveSign<T>

where PositiveSign<T>: From<ZeroOne<T>>,

type Output = PositiveSign<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<ZeroOne<f32>> for Rgb

fn mul(self, scalar: ZeroOne<f32>) -> Self

Multiplies this color value by a scalar.

type Output = Rgb

The resulting type after applying the * operator.

impl Mul<ZeroOne<f32>> for Rgb01

fn mul(self, scalar: ZeroOne<f32>) -> Self

Multiplies this color value by a scalar.

type Output = Rgb01

The resulting type after applying the * operator.

impl<T: FloatCore + Mul<Output = T>> MulAssign for ZeroOne<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: FloatCore + One> One for ZeroOne<T>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<T: FloatCore + PartialOrd> Ord for ZeroOne<T>

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<T: PartialEq> PartialEq for ZeroOne<T>

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

fn eq(&self, other: &T) -> 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<T: FloatCore + PartialOrd> PartialOrd for ZeroOne<T>

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<T: PartialOrd> PartialOrd<T> for ZeroOne<T>

fn partial_cmp(&self, other: &T) -> 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<T> StructuralPartialEq for ZeroOne<T>

impl TryFrom<f32> for ZeroOne<f32>

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

Checks that value is within the range 0 to 1.

• If value > 0 and value ≤ 1, returns wrapped value.
• If value is zero of either sign, returns wrapped positive zero. This is lossy, but corresponds to the IEEE 754 idea that -0.0 == +0.0.
• If value is out of range or NaN, returns an error.

type Error = NotZeroOne<f32>

The type returned in the event of a conversion error.

impl TryFrom<f64> for ZeroOne<f64>

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

Checks that value is within the range 0 to 1.

• If value > 0 and value ≤ 1, returns wrapped value.
• If value is zero of either sign, returns wrapped positive zero. This is lossy, but corresponds to the IEEE 754 idea that -0.0 == +0.0.
• If value is out of range or NaN, returns an error.

type Error = NotZeroOne<f64>

The type returned in the event of a conversion error.