Struct Unit

#[repr(transparent)]
pub struct Unit(pub f32);

Representation of a unit-based Angle.

A unit is an angle where each revolution is exactly 1. This makes conversion to and from other angular units simple; e.g. 1 Unit is 360 Degree units which means conversion to Degree is just a simple multiplication. Likewise, the inverse conversion is a simple division operation.

Tuple Fields

0: f32

Implementations

impl Unit

pub fn to_radians(self) -> Radian

Converts this Unit into Radian.

Example

Basic use:

assert_eq!(Unit::ONE_REVOLUTION.to_radians(), Radian::ONE_REVOLUTION);

pub fn to_degrees(self) -> Degree

Converts this Unit into Degree.

Example

Basic use:

assert_eq!(Unit::ONE_REVOLUTION.to_degrees(), Degree::ONE_REVOLUTION);

pub fn to_gradians(self) -> Gradian

Converts this Unit into Gradian.

Example

Basic use:

assert_eq!(Unit::ONE_REVOLUTION.to_gradians(), Gradian::ONE_REVOLUTION);

pub fn from_radians(angle: Radian) -> Self

Constructs a new Unit object from an existing angle.

Parameters

• angle - the angle to construct from

Example

Basic use:

assert_eq!(Unit::from_radians(Radian::ONE_REVOLUTION), Unit::ONE_REVOLUTION);

pub fn from_degrees(angle: Degree) -> Self

Constructs a new Unit object from an existing angle.

Parameters

• angle - the angle to construct from

Example

Basic use:

assert_eq!(Unit::from_degrees(Degree::ONE_REVOLUTION), Unit::ONE_REVOLUTION);

pub fn from_gradians(angle: Gradian) -> Self

Constructs a new Unit object from an existing angle.

Parameters

• angle - the angle to construct from

Example

Basic use:

assert_eq!(Unit::from_gradians(Gradian::ONE_REVOLUTION), Unit::ONE_REVOLUTION);

impl Unit

pub const ONE_REVOLUTION: Self = _

Constant for the number of units of Self required to perform one full revolution around a unit circle.

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

Constructs a new instance of this angle type

Parameters

• value - the number of units

pub fn constrained(self) -> Self

Constructs a new instance of this angle by constraining the result to be within one revolution.

Note: This will

pub fn revolutions(self) -> f32

Counts the number of times this angle has revolved round the unit circle.

pub fn abs(self) -> Self

Computes the absolute value of this angle and returns it.

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 24u32

pub const DIGITS: u32 = 6u32

pub const EPSILON: f32 = 1.1920929E-7f32

pub const MIN: f32 = -3.40282347E+38f32

pub const MIN_POSITIVE: f32 = 1.17549435E-38f32

pub const MAX: f32 = 3.40282347E+38f32

pub const MIN_EXP: i32 = -125i32

pub const MAX_EXP: i32 = 128i32

pub const MIN_10_EXP: i32 = -37i32

pub const MAX_10_EXP: i32 = 38i32

pub const NAN: f32 = NaN_f32

pub const INFINITY: f32 = +Inf_f32

pub const NEG_INFINITY: f32 = -Inf_f32

