Struct radians::Angle

#[repr(transparent)]
pub struct Angle<F: Float, U: Unit<F>>(_, _);

An angle backed by a floating-point number.

Implementations

impl<F: Float, U: Unit<F>> Angle<F, U>

pub const ZERO: Self = _

Zero angle, additive identity.

pub const QUARTER_TURN: Self = _

Quarter turn around a circle. Equal to π/2 radians or 90°.

pub const HALF_TURN: Self = _

Half turn around a circle. Equal to π radians or 180°.

pub const FULL_TURN: Self = _

Full turn around a circle. Equal to 2π radians or 360°.

pub const MIN: Self = _

Minimum finite angle.

pub const MAX: Self = _

Maximum finite angle.

pub fn new(val: F) -> Self

Create a new angle from a raw value.

Panics

If the value is non-finite (debug mode).

pub const unsafe fn unchecked(val: F) -> Self

Safety

Ensure that the value is neither infinite nor NaN.

pub const fn val(self) -> F

Gets the value of this angle.

pub fn wrap(self) -> Wrap<F, U>

pub fn mag(self) -> Self

Returns the magnitude (absolute value) of this angle.

impl<F: Float, U: Unit<F>> Angle<F, U>

pub fn sin(self) -> F

Computes the sine of this angle.

pub fn cos(self) -> F

Computes the cosine of this angle.

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

Computes both the sine and cosine of this angle.

pub fn tan(self) -> F

Computes the tangent of this angle.

pub fn asin(y: F) -> Self

Computes the arc-sine of the specified value.

pub fn acos(x: F) -> Self

Computes the arc-cosine of the specified value.

pub fn atan(tan: F) -> Self

Computes the arc-tangent of the specified value.

pub fn atan2(y: F, x: F) -> Self

Computes the four-quadrant arc-tangent of the specified fraction.

impl<F: Float> Angle<F, Radians>

pub fn deg(self) -> Deg<F>

Converts this angle to degrees.

impl<F: Float> Angle<F, Degrees>

pub fn rad(self) -> Rad<F>

Converts this angle to radians.

Trait Implementations

impl<F: Float, U: Unit<F>, Rhs: Into<Angle<F, U>>> Add<Rhs> for Angle<F, U>

type Output = Angle<F, U>

The resulting type after applying the + operator.

fn add(self, rhs: Rhs) -> Self

Performs the + operation.

impl<F: Float, U: Unit<F>, Rhs: Into<Angle<F, U>>> AddAssign<Rhs> for Angle<F, U>

fn add_assign(&mut self, rhs: Rhs)

Performs the += operation.

impl<F: Float, U: Unit<F>> Clone for Angle<F, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Float + Debug, U: Unit<F>> Debug for Angle<F, U>

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

Formats the value using the given formatter.

impl<F: Float, U: Unit<F>> Default for Angle<F, U>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float + Display, U: Unit<F>> Display for Angle<F, U>

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

Formats the value using the given formatter.

impl<F: Float, U: Unit<F>> Div<Angle<F, U>> for Angle<F, U>

type Output = F

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> F

Performs the / operation.

impl<F: Float, U: Unit<F>> Div<F> for Angle<F, U>

type Output = Angle<F, U>

The resulting type after applying the / operator.

fn div(self, rhs: F) -> Self

Performs the / operation.

impl<F: Float, U: Unit<F>> DivAssign<F> for Angle<F, U>

fn div_assign(&mut self, rhs: F)

Performs the /= operation.

impl<F: Float, U: Unit<F>> From<Finite<F>> for Angle<F, U>

fn from(f: Finite<F>) -> Self

Converts to this type from the input type.

impl<F: Float, U: Unit<F>> From<Wrap<F, U>> for Angle<F, U>

fn from(val: Wrap<F, U>) -> Self

Converts to this type from the input type.

impl<F: Float, U: Unit<F>> Mul<F> for Angle<F, U>

type Output = Angle<F, U>

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> Self

Performs the * operation.

impl<F: Float, U: Unit<F>> MulAssign<F> for Angle<F, U>

fn mul_assign(&mut self, rhs: F)

Performs the *= operation.

impl<F: Float, U: Unit<F>> Neg for Angle<F, U>

type Output = Angle<F, U>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<F: Float, U: Unit<F>> Ord for Angle<F, U>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<F: Float, U: Unit<F>> PartialEq<Angle<F, U>> for Angle<F, U>

fn eq(&self, rhs: &Self) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Float, U: Unit<F>> PartialOrd<Angle<F, U>> for Angle<F, U>

fn partial_cmp(&self, other: &Self) -> 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<F: Float, U: Unit<F>, Rhs: Into<Angle<F, U>>> Sub<Rhs> for Angle<F, U>

type Output = Angle<F, U>

The resulting type after applying the - operator.

fn sub(self, rhs: Rhs) -> Self

Performs the - operation.

impl<F: Float, U: Unit<F>, Rhs: Into<Angle<F, U>>> SubAssign<Rhs> for Angle<F, U>

fn sub_assign(&mut self, rhs: Rhs)

Performs the -= operation.

impl<F: Float, U: Unit<F>> Copy for Angle<F, U>

impl<F: Float, U: Unit<F>> Eq for Angle<F, U>