Struct Angle

pub struct Angle<F> { /* private fields */ }

Represents a point on the circle as a unit-agnostic angle.

The parameter F is the floating-point type used to store the value.

Behaviour

Two different values of the same point on the circle are the same Angle.

let a = Angle::from_degrees(90.0);
let b = Angle::from_degrees(450.0);

assert_eq!(a, b);

Why doesn’t it implement PartialOrd ?

Because Angles represent points on the circle (i.e., not a numerical value), they cannot be ordered.

The NaN angle

An angle can be NaN in the following cases:

• Create an angle from a non-finite value;

let a = Angle::from_radians(f32::INFINITY);
assert!(a.is_nan());

let b = Angle::from_radians(f32::NAN);
assert!(b.is_nan());

• Doing an operation that result into a non-finite value;

let a = Angle::DEG_90;
let b = a / 0.0;

assert!(b.is_nan());

Implementations

impl<F: Float> Angle<F>

pub const ZERO: Self

The angle of value zero.

pub const EPSILON: Self

Machine epsilon value for Angle.

impl<F: Float> Angle<F>

pub const RAD_PI: Self

The angle of π radians.

pub const RAD_FRAC_PI_2: Self

The angle of π/2 radians.

pub const RAD_FRAC_PI_3: Self

The angle of π/3 radians.

pub const RAD_FRAC_PI_4: Self

The angle of π/4 radians.

pub const RAD_FRAC_PI_6: Self

The angle of π/6 radians.

pub const RAD_FRAC_PI_8: Self

The angle of π/8 radians.

impl<F: Float> Angle<F>

pub const DEG_180: Self = Self::RAD_PI

The angle of 180°.

pub const DEG_90: Self = Self::RAD_FRAC_PI_2

The angle of 90°.

pub const DEG_60: Self = Self::RAD_FRAC_PI_3

The angle of 60°.

pub const DEG_45: Self = Self::RAD_FRAC_PI_4

The angle of 45°.

pub const DEG_30: Self = Self::RAD_FRAC_PI_6

The angle of 30°.

pub const DEG_22_5: Self = Self::RAD_FRAC_PI_8

The angle of 22.5°.

impl<F: Float> Angle<F>

pub const HALF: Self = Self::RAD_PI

The angle of a half of a circle (1/2 turns).

pub const QUARTER: Self = Self::RAD_FRAC_PI_2

The angle of a quarter of a circle (1/4 turns).

pub const SIXTH: Self = Self::RAD_FRAC_PI_3

The angle of a sixth of a circle (1/6 turns).

pub const EIGHTH: Self = Self::RAD_FRAC_PI_4

The angle of a eighth of a circle (1/8 turns).

pub const TWELFTH: Self = Self::RAD_FRAC_PI_6

The angle of a twelfth of a circle (1/12 turns).

pub const SIXTEENTH: Self = Self::RAD_FRAC_PI_8

The angle of a sixteenth of a circle (1/16 turns).

impl<F: Float> Angle<F>

pub const GRAD_200: Self = Self::RAD_PI

The angle of 200g.

pub const GRAD_100: Self = Self::RAD_FRAC_PI_2

The angle of 100g.

pub const GRAD_66_6: Self = Self::RAD_FRAC_PI_3

The angle of 66.6g.

pub const GRAD_50: Self = Self::RAD_FRAC_PI_4

The angle of 50g.

pub const GRAD_33_3: Self = Self::RAD_FRAC_PI_6

The angle of 33.3g.

pub const GRAD_25: Self = Self::RAD_FRAC_PI_8

The angle of 25g.

impl<F> Angle<F>

pub const fn from_radians_unchecked(radians: F) -> Self

Creates a new angle from a value in radians assuming it is already in the the range (-π, π].

impl<F: Float> Angle<F>

pub fn from_radians(radians: F) -> Self

Creates a new angle from a value in radians.

pub fn from_degrees(degrees: F) -> Self

Creates a new angle from a value in degrees.

pub fn from_turns(turns: F) -> Self

Creates a new angle from a value in turns.

pub fn from_gradians(gradians: F) -> Self

Creates a new angle from a value in gradians.

impl<F: Copy> Angle<F>

pub const fn to_radians(self) -> F

The value of the angle in radians.

This value is in the range (-π, π].

impl<F: Float> Angle<F>

pub fn to_degrees(self) -> F

The value of the angle in degrees.

This value is in the range (-180, 180].

