Struct strict_num::NormalizedF64

#[repr(transparent)]
pub struct NormalizedF64(_);

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

Implementations

impl NormalizedF64

pub const ZERO: Self = _

A NormalizedF64 value initialized with zero.

pub const ONE: Self = _

A NormalizedF64 value initialized with one.

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

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

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.

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.

pub fn new_u8(n: u8) -> Self

Creates a NormalizedF64 by dividing the given value by 255.

pub fn new_u16(n: u16) -> Self

Creates a NormalizedF64 by dividing the given value by 65535.

pub const fn get(self) -> f64

Returns the value as a primitive type.

pub const fn get_finite(&self) -> FiniteF64

Returns the value as a FiniteF64.

pub fn to_u8(&self) -> u8

Returns the value as a u8.

pub fn to_u16(&self) -> u16

Returns the value as a u16.

Trait Implementations

impl ApproxEq for NormalizedF64

type Margin = F64Margin

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.

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.

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.

impl ApproxEqUlps for NormalizedF64

type Flt = f64

fn approx_eq_ulps(&self, other: &Self, ulps: i64) -> 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.

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.

impl Clone for NormalizedF64

fn clone(&self) -> NormalizedF64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedF64

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

Formats the value using the given formatter.

impl Display for NormalizedF64

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

Formats the value using the given formatter.

impl Hash for NormalizedF64

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, 

Feeds a slice of this type into the given Hasher.

impl Mul<NormalizedF64> for NormalizedF64

type Output = NormalizedF64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for NormalizedF64

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<NormalizedF64> for NormalizedF64

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

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

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

This method tests for !=.

impl PartialOrd<NormalizedF64> for NormalizedF64

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for NormalizedF64

impl Eq for NormalizedF64

impl StructuralEq for NormalizedF64

impl StructuralPartialEq for NormalizedF64