Struct Angle

pub struct Angle { /* private fields */ }

Implements an angle structure where angles are stored as integers.

Also keeps track of if the angle is going clockwise or counter-clockwise. It also stores a full circle different from a 0 degree arc. This gets rid of precision issues when storing angles as pi can be represented exactly if you change the units.

Implementations

impl Angle

pub fn is_zero(&self) -> bool

Is this angle zero?

use integer_angles::Angle;

assert!(Angle::zero().is_zero());
assert!(!Angle::pi().is_zero());

pub fn pi_over(n: i64) -> Angle

Divide pi by some number, and return the result

use integer_angles::Angle;

assert_eq!(Angle::pi_over(2) * 2, Angle::pi());

pub fn set_clockwise(&self, clockwise: bool) -> Angle

Don’t change the direction of the angle, but possibly change the direction to get to that angle.

use integer_angles::Angle;

assert_eq!(Angle::pi_over(2).set_clockwise(true), -3 * Angle::pi_over(2));

pub fn add_or_subtract(&self, add: bool, other: Angle) -> Angle

Add or subtract an angle depending on the value of the add boolean.

use integer_angles::Angle;

assert_eq!(Angle::pi() + Angle::pi(), Angle::pi().add_or_subtract(true, Angle::pi()));
assert_eq!(Angle::pi() - Angle::pi(), Angle::pi().add_or_subtract(false, Angle::pi()));

pub fn zero() -> Angle

Create a 0-degree angle

use integer_angles::Angle;

assert_eq!(Angle::zero() * 2, Angle::zero());

pub fn wrapping_eq(&self, other: Angle) -> bool

Determine if the angles are equal while allowing wrapping (meaning, 0 == 2pi).

use integer_angles::Angle;

assert!(Angle::zero().wrapping_eq(Angle::two_pi()));
assert!(Angle::pi().wrapping_eq(-Angle::pi()));

pub fn wrapping_approx_eq(&self, other: Angle, error: Angle) -> bool

pub fn length<T: RealField>(&self, radius: T) -> T

Get the length of this as an arc given a specific radius

use integer_angles::Angle;
use nalgebra::RealField;

assert_eq!(Angle::zero().length(1.0f64), 0.0f64);
assert_eq!(Angle::two_pi().length(1.0f64), f64::two_pi());
assert_eq!(Angle::pi_2().length(1.0f64), f64::frac_pi_2());

pub fn pi_2() -> Angle

Create an angle of pi over two counter-clockwise (for convenience).

use integer_angles::Angle;

assert_eq!(Angle::pi_2(), Angle::pi_over(2));
assert_eq!(Angle::pi_2() * 2, Angle::pi());

pub fn pi() -> Angle

Create an angle of pi counter-clockwise.

use integer_angles::Angle;

assert_eq!(Angle::pi() / 2, Angle::pi_2());

pub fn two_pi() -> Angle

Create an angle that is two_pi radians counter-clockwise.

use integer_angles::Angle;

assert_eq!(Angle::two_pi() * 2, Angle::pi() * 2);

pub fn units(&self) -> Option<u64>

Get the number of units in this angle. This will be some number between 0 and 2^64 - 1 where a full circle is 2^64 units. If this represents a full cirle, None will be returned.

use integer_angles::Angle;

assert_eq!(Angle::zero().units(), Some(0));
assert_eq!(Angle::two_pi().units(), None);

pub fn clockwise(&self) -> bool

Is this angle clockwise or counter-clockwise?

use integer_angles::Angle;

assert_eq!(Angle::pi().clockwise(), false);
assert_eq!((-Angle::pi()).clockwise(), true);

pub fn to_i64(&self) -> i64

Returns the angle as an i64 (for doing math), and wrap 2pi to 0. If clockwise, return the negative of the result.

use integer_angles::Angle;

