Struct UnitNegRange

pub struct UnitNegRange(pub f64);

The UnitNegRange newtype an f64. A valid UnitNegRange value lies between -1.0 and +1.0 inclusive.

Tuple Fields

0: f64

Implementations

impl UnitNegRange

pub fn clamp(value: f64) -> Self

Clamp value into the valid range: -1.0 to +1.0 inclusive.

Examples

use angle_sc::trig::UnitNegRange;

assert_eq!(-1.0, UnitNegRange::clamp(-1.0 - f64::EPSILON).0);
assert_eq!(-1.0, UnitNegRange::clamp(-1.0).0);
assert_eq!(-0.5, UnitNegRange::clamp(-0.5).0);
assert_eq!(1.0, UnitNegRange::clamp(1.0).0);
assert_eq!(1.0, UnitNegRange::clamp(1.0 + f64::EPSILON).0);

pub fn abs(self) -> Self

The absolute value of the UnitNegRange.

Trait Implementations

impl Clone for UnitNegRange

fn clone(&self) -> UnitNegRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnitNegRange

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

Formats the value using the given formatter.

impl Neg for UnitNegRange

fn neg(self) -> Self

An implementation of Neg for UnitNegRange.

Negates the value.

type Output = UnitNegRange

The resulting type after applying the - operator.

impl PartialEq for UnitNegRange

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

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

fn is_valid(&self) -> bool

Test whether a UnitNegRange is valid.

I.e. whether it lies in the range: -1.0 <= value <= 1.0

Examples

use angle_sc::trig::UnitNegRange;
use angle_sc::Validate;

assert!(!UnitNegRange(-1.0 - f64::EPSILON).is_valid());
assert!(UnitNegRange(-1.0).is_valid());
assert!(UnitNegRange(1.0).is_valid());
assert!(!(UnitNegRange(1.0 + f64::EPSILON).is_valid()));

impl Copy for UnitNegRange

impl StructuralPartialEq for UnitNegRange