Struct strict_num::NormalizedF32

#[repr(transparent)]
pub struct NormalizedF32(pub(crate) FiniteF32);

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

Tuple Fields

0: FiniteF32

Implementations

impl NormalizedF32

pub const ZERO: Self = _

A NormalizedF32 value initialized with zero.

pub const ONE: Self = _

A NormalizedF32 value initialized with one.

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

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

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.

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.

pub fn new_u8(n: u8) -> Self

Creates a NormalizedF32 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) -> f32

Returns the value as a primitive type.

pub const fn get_finite(&self) -> FiniteF32

Returns the value as a FiniteF32.

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

fn clone(&self) -> NormalizedF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedF32

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

Formats the value using the given formatter.

impl Display for NormalizedF32

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

Formats the value using the given formatter.

impl Hash for NormalizedF32

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 Mul for NormalizedF32

type Output = NormalizedF32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for NormalizedF32

fn cmp(&self, other: &NormalizedF32) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<f32> for NormalizedF32

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 NormalizedF32

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

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

impl Eq for NormalizedF32

impl StructuralPartialEq for NormalizedF32