Struct dotrix_math::Rad

#[repr(C)]
pub struct Rad<S>(pub S);

An angle, in radians.

This type is marked as #[repr(C)].

Tuple Fields

0: S

Trait Implementations

impl<S> AbsDiffEq<Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Epsilon = <S as AbsDiffEq<S>>::Epsilon

Used for specifying relative comparisons.

pub fn default_epsilon() -> <S as AbsDiffEq<S>>::Epsilon

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

pub fn abs_diff_eq(
    &self,
    other: &Rad<S>,
    epsilon: <S as AbsDiffEq<S>>::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<'a, S> Add<&'a Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the + operator.

pub fn add(self, other: &'a Rad<S>) -> Rad<S>

Performs the + operation.

impl<'a, 'b, S> Add<&'a Rad<S>> for &'b Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the + operator.

pub fn add(self, other: &'a Rad<S>) -> Rad<S>

Performs the + operation.

impl<'a, S> Add<Rad<S>> for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the + operator.

pub fn add(self, other: Rad<S>) -> Rad<S>

Performs the + operation.

impl<S> Add<Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the + operator.

pub fn add(self, other: Rad<S>) -> Rad<S>

Performs the + operation.

impl<S> AddAssign<Rad<S>> for Rad<S> where
    S: BaseFloat + AddAssign<S>, 

pub fn add_assign(&mut self, other: Rad<S>)

Performs the += operation.

impl<S> Angle for Rad<S> where
    S: BaseFloat, 

type Unitless = S

pub fn full_turn() -> Rad<S>

A full rotation.

pub fn sin(self) -> S

Compute the sine of the angle, returning a unitless ratio.

pub fn cos(self) -> S

Compute the cosine of the angle, returning a unitless ratio.

pub fn tan(self) -> S

Compute the tangent of the angle, returning a unitless ratio.

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

Compute the sine and cosine of the angle, returning the result as a pair.

pub fn asin(a: S) -> Rad<S>

Compute the arcsine of the ratio, returning the resulting angle.

pub fn acos(a: S) -> Rad<S>

Compute the arccosine of the ratio, returning the resulting angle.

pub fn atan(a: S) -> Rad<S>

Compute the arctangent of the ratio, returning the resulting angle.

pub fn atan2(a: S, b: S) -> Rad<S>

fn normalize(self) -> Self

Return the angle, normalized to the range [0, full_turn).

fn normalize_signed(self) -> Self

Return the angle, normalized to the range [-turn_div_2, turn_div_2).

fn opposite(self) -> Self

Return the angle rotated by half a turn.

fn bisect(self, other: Self) -> Self

Returns the interior bisector of the two angles.

fn turn_div_2() -> Self

Half of a full rotation.

fn turn_div_3() -> Self

A third of a full rotation.

fn turn_div_4() -> Self

A quarter of a full rotation.

fn turn_div_6() -> Self

A sixth of a full rotation.

fn csc(self) -> Self::Unitless

Compute the cosecant of the angle.

fn cot(self) -> Self::Unitless

Compute the cotangent of the angle.

fn sec(self) -> Self::Unitless

Compute the secant of the angle.

impl<S> Bounded for Rad<S> where
    S: Bounded, 

pub fn min_value() -> Rad<S>

returns the smallest finite number this type can represent

pub fn max_value() -> Rad<S>

returns the largest finite number this type can represent

impl<S> Clone for Rad<S> where
    S: Clone, 

pub fn clone(&self) -> Rad<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Rad<S> where
    S: Debug, 

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

Formats the value using the given formatter.

impl<'a, S> Div<&'a Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = S

The resulting type after applying the / operator.

pub fn div(self, other: &'a Rad<S>) -> S

Performs the / operation.

impl<'a, 'b, S> Div<&'a Rad<S>> for &'b Rad<S> where
    S: BaseFloat, 

type Output = S

The resulting type after applying the / operator.

pub fn div(self, other: &'a Rad<S>) -> S

Performs the / operation.

impl<S> Div<Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = S

The resulting type after applying the / operator.

pub fn div(self, other: Rad<S>) -> S

Performs the / operation.

impl<'a, S> Div<Rad<S>> for &'a Rad<S> where
    S: BaseFloat, 

type Output = S

The resulting type after applying the / operator.

pub fn div(self, other: Rad<S>) -> S

Performs the / operation.

impl<S> Div<S> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the / operator.

pub fn div(self, other: S) -> Rad<S>

Performs the / operation.

impl<'a, S> Div<S> for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the / operator.

pub fn div(self, other: S) -> Rad<S>

Performs the / operation.

impl<S> DivAssign<S> for Rad<S> where
    S: BaseFloat + DivAssign<S>, 

pub fn div_assign(&mut self, scalar: S)

Performs the /= operation.

impl<S> From<Deg<S>> for Rad<S> where
    S: BaseFloat, 

pub fn from(deg: Deg<S>) -> Rad<S>

Performs the conversion.

impl<S> From<Rad<S>> for Deg<S> where
    S: BaseFloat, 

pub fn from(rad: Rad<S>) -> Deg<S>

Performs the conversion.

impl<'a, S> Mul<S> for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the * operator.

pub fn mul(self, other: S) -> Rad<S>

Performs the * operation.

impl<S> Mul<S> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the * operator.

pub fn mul(self, other: S) -> Rad<S>

Performs the * operation.

impl<S> MulAssign<S> for Rad<S> where
    S: BaseFloat + MulAssign<S>, 

pub fn mul_assign(&mut self, scalar: S)

Performs the *= operation.

impl<S> Neg for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn neg(self) -> Rad<S>

Performs the unary - operation.

impl<'a, S> Neg for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn neg(self) -> Rad<S>

Performs the unary - operation.

impl<S> PartialEq<Rad<S>> for Rad<S> where
    S: PartialEq<S>, 

pub fn eq(&self, other: &Rad<S>) -> bool

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

pub fn ne(&self, other: &Rad<S>) -> bool

This method tests for !=.

impl<S> PartialOrd<Rad<S>> for Rad<S> where
    S: PartialOrd<S>, 

pub fn partial_cmp(&self, other: &Rad<S>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<S> RelativeEq<Rad<S>> for Rad<S> where
    S: BaseFloat, 

pub fn default_max_relative() -> <S as AbsDiffEq<S>>::Epsilon

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

pub fn relative_eq(
    &self,
    other: &Rad<S>,
    epsilon: <S as AbsDiffEq<S>>::Epsilon,
    max_relative: <S as AbsDiffEq<S>>::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<'a, 'b, S> Rem<&'a Rad<S>> for &'b Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the % operator.

pub fn rem(self, other: &'a Rad<S>) -> Rad<S>

Performs the % operation.

impl<'a, S> Rem<&'a Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the % operator.

pub fn rem(self, other: &'a Rad<S>) -> Rad<S>

Performs the % operation.

impl<'a, S> Rem<Rad<S>> for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the % operator.

pub fn rem(self, other: Rad<S>) -> Rad<S>

Performs the % operation.

impl<S> Rem<Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the % operator.

pub fn rem(self, other: Rad<S>) -> Rad<S>

Performs the % operation.

impl<S> RemAssign<Rad<S>> for Rad<S> where
    S: BaseFloat + RemAssign<S>, 

pub fn rem_assign(&mut self, other: Rad<S>)

Performs the %= operation.

impl<'a, S> Sub<&'a Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn sub(self, other: &'a Rad<S>) -> Rad<S>

Performs the - operation.

impl<'a, 'b, S> Sub<&'a Rad<S>> for &'b Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn sub(self, other: &'a Rad<S>) -> Rad<S>

Performs the - operation.

impl<S> Sub<Rad<S>> for Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn sub(self, other: Rad<S>) -> Rad<S>

Performs the - operation.

impl<'a, S> Sub<Rad<S>> for &'a Rad<S> where
    S: BaseFloat, 

type Output = Rad<S>

The resulting type after applying the - operator.

pub fn sub(self, other: Rad<S>) -> Rad<S>

Performs the - operation.

impl<S> SubAssign<Rad<S>> for Rad<S> where
    S: BaseFloat + SubAssign<S>, 

pub fn sub_assign(&mut self, other: Rad<S>)

Performs the -= operation.

impl<'a, S> Sum<&'a Rad<S>> for Rad<S> where
    S: 'a + BaseFloat, 

pub fn sum<I>(iter: I) -> Rad<S> where
    I: Iterator<Item = &'a Rad<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<S> Sum<Rad<S>> for Rad<S> where
    S: BaseFloat, 

pub fn sum<I>(iter: I) -> Rad<S> where
    I: Iterator<Item = Rad<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<S> UlpsEq<Rad<S>> for Rad<S> where
    S: BaseFloat, 

pub fn default_max_ulps() -> u32

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

pub fn ulps_eq(
    &self,
    other: &Rad<S>,
    epsilon: <S as AbsDiffEq<S>>::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<S> Zero for Rad<S> where
    S: BaseFloat, 

pub fn zero() -> Rad<S>

Returns the additive identity element of Self, 0.

pub 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<S> Copy for Rad<S> where
    S: Copy, 

impl<S> StructuralPartialEq for Rad<S>