pub fn total_cmp(&self, other: &f32) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f32. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f32,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f32::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f32::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f32::NAN` could be positive or negative, which will affect the sort order.
if f32::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f32::NAN, -5.0, 0.1, 10.0, 99.0, f32::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f32::INFINITY, f32::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

impl Add<Degree> for Unit

type Output = Unit

The resulting type after applying the + operator.

fn add(self, rhs: Degree) -> Self::Output

Performs the + operation.

impl Add<Gradian> for Unit

type Output = Unit

The resulting type after applying the + operator.

fn add(self, rhs: Gradian) -> Self::Output

Performs the + operation.

impl Add<Radian> for Unit

type Output = Unit

The resulting type after applying the + operator.

fn add(self, rhs: Radian) -> Self::Output

Performs the + operation.

impl Add<Unit> for Degree

type Output = Degree

The resulting type after applying the + operator.

fn add(self, rhs: Unit) -> Self::Output

Performs the + operation.

impl Add<Unit> for Gradian

type Output = Gradian

The resulting type after applying the + operator.

fn add(self, rhs: Unit) -> Self::Output

Performs the + operation.

impl Add<Unit> for Radian

type Output = Radian

The resulting type after applying the + operator.

fn add(self, rhs: Unit) -> Self::Output

Performs the + operation.

impl Add for Unit

type Output = Unit

The resulting type after applying the + operator.

fn add(self, rhs: Unit) -> Self::Output

Performs the + operation.

impl AddAssign<Degree> for Unit

fn add_assign(&mut self, rhs: Degree)

Performs the += operation.

impl AddAssign<Gradian> for Unit

fn add_assign(&mut self, rhs: Gradian)

Performs the += operation.

impl AddAssign<Radian> for Unit

fn add_assign(&mut self, rhs: Radian)

Performs the += operation.

impl AddAssign<Unit> for Degree

fn add_assign(&mut self, rhs: Unit)

Performs the += operation.

impl AddAssign<Unit> for Gradian

fn add_assign(&mut self, rhs: Unit)

Performs the += operation.

impl AddAssign<Unit> for Radian

fn add_assign(&mut self, rhs: Unit)

Performs the += operation.

impl AddAssign for Unit

fn add_assign(&mut self, rhs: Unit)

Performs the += operation.

impl AlmostEq<Degree> for Unit

fn almost_eq(&self, other: &Degree) -> bool

Tests whether self is almost equal to other

impl AlmostEq<Gradian> for Unit

fn almost_eq(&self, other: &Gradian) -> bool

Tests whether self is almost equal to other

impl AlmostEq<Radian> for Unit

fn almost_eq(&self, other: &Radian) -> bool

Tests whether self is almost equal to other

impl AlmostEq<Unit> for Degree

fn almost_eq(&self, other: &Unit) -> bool

Tests whether self is almost equal to other

impl AlmostEq<Unit> for Gradian

fn almost_eq(&self, other: &Unit) -> bool

Tests whether self is almost equal to other

impl AlmostEq<Unit> for Radian

fn almost_eq(&self, other: &Unit) -> bool

Tests whether self is almost equal to other

impl AlmostEq for Unit

fn almost_eq(&self, other: &Unit) -> bool

Tests whether self is almost equal to other

impl Angle for Unit

fn to_angle<A: Angle>(self) -> A

Converts this Angle to any other generic Angle by converting to Unit as an intermediate value.

fn from_angle<A: Angle>(angle: A) -> Self

Constructs this angle from any other Angle unit value

impl AsMut<f32> for Unit

fn as_mut(&mut self) -> &mut f32

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<f32> for Unit

fn as_ref(&self) -> &f32

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Unit

fn clone(&self) -> Unit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl Default for Unit

fn default() -> Unit

Returns the “default value” for a type.

impl Deref for Unit

type Target = f32

The resulting type after dereferencing.

fn deref(&self) -> &f32

Dereferences the value.

impl DerefMut for Unit

fn deref_mut(&mut self) -> &mut f32

Mutably dereferences the value.

impl Display for Unit

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

Formats the value using the given formatter.

impl Div<f32> for Unit

type Output = Unit

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl DivAssign for Unit

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<Degree> for Unit

fn from(other: Degree) -> Self

Converts to this type from the input type.

impl From<Gradian> for Unit

fn from(other: Gradian) -> Self

Converts to this type from the input type.

impl From<Radian> for Unit

fn from(other: Radian) -> Self

Converts to this type from the input type.

impl From<Unit> for Degree

fn from(other: Unit) -> Self

Converts to this type from the input type.

impl From<Unit> for Gradian

fn from(other: Unit) -> Self

Converts to this type from the input type.

impl From<Unit> for Radian

fn from(other: Unit) -> Self

Converts to this type from the input type.

impl FromUnit for Unit

fn from_unit(angle: Unit) -> Self

Converts the Unit angle into the new Angle type

impl Mul<Unit> for f32

type Output = Unit

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Unit

type Output = Unit

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Unit

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Near<Degree> for Unit

fn near(&self, other: &Degree, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Gradian> for Unit

fn near(&self, other: &Gradian, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Radian> for Unit

fn near(&self, other: &Radian, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Unit> for Degree

fn near(&self, other: &Unit, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Unit> for Gradian

fn near(&self, other: &Unit, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Unit> for Radian

fn near(&self, other: &Unit, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<Unit> for f32

fn near(&self, other: &Unit, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near<f32> for Unit

fn near(&self, other: &f32, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Near for Unit

fn near(&self, other: &Unit, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl PartialEq<Degree> for Unit

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

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

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

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

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

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

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

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 Unit

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

fn partial_cmp(&self, other: &Degree) -> 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 PartialOrd<Gradian> for Unit

fn partial_cmp(&self, other: &Gradian) -> 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 PartialOrd<Radian> for Unit

fn partial_cmp(&self, other: &Radian) -> 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 PartialOrd<Unit> for Degree

fn partial_cmp(&self, other: &Unit) -> 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 PartialOrd<Unit> for Gradian

fn partial_cmp(&self, other: &Unit) -> 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 PartialOrd<Unit> for Radian

fn partial_cmp(&self, other: &Unit) -> 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 PartialOrd<Unit> for f32

fn partial_cmp(&self, other: &Unit) -> 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 PartialOrd<f32> for Unit

fn partial_cmp(&self, other: &f32) -> 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 PartialOrd for Unit

fn partial_cmp(&self, other: &Unit) -> 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 Rem<f32> for Unit

type Output = Unit

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> Self::Output

Performs the % operation.

impl RemAssign for Unit

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub<Degree> for Unit

type Output = Unit

The resulting type after applying the - operator.

fn sub(self, rhs: Degree) -> Self::Output

Performs the - operation.

impl Sub<Gradian> for Unit

type Output = Unit

The resulting type after applying the - operator.

fn sub(self, rhs: Gradian) -> Self::Output

Performs the - operation.

impl Sub<Radian> for Unit

type Output = Unit

The resulting type after applying the - operator.

fn sub(self, rhs: Radian) -> Self::Output

Performs the - operation.

impl Sub<Unit> for Degree

type Output = Degree

The resulting type after applying the - operator.

fn sub(self, rhs: Unit) -> Self::Output

Performs the - operation.

impl Sub<Unit> for Gradian

type Output = Gradian

The resulting type after applying the - operator.

fn sub(self, rhs: Unit) -> Self::Output

Performs the - operation.

impl Sub<Unit> for Radian

type Output = Radian

The resulting type after applying the - operator.

fn sub(self, rhs: Unit) -> Self::Output

Performs the - operation.

impl Sub for Unit

type Output = Unit

The resulting type after applying the - operator.

fn sub(self, rhs: Unit) -> Self::Output

Performs the - operation.

impl SubAssign<Degree> for Unit

fn sub_assign(&mut self, rhs: Degree)

Performs the -= operation.

impl SubAssign<Gradian> for Unit

fn sub_assign(&mut self, rhs: Gradian)

Performs the -= operation.

impl SubAssign<Radian> for Unit

fn sub_assign(&mut self, rhs: Radian)

Performs the -= operation.

impl SubAssign<Unit> for Degree

fn sub_assign(&mut self, rhs: Unit)

Performs the -= operation.

impl SubAssign<Unit> for Gradian

fn sub_assign(&mut self, rhs: Unit)

Performs the -= operation.

impl SubAssign<Unit> for Radian

fn sub_assign(&mut self, rhs: Unit)

Performs the -= operation.

impl SubAssign for Unit

fn sub_assign(&mut self, rhs: Unit)

Performs the -= operation.

impl ToUnit for Unit

fn to_unit(self) -> Unit

Converts this Degree into Unit.

impl Transparent for Unit

type Wrapped = f32

The type that is wrapped by the Transparent impl.

fn from_ref(wrapped: &Self::Wrapped) -> &Self

Converts a reference to a type into a reference of the wrapper type.

fn from_ref_mut(wrapped: &mut Self::Wrapped) -> &mut Self

Converts a mut reference to a wrapped type into a mut reference to the wrapper.

impl Trig for Unit

fn sin(self) -> f32

Computes the sine of this angle.

fn cos(self) -> f32

Computes the cosine of this angle.

fn tan(self) -> f32

Computes the tangent of this angle.

fn sin_cos(self) -> (f32, f32)

Computes the sine and tangent of this angle.

fn asin(value: f32) -> Self

Computes the arc-sine of the input value, returning the Angle

fn acos(value: f32) -> Self

Computes the arc-cosine of the input value, returning the Angle

fn atan(value: f32) -> Self

Computes the arc-tangent of the input value, returning the Angle

impl Copy for Unit