Struct Normalized 

pub struct Normalized<S>(/* private fields */);

Scalars in the closed unit interval [0, 1]

Implementations

impl<S> Normalized<S>

where S: One + Zero,

pub fn zero() -> Self

pub fn is_zero(&self) -> bool

pub fn new(value: S) -> Option<Self>

where S: PartialOrd,

Returns ‘None’ when called with a value outside of the closed unit interval [0,1].

Example

assert!(Normalized::new (2.0).is_none());
assert!(Normalized::new (1.0).is_some());
assert!(Normalized::new (0.5).is_some());
assert!(Normalized::new (0.0).is_some());
assert!(Normalized::new (-1.0).is_none());

pub fn clamp(value: S) -> Self

where S: MinMax,

Clamps to the closed unit interval [0,1].

Example

assert_eq!(*Normalized::clamp (2.0), 1.0);
assert_eq!(*Normalized::clamp (-1.0), 0.0);

pub fn noisy(value: S) -> Self

where S: PartialOrd,

Panics if outside the closed unit interval [0,1].

Panics

let x = Normalized::noisy (-1.0);  // panic!

let x = Normalized::noisy (2.0);  // panic!

pub fn unchecked(value: S) -> Self

where S: PartialOrd,

Create a new normalized number without checking the value.

This method is completely unchecked for release builds. Debug builds will panic if the value is negative:

let normalized = Normalized::unchecked (1.5);   // panic!

pub fn map_clamp<F>(self, fun: F) -> Self

where S: MinMax, F: FnMut(S) -> S,

Map an operation on the underlying scalar, clamping results to the closed unit interval [0,1].

Example

assert_eq!(*Normalized::<f64>::one().map_clamp (|x|  2.0 * x), 1.0);
assert_eq!(*Normalized::<f64>::one().map_clamp (|x| -2.0 * x), 0.0);

pub fn map_noisy<F>(self, fun: F) -> Self

where S: PartialOrd, F: FnMut(S) -> S,

Map an operation on the underlying scalar, panicking if the result is outside the unit interval [0,1].

Example

assert_eq!(*Normalized::<f64>::one().map_noisy (|x| 0.5 * x), 0.5);

Panics

Panics of the result is outside [0,1]:

let v = Normalized::<f64>::one().map_noisy (|x| -1.0 * x);  // panic!

let v = Normalized::<f64>::one().map_noisy (|x|  2.0 * x);  // panic!

impl Normalized<f32>

pub const fn new_f32(value: f32) -> Option<Self>

Const constructor for f32

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

Const constructor for f32 with assertions

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

Const constructor for f32 with debug assertions

impl Normalized<f64>

pub const fn new_f64(value: f64) -> Option<Self>

Const constructor for f64

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

Const constructor for f64 with assertions

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

Const constructor for f64 with debug assertions

impl<S> Normalized<S>

pub fn numcast<T>(self) -> Option<Normalized<T>>

where S: NumCast, T: NumCast,

Trait Implementations

impl<S: Clone> Clone for Normalized<S>

fn clone(&self) -> Normalized<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Normalized<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Normalized<S>

fn default() -> Normalized<S>

Returns the “default value” for a type.

impl<S> Deref for Normalized<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<S> Display for Normalized<S>

where S: Display,

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

Formats the value using the given formatter.

impl<S: OrderedField> From<Normalized<S>> for NormalSigned<S>

fn from(Normalized: Normalized<S>) -> Self

Converts to this type from the input type.

impl<S: Ring> Mul for Normalized<S>

type Output = Normalized<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S> NumCast for Normalized<S>

where S: NumCast + PartialOrd + One + Zero,

fn from<T: ToPrimitive>(n: T) -> Option<Normalized<S>>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<S: Ring> One for Normalized<S>

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<S: PartialOrd> Ord for Normalized<S>

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<S: PartialEq> PartialEq for Normalized<S>

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

fn partial_cmp(&self, other: &Normalized<S>) -> 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<S> ToPrimitive for Normalized<S>

where S: ToPrimitive,

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl<S: Copy> Copy for Normalized<S>

impl<S: PartialEq> Eq for Normalized<S>

impl<S> StructuralPartialEq for Normalized<S>