Struct clampf::Clamp

pub struct Clamp<T: Float>(_);

A wrapper around a floating-point value clamped to the range [0,1].

Methods

impl<T: Float> Clamp<T>

pub unsafe fn new_unchecked(value: T) -> Self

Creates a new wrapper around the value without checking.

Safety

The value must be in the range [0,1].

pub fn new(value: T) -> Self

Creates a new wrapper around the value.

pub unsafe fn set_unchecked(&mut self, value: T)

Sets the contained value without checking.

Safety

The value must be in the range [0,1].

pub fn set(&mut self, value: T)

Sets the contained value.

pub unsafe fn update_unchecked<F>(&mut self, func: F) where     F: FnOnce(T) -> T,

Updates the contained value using a function without checking.

Safety

The value produced by a function must be in the range [0,1].

pub fn update<F>(&mut self, func: F) where     F: FnOnce(T) -> T,

Updates the contained value using a function.

pub fn get(&self) -> T

Returns the contained value.

Trait Implementations

impl<T: Clone + Float> Clone for Clamp<T>

fn clone(&self) -> Clamp<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Float> Copy for Clamp<T>

impl<T: PartialEq + Float> PartialEq for Clamp<T>

fn eq(&self, other: &Clamp<T>) -> bool

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

fn ne(&self, other: &Clamp<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + Float> PartialOrd for Clamp<T>

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

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

fn lt(&self, other: &Clamp<T>) -> bool

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

fn le(&self, other: &Clamp<T>) -> bool

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

fn gt(&self, other: &Clamp<T>) -> bool

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

fn ge(&self, other: &Clamp<T>) -> bool

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

impl<T: Debug + Float> Debug for Clamp<T>

fn fmt(&self, fmter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Display + Float> Display for Clamp<T>

fn fmt(&self, fmter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: LowerExp + Float> LowerExp for Clamp<T>

fn fmt(&self, fmter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: UpperExp + Float> UpperExp for Clamp<T>

fn fmt(&self, fmter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Float> Default for Clamp<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Float> Bounded for Clamp<T>

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent