Struct Turns

#[repr(transparent)]
pub struct Turns<T>(pub T);

An angular quantity measured in “turns”, or full rotations.

Turns are uniquely defined from 0..1.

Tuple Fields

0: T

Trait Implementations

impl<T: Float + AbsDiffEq> AbsDiffEq for Turns<T>

where T::Epsilon: Clone,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<U, T> Add<U> for Turns<T>

where T: Float + Add<T, Output = T>, U: IntoAngle<Turns<T>, OutputScalar = T>,

type Output = Turns<T>

The resulting type after applying the + operator.

fn add(self, rhs: U) -> Turns<T>

Performs the + operation.

impl<U, T> AddAssign<U> for Turns<T>

where T: Float + AddAssign<T>, U: IntoAngle<Turns<T>, OutputScalar = T>,

fn add_assign(&mut self, rhs: U)

Performs the += operation.

impl<T: Float> Angle for Turns<T>

type Scalar = T

Internal type storing the angle value.

fn new(value: T) -> Turns<T>

Construct a new angle.

fn period() -> T

The length of a full rotation.

fn scalar(&self) -> T

Return the scalar (unitless) value.

fn set_scalar(&mut self, value: T)

Set the internal scalar value of the angle.

fn is_normalized(&self) -> bool

Whether the angle is in the standard domain.

fn normalize(self) -> Turns<T>

Normalize the angle, wrapping it back into the standard domain.

fn sin(self) -> T

Compute the sine of an angle.

fn cos(self) -> T

Compute the cosine of an angle.

fn tan(self) -> T

Compute the tangent of an angle.

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

Simultaneously compute sine and cosine.

fn asin(value: T) -> Turns<T>

Compute the arcsine of a value, returning an angle.

fn acos(value: T) -> Turns<T>

Compute the arccosine of a value, returning an angle.

fn atan(value: T) -> Turns<T>

Compute the arctangent of a value, returning an angle.

fn atan2(y: T, x: T) -> Turns<T>

Compute the arctangent of a value, using information from the numerator and denominator in order to increase the domain.

fn full_turn() -> Self

Return one full rotation in some unit.

fn half_turn() -> Self

Return one half of a full rotation in some unit.

fn quarter_turn() -> Self

Return one quarter of a full rotation in some unit.

fn invert(self) -> Self

Return the inverse of an angle.

fn reflect_x(self) -> Self

Return the reflection of an angle over the x axis.

impl<T: Clone> Clone for Turns<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Turns<T>

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

Formats the value using the given formatter.

impl<T: Zero> Default for Turns<T>

fn default() -> Turns<T>

Returns the “default value” for a type.

impl<T: Display> Display for Turns<T>

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

Formats the value using the given formatter.

impl<T: Div<T, Output = T>> Div<T> for Turns<T>

type Output = Turns<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Turns<T>

Performs the / operation.

impl<T: DivAssign<T>> DivAssign<T> for Turns<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: Float> From<Deg<T>> for Turns<T>

fn from(from: Deg<T>) -> Turns<T>

Converts to this type from the input type.

impl<T: Float> From<Gon<T>> for Turns<T>

fn from(from: Gon<T>) -> Turns<T>

Converts to this type from the input type.

impl<T: Float> From<Rad<T>> for Turns<T>

fn from(from: Rad<T>) -> Turns<T>

Converts to this type from the input type.

impl<T: Float> From<Turns<T>> for Deg<T>

fn from(from: Turns<T>) -> Deg<T>

Converts to this type from the input type.

impl<T: Float> From<Turns<T>> for Gon<T>

fn from(from: Turns<T>) -> Gon<T>

Converts to this type from the input type.

impl<T: Float> From<Turns<T>> for Rad<T>

fn from(from: Turns<T>) -> Rad<T>

Converts to this type from the input type.

impl<T, U> FromAngle<U> for Turns<T>

where U: Angle<Scalar = T>, T: Float,

fn from_angle(from: U) -> Turns<T>

Construct Self by converting a T.

impl<T: Hash> Hash for Turns<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Float> Interpolate for Turns<T>

fn interpolate<U>(&self, right: &U, pos: Self::Scalar) -> Self

where U: Clone + IntoAngle<Self, OutputScalar = Self::Scalar>,

Perform a linear interpolation between two angles.

fn interpolate_forward<U>(&self, right: &U, pos: Self::Scalar) -> Self

where U: Clone + IntoAngle<Self, OutputScalar = Self::Scalar>,

Perform a linear interpolation between two angles, going forward from self to right.

impl<T: Mul<T, Output = T>> Mul<T> for Turns<T>

type Output = Turns<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Turns<T>

Performs the * operation.

impl<T: MulAssign<T>> MulAssign<T> for Turns<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Neg<Output = T>> Neg for Turns<T>

type Output = Turns<T>

The resulting type after applying the - operator.

fn neg(self) -> Turns<T>

Performs the unary - operation.

impl<T: PartialEq> PartialEq for Turns<T>

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

fn partial_cmp(&self, other: &Turns<T>) -> 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<T: Float + RelativeEq> RelativeEq for Turns<T>

where T::Epsilon: Clone,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of ApproxEq::relative_eq.

impl<T: Rem<T, Output = T>> Rem for Turns<T>

type Output = Turns<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Turns<T>) -> Turns<T>

Performs the % operation.

impl<T: RemAssign> RemAssign for Turns<T>

fn rem_assign(&mut self, rhs: Turns<T>)

Performs the %= operation.

impl<U, T> Sub<U> for Turns<T>

where T: Float + Sub<T, Output = T>, U: IntoAngle<Turns<T>, OutputScalar = T>,

type Output = Turns<T>

The resulting type after applying the - operator.

fn sub(self, rhs: U) -> Turns<T>

Performs the - operation.

impl<U, T> SubAssign<U> for Turns<T>

where T: Float + SubAssign<T>, U: IntoAngle<Turns<T>, OutputScalar = T>,

fn sub_assign(&mut self, rhs: U)

Performs the -= operation.

impl<T: Float + UlpsEq> UlpsEq for Turns<T>

where T::Epsilon: Clone,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.

impl<T: Float> Zero for Turns<T>

fn zero() -> Turns<T>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy> Copy for Turns<T>

impl<T> StructuralPartialEq for Turns<T>