Enum ang::Angle

pub enum Angle<T = f64> {
    Radians(T),
    Degrees(T),
}

An angle.

Might be a value in degrees or in radians.

Variants

Radians(T)

The angle value in radians.

Degrees(T)

The angle value in degrees.

Implementations

impl<T: Copy + NumCast> Angle<T>

pub fn in_radians(self) -> T

Yield the value encoded in radians.

pub fn in_degrees(self) -> T

Yield the value encoded in degrees.

pub fn eighth() -> Angle<T>

An angle of 45°.

pub fn quarter() -> Angle<T>

An angle of 90° (right angle).

pub fn half() -> Angle<T>

An angle of 180° (straight).

pub fn full() -> Angle<T>

An angle of 360° (perigon).

impl<T: Copy + Num + NumCast + PartialOrd> Angle<T>

pub fn normalized(self) -> Self

Create a new angle by normalizing the value into the range of [0, 2π) rad.

Examples

let alpha = Degrees(-90.0f64).normalized();
assert!((alpha.in_degrees() - 270.0).abs() < 1.0e-10);

let beta = Radians(2.0 * PI).normalized();
assert!((beta.in_radians() - 0.0).abs() < 1.0e-10);

impl<T: Float> Angle<T>

pub fn min_dist(self, other: Angle<T>) -> Angle<T>

Computes the minimal unsigned distance between two normalized angles. Returns an angle in the range of [0, π] rad.

let distance = Degrees(345.0).min_dist(Degrees(15.0));
assert!((distance.in_degrees() - 30.0) < 1.0e-10);

impl<T: Signed> Angle<T>

pub fn abs(&self) -> Self

Compute the absolute angle.

pub fn signum(&self) -> Self

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or Float::infinity()
• -1.0 if the number is negative, -0.0 or Float::neg_infinity()
• Float::nan() if the number is Float::nan()

pub fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative

pub fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<T: Float + NumCast> Angle<T>

pub fn sin(self) -> T

Compute the sine of the angle.

pub fn cos(self) -> T

Compute the cosine of the angle.

pub fn tan(self) -> T

Compute the tangent of the angle.

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

Simultaneously compute the sine and cosine of the number, x. Return (sin(x), cos(x)).

Trait Implementations

impl<T: AbsDiffEq + Copy + NumCast> AbsDiffEq<Angle<T>> for Angle<T>

type Epsilon = T::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 AbsDiffEq::abs_diff_eq.

impl<T: Add + Copy + NumCast> Add<Angle<T>> for Angle<T>

type Output = Angle<T::Output>

The resulting type after applying the + operator.

fn add(self, rhs: Angle<T>) -> Self::Output

Performs the + operation.

impl<T: AddAssign + Copy + NumCast> AddAssign<Angle<T>> for Angle<T>

fn add_assign(&mut self, rhs: Angle<T>)

Performs the += operation.

impl<T: Clone> Clone for Angle<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Angle<T>

impl<T: Debug> Debug for Angle<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Angle<T>

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

Formats the value using the given formatter.

impl Div<Angle<f32>> for f32

type Output = Angle<f32>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Angle<f64>> for f64

type Output = Angle<f64>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<f64>) -> Self::Output

Performs the / operation.

impl Div<Angle<i16>> for i16

type Output = Angle<i16>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<i16>) -> Self::Output

Performs the / operation.

impl Div<Angle<i32>> for i32

type Output = Angle<i32>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<i32>) -> Self::Output

Performs the / operation.

impl Div<Angle<i64>> for i64

type Output = Angle<i64>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<i64>) -> Self::Output

Performs the / operation.

impl Div<Angle<i8>> for i8

type Output = Angle<i8>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<i8>) -> Self::Output

Performs the / operation.

impl Div<Angle<isize>> for isize

type Output = Angle<isize>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<isize>) -> Self::Output

Performs the / operation.

impl Div<Angle<u16>> for u16

type Output = Angle<u16>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<u16>) -> Self::Output

Performs the / operation.

impl Div<Angle<u32>> for u32

type Output = Angle<u32>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<u32>) -> Self::Output

Performs the / operation.

impl Div<Angle<u64>> for u64

type Output = Angle<u64>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<u64>) -> Self::Output

Performs the / operation.

impl Div<Angle<u8>> for u8

type Output = Angle<u8>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<u8>) -> Self::Output

Performs the / operation.

impl Div<Angle<usize>> for usize

type Output = Angle<usize>

The resulting type after applying the / operator.

fn div(self, rhs: Angle<usize>) -> Self::Output

Performs the / operation.

impl<T: Div + Copy> Div<T> for Angle<T>

type Output = Angle<T::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DivAssign> DivAssign<T> for Angle<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: Copy + Eq + NumCast> Eq for Angle<T>

impl<T: Hash> Hash for Angle<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, 

Feeds a slice of this type into the given Hasher.

impl Mul<Angle<f32>> for f32

type Output = Angle<f32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Angle<f64>> for f64

type Output = Angle<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<f64>) -> Self::Output

Performs the * operation.

impl Mul<Angle<i16>> for i16

type Output = Angle<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<i16>) -> Self::Output

Performs the * operation.

impl Mul<Angle<i32>> for i32

type Output = Angle<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<i32>) -> Self::Output

Performs the * operation.

impl Mul<Angle<i64>> for i64

type Output = Angle<i64>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<i64>) -> Self::Output

Performs the * operation.

impl Mul<Angle<i8>> for i8

type Output = Angle<i8>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<i8>) -> Self::Output

Performs the * operation.

impl Mul<Angle<isize>> for isize

type Output = Angle<isize>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<isize>) -> Self::Output

Performs the * operation.

impl Mul<Angle<u16>> for u16

type Output = Angle<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<u16>) -> Self::Output

Performs the * operation.

impl Mul<Angle<u32>> for u32

type Output = Angle<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<u32>) -> Self::Output

Performs the * operation.

impl Mul<Angle<u64>> for u64

type Output = Angle<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<u64>) -> Self::Output

Performs the * operation.

impl Mul<Angle<u8>> for u8

type Output = Angle<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<u8>) -> Self::Output

Performs the * operation.

impl Mul<Angle<usize>> for usize

type Output = Angle<usize>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<usize>) -> Self::Output

Performs the * operation.

impl<T: Mul + Copy> Mul<T> for Angle<T>

type Output = Angle<T::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: MulAssign> MulAssign<T> for Angle<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Neg> Neg for Angle<T>

type Output = Angle<T::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Ord + Eq + Copy + NumCast> Ord for Angle<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: Copy + NumCast + PartialEq> PartialEq<Angle<T>> for Angle<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd + Copy + NumCast> PartialOrd<Angle<T>> for Angle<T>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: RelativeEq + Copy + NumCast> RelativeEq<Angle<T>> for Angle<T>

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 RelativeEq::relative_eq.

impl<T: Send> Send for Angle<T>

impl<T: Sub + Copy + NumCast> Sub<Angle<T>> for Angle<T>

type Output = Angle<T::Output>

The resulting type after applying the - operator.

fn sub(self, rhs: Angle<T>) -> Self::Output

Performs the - operation.

impl<T: SubAssign + Copy + NumCast> SubAssign<Angle<T>> for Angle<T>

fn sub_assign(&mut self, rhs: Angle<T>)

Performs the -= operation.

impl<T: UlpsEq + Copy + NumCast> UlpsEq<Angle<T>> for Angle<T>

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 UlpsEq::ulps_eq.

impl<T: Zero + Copy + NumCast> Zero for Angle<T>

fn zero() -> Self

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.