Struct Closed01 

pub struct Closed01<F>(/* private fields */)
where
    F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One;

Encapsulates a floating point number in the range [0, 1] including both endpoints.

Implementations

impl<F> Closed01<F>

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One,

pub fn new(f: F) -> Self

pub fn zero() -> Self

pub fn center() -> Self

pub fn one() -> Self

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

Returns the smaller of the two.

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

Returns the greater of the two.

pub fn distance(self, other: Self) -> Self

Returns the distance between the two numbers.

pub fn get(self) -> F

pub fn average(self, other: Self) -> Self

The average of two values.

pub fn saturating_add(self, other: Self) -> Self

Saturating add

pub fn saturating_sub(self, other: Self) -> Self

Saturating sub

pub fn mul(self, scalar: Self) -> Self

Multiplies both numbers

pub fn approx_eq(self, other: Self, eps: Self) -> bool

pub fn scale_up(self, other: Self) -> Self

This scales self towards 1.0

pub fn scale_down(self, other: Self) -> Self

This scales self towards 0.0

pub fn inv(self) -> Self

Invert the number (Mirror at 0.5; 1.0 - number).

pub fn round(self) -> Self

Round the number to 0.0 or 1.0

Trait Implementations

impl<F> Clone for Closed01<F>

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One + Clone,

fn clone(&self) -> Closed01<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Debug for Closed01<F>

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One + Debug,

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

Formats the value using the given formatter.

impl Into<f32> for Closed01<f32>

fn into(self) -> f32

Converts this type into the (usually inferred) input type.

impl Into<f32> for Closed01<f64>

fn into(self) -> f32

Converts this type into the (usually inferred) input type.

impl Into<f64> for Closed01<f32>

fn into(self) -> f64

Converts this type into the (usually inferred) input type.

impl Into<f64> for Closed01<f64>

fn into(self) -> f64

Converts this type into the (usually inferred) input type.

impl<F> PartialEq for Closed01<F>

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One + PartialEq,

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

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One + PartialOrd,

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

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One + Copy,

impl<F> StructuralPartialEq for Closed01<F>

where F: Copy + Clone + Debug + PartialEq + PartialOrd + Float + Zero + One,