Struct strict_num::NormalizedF32

source ·
pub struct NormalizedF32(/* private fields */);
Expand description

An immutable, finite f32 in a 0..=1 range.

Implementations§

source§

impl NormalizedF32

source

pub const ZERO: Self = _

A NormalizedF32 value initialized with zero.

source

pub const ONE: Self = _

A NormalizedF32 value initialized with one.

source

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

Creates a NormalizedF32 if the given value is in a 0..=1 range.

source

pub const unsafe fn new_unchecked(n: f32) -> Self

Creates a new NormalizedF32 without checking the value.

§Safety

n must be in 0..=1 range.

source

pub fn new_clamped(n: f32) -> Self

Creates a NormalizedF32 clamping the given value to a 0..=1 range.

Returns zero in case of NaN or infinity.

source

pub fn new_u8(n: u8) -> Self

Creates a NormalizedF32 by dividing the given value by 255.

source

pub fn new_u16(n: u16) -> Self

Creates a NormalizedF64 by dividing the given value by 65535.

source

pub const fn get(self) -> f32

Returns the value as a primitive type.

source

pub const fn get_finite(&self) -> FiniteF32

Returns the value as a FiniteF32.

source

pub fn to_u8(&self) -> u8

Returns the value as a u8.

source

pub fn to_u16(&self) -> u16

Returns the value as a u16.

Trait Implementations§

source§

impl ApproxEq for NormalizedF32

source§

type Margin = F32Margin

This type type defines a margin within which two values are to be considered approximately equal. It must implement Default so that approx_eq() can be called on unknown types.
source§

fn approx_eq<M: Into<Self::Margin>>(self, other: Self, margin: M) -> bool

This method tests that the self and other values are equal within margin of each other.
source§

fn approx_ne<M>(self, other: Self, margin: M) -> bool
where M: Into<Self::Margin>,

This method tests that the self and other values are not within margin of each other.
source§

impl ApproxEqUlps for NormalizedF32

source§

type Flt = f32

source§

fn approx_eq_ulps(&self, other: &Self, ulps: i32) -> bool

This method tests for self and other values to be approximately equal within ULPs (Units of Least Precision) floating point representations. Differing signs are always unequal with this method, and zeroes are only equal to zeroes. Use approx_eq() from the ApproxEq trait if that is more appropriate.
source§

fn approx_ne_ulps(&self, other: &Self, ulps: <Self::Flt as Ulps>::U) -> bool

This method tests for self and other values to be not approximately equal within ULPs (Units of Least Precision) floating point representations. Differing signs are always unequal with this method, and zeroes are only equal to zeroes. Use approx_eq() from the ApproxEq trait if that is more appropriate.
source§

impl Clone for NormalizedF32

source§

fn clone(&self) -> NormalizedF32

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NormalizedF32

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for NormalizedF32

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for NormalizedF32

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Mul for NormalizedF32

source§

type Output = NormalizedF32

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Ord for NormalizedF32

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<f32> for NormalizedF32

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for NormalizedF32

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for NormalizedF32

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for NormalizedF32

source§

impl Eq for NormalizedF32

source§

impl StructuralPartialEq for NormalizedF32

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.