pub fn to_turns(self) -> F

The value of the angle in turns.

This value is in the range (-0.5, 0.5].

pub fn to_gradians(self) -> F

The value of the angle in gradians.

This value is in the range (-200, 200].

impl<F: Float> Angle<F>

pub fn is_nan(self) -> bool

Returns true if this angle is NaN.

See Angle documentation for more details.

impl<F: Copy> Angle<F>

pub const fn to_unbounded(self) -> AngleUnbounded<F>

Converts this angle into an unbounded angle in the main range.

impl Angle<f32>

pub fn to_f64(self) -> Angle<f64>

Converts the floating point type to f64.

impl Angle<f64>

pub fn to_f32(self) -> Angle<f32>

Converts the floating point type to f32.

impl<F: FloatMath> Angle<F>

pub fn sin(self) -> F

Available on crate features std or libm only.

Computes the sine.

pub fn cos(self) -> F

Available on crate features std or libm only.

Computes the cosine.

pub fn tan(self) -> F

Available on crate features std or libm only.

Computes the tangent.

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

Available on crate features std or libm only.

Simultaneously computes the sine and cosine. Returns (sin(x), cos(x)).

Trait Implementations

impl<F: Float> Add<&Angle<F>> for &Angle<F>

type Output = <Angle<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &Angle<F>) -> <Angle<F> as Add<Angle<F>>>::Output

Performs the + operation.

impl<F: Float> Add<&Angle<F>> for Angle<F>

type Output = <Angle<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &Angle<F>) -> <Angle<F> as Add<Angle<F>>>::Output

Performs the + operation.

impl<'a, F: Float> Add<Angle<F>> for &'a Angle<F>

type Output = <Angle<F> as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: Angle<F>) -> <Angle<F> as Add<Angle<F>>>::Output

Performs the + operation.

impl<F: Float> Add for Angle<F>

type Output = Angle<F>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<F: Float> AddAssign<&Angle<F>> for Angle<F>

fn add_assign(&mut self, other: &Angle<F>)

Performs the += operation.

impl<F: Float> AddAssign for Angle<F>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<F: Clone> Clone for Angle<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Angle<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for Angle<F>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, F: Float + Deserialize<'de>> Deserialize<'de> for Angle<F>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Float> Distribution<Angle<F>> for Standard

where Self: Distribution<F>,

Available on crate feature rand only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Angle<F>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<F: Float> Div<&F> for &Angle<F>

type Output = <Angle<F> as Div<F>>::Output

The resulting type after applying the / operator.

fn div(self, other: &F) -> <Angle<F> as Div<F>>::Output

Performs the / operation.

impl<F: Float> Div<&F> for Angle<F>

type Output = <Angle<F> as Div<F>>::Output

The resulting type after applying the / operator.

fn div(self, other: &F) -> <Angle<F> as Div<F>>::Output

Performs the / operation.

impl<'a, F: Float> Div<F> for &'a Angle<F>

type Output = <Angle<F> as Div<F>>::Output

The resulting type after applying the / operator.

fn div(self, other: F) -> <Angle<F> as Div<F>>::Output

Performs the / operation.

impl<F: Float> Div<F> for Angle<F>

type Output = Angle<F>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<F: Float> DivAssign<&F> for Angle<F>

fn div_assign(&mut self, other: &F)

Performs the /= operation.

impl<F: Float> DivAssign<F> for Angle<F>

fn div_assign(&mut self, rhs: F)

Performs the /= operation.

impl<F: Copy> From<Angle<F>> for AngleUnbounded<F>

fn from(angle: Angle<F>) -> Self

Converts to this type from the input type.

impl From<Angle<f32>> for Angle<f64>

fn from(value: Angle<f32>) -> Self

Converts to this type from the input type.

impl From<Angle<f64>> for Angle<f32>

fn from(value: Angle<f64>) -> Self

Converts to this type from the input type.

impl<F: Float> From<AngleUnbounded<F>> for Angle<F>

fn from(angle: AngleUnbounded<F>) -> Self

Converts to this type from the input type.

impl<F: Hash> Hash for Angle<F>

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 Mul<&Angle<f32>> for &f32

type Output = <f32 as Mul<Angle<f32>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Angle<f32>) -> <f32 as Mul<Angle<f32>>>::Output

Performs the * operation.

impl Mul<&Angle<f32>> for f32

type Output = <f32 as Mul<Angle<f32>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Angle<f32>) -> <f32 as Mul<Angle<f32>>>::Output