assert_eq!(Angle::pi().to_i64(), i64::min_value());
assert_eq!(Angle::two_pi().to_i64(), 0);
assert_eq!(-Angle::pi_2().to_i64(), i64::min_value() / 2);
assert_eq!(Angle::pi_2().to_i64(), -(i64::min_value() / 2));

pub fn cos<T: RealField>(&self) -> T

Returns the cosine of the angle.

use integer_angles::Angle;

assert_eq!(Angle::zero().cos::<f64>(), 1.0f64);
assert_eq!(Angle::pi_2().cos::<f64>(), 0.0f64);
assert_eq!(Angle::pi().cos::<f64>(), -1.0f64);
assert_eq!((Angle::pi_2() * 3).cos::<f64>(), 0.0f64);
assert_eq!(Angle::two_pi().cos::<f64>(), 1.0f64);

pub fn sin<T: RealField>(&self) -> T

Returns the cosine of the angle.

use integer_angles::Angle;

assert_eq!(Angle::zero().sin::<f64>(), 0.0f64);
assert_eq!(Angle::pi_2().sin::<f64>(), 1.0f64);
assert_eq!(Angle::pi().sin::<f64>(), 0.0f64);
assert_eq!((3 * Angle::pi_2()).sin::<f64>(), -1.0f64);
assert_eq!(Angle::two_pi().sin::<f64>(), 0.0f64);

pub fn tan<T: RealField>(&self) -> T

Returns the tangent of the angle.

use integer_angles::Angle;

assert_eq!(Angle::pi_over(4).tan::<f64>(), 1.0f64);

pub fn acos<T: RealField>(x: T) -> Angle

Compute the arccos of the number.

use integer_angles::Angle;

assert_eq!(Angle::acos(0.0f64), Angle::pi_over(2));

pub fn asin<T: RealField>(x: T) -> Angle

Compute the arcsin of the number.

use integer_angles::Angle;

assert_eq!(Angle::asin(0.5f64).sin::<f64>(), 0.5f64);

pub fn atan<T: RealField>(x: T) -> Angle

Compute the arctan of the number.

use integer_angles::Angle;

assert_eq!(Angle::atan(1.0f64), Angle::pi_over(4));

pub fn atan2<T: RealField>(y: T, x: T) -> Option<Angle>

Compute the atan(y / x) but keeping the sign of y and x.

Returns None if both y and x are 0.

use integer_angles::Angle;

assert_eq!(Angle::atan2(1.0f64, 0.0).unwrap(), Angle::pi_2());
assert_eq!(Angle::atan2(0.0, 0.0f64), None);

pub fn radians<T: RealField>(self) -> T

Convert the angle into radians. This can lose precision pretty easily

use integer_angles::Angle;
use nalgebra::RealField;

assert_eq!(Angle::pi().radians::<f64>(), f64::pi());

pub fn degrees<T: RealField>(self) -> T

Trait Implementations

impl Add for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Angle

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Arbitrary for Angle

fn arbitrary<G: Gen>(g: &mut G) -> Self

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

impl Clone for Angle

fn clone(&self) -> Angle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Angle

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

Formats the value using the given formatter.

impl Default for Angle

fn default() -> Angle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Angle

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<i64> for Angle

type Output = Angle

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i64> for Angle

fn div_assign(&mut self, rhs: i64)

Performs the /= operation.

impl<T: RealField> From<T> for Angle

fn from(real: T) -> Angle

Convert from radians into an angle. Panics if NaN or infinity is received

use integer_angles::Angle;
use nalgebra::RealField;

assert_eq!(Angle::from(f64::pi()), Angle::pi());

impl Mul<Angle> for i64

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, rhs: Angle) -> Angle

Performs the * operation.

impl Mul<i64> for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i64> for Angle

fn mul_assign(&mut self, rhs: i64)

Performs the *= operation.

impl Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Angle

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Angle

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

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

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 Serialize for Angle

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Angle

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Angle

impl Eq for Angle

impl StructuralPartialEq for Angle