pub struct NormalizedF64(/* private fields */);
Expand description

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

Implementations§

source§

impl NormalizedF64

source

pub const ZERO: Self = _

A NormalizedF64 value initialized with zero.

source

pub const ONE: Self = _

A NormalizedF64 value initialized with one.

source

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

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

source

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

Creates a new NormalizedF64 without checking the value.

Safety

n must be in 0..=1 range.

source

pub fn new_clamped(n: f64) -> Self

Creates a NormalizedF64 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 NormalizedF64 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) -> f64

Returns the value as a primitive type.

source

pub const fn get_finite(&self) -> FiniteF64

Returns the value as a FiniteF64.

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

source§

fn clone(&self) -> NormalizedF64

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 NormalizedF64

source§

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

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

impl Display for NormalizedF64

source§

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

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

impl Hash for NormalizedF64

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 NormalizedF64

§

type Output = NormalizedF64

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Ord for NormalizedF64

source§

fn cmp(&self, other: &NormalizedF64) -> 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<f64> for NormalizedF64

source§

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

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

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

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

impl PartialEq for NormalizedF64

source§

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

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

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

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

impl PartialOrd for NormalizedF64

source§

fn partial_cmp(&self, other: &NormalizedF64) -> 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

This method 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

This method 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

This method 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

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

impl Copy for NormalizedF64

source§

impl Eq for NormalizedF64

source§

impl StructuralEq for NormalizedF64

source§

impl StructuralPartialEq for NormalizedF64

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.