Performs the * operation.

impl Mul<&Angle<f64>> for &f64

type Output = <f64 as Mul<Angle<f64>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Angle<f64>) -> <f64 as Mul<Angle<f64>>>::Output

Performs the * operation.

impl Mul<&Angle<f64>> for f64

type Output = <f64 as Mul<Angle<f64>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Angle<f64>) -> <f64 as Mul<Angle<f64>>>::Output

Performs the * operation.

impl<F: Float> Mul<&F> for &Angle<F>

type Output = <Angle<F> as Mul<F>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &F) -> <Angle<F> as Mul<F>>::Output

Performs the * operation.

impl<F: Float> Mul<&F> for Angle<F>

type Output = <Angle<F> as Mul<F>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &F) -> <Angle<F> as Mul<F>>::Output

Performs the * operation.

impl<'a> Mul<Angle<f32>> for &'a f32

type Output = <f32 as Mul<Angle<f32>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: Angle<f32>) -> <f32 as Mul<Angle<f32>>>::Output

Performs the * operation.

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<'a> Mul<Angle<f64>> for &'a f64

type Output = <f64 as Mul<Angle<f64>>>::Output

The resulting type after applying the * operator.

fn mul(self, other: Angle<f64>) -> <f64 as Mul<Angle<f64>>>::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<'a, F: Float> Mul<F> for &'a Angle<F>

type Output = <Angle<F> as Mul<F>>::Output

The resulting type after applying the * operator.

fn mul(self, other: F) -> <Angle<F> as Mul<F>>::Output

Performs the * operation.

impl<F: Float> Mul<F> for Angle<F>

type Output = Angle<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<F: Float> MulAssign<&F> for Angle<F>

fn mul_assign(&mut self, other: &F)

Performs the *= operation.

impl<F: Float> MulAssign<F> for Angle<F>

fn mul_assign(&mut self, rhs: F)

Performs the *= operation.

impl<F: Float> Neg for &Angle<F>

type Output = <Angle<F> as Neg>::Output

The resulting type after applying the - operator.

fn neg(self) -> <Angle<F> as Neg>::Output

Performs the unary - operation.

impl<F: Float> Neg for Angle<F>

type Output = Angle<F>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F: PartialEq> PartialEq for Angle<F>

fn eq(&self, other: &Angle<F>) -> 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<F> SampleRange<Angle<F>> for Range<Angle<F>>

where UniformFloat<F>: UniformSampler<X = F>, F: SampleBorrow<F> + Float,

Available on crate feature rand only.

fn sample_single<R: RngCore + ?Sized>(self, rng: &mut R) -> Angle<F>

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl<F> SampleRange<Angle<F>> for RangeInclusive<Angle<F>>

where UniformFloat<F>: UniformSampler<X = F>, F: SampleBorrow<F> + Float,

Available on crate feature rand only.

fn sample_single<R: RngCore + ?Sized>(self, rng: &mut R) -> Angle<F>

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl<F> SampleUniform for Angle<F>

where UniformFloat<F>: UniformSampler<X = F>, F: SampleBorrow<F> + Float,

Available on crate feature rand only.

type Sampler = UniformAngle<F>

The UniformSampler implementation supporting type X.

impl<F: Copy + Serialize> Serialize for Angle<F>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Float> Sub<&Angle<F>> for &Angle<F>

type Output = <Angle<F> as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Angle<F>) -> <Angle<F> as Sub<Angle<F>>>::Output

Performs the - operation.

impl<F: Float> Sub<&Angle<F>> for Angle<F>

type Output = <Angle<F> as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Angle<F>) -> <Angle<F> as Sub<Angle<F>>>::Output

Performs the - operation.

impl<'a, F: Float> Sub<Angle<F>> for &'a Angle<F>

type Output = <Angle<F> as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: Angle<F>) -> <Angle<F> as Sub<Angle<F>>>::Output

Performs the - operation.

impl<F: Float> Sub for Angle<F>

type Output = Angle<F>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<F: Float> SubAssign<&Angle<F>> for Angle<F>

fn sub_assign(&mut self, other: &Angle<F>)

Performs the -= operation.

impl<F: Float> SubAssign for Angle<F>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<F: Float + Sum> Sum for Angle<F>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<F: Copy> Copy for Angle<F>

impl<F: Eq> Eq for Angle<F>

impl<F> StructuralPartialEq for Angle<F>