Struct s2::s1::angle::Angle

pub struct Angle(_);

Angle represents a 1D angle. The internal representation is a double precision value in radians, so conversion to and from radians is exact. Conversions between E5, E6, E7, and Degrees are not always exact. For example, Deg(3.1) is different from E6(3100000) or E7(310000000).

use s2::s1::angle::*;
use std::f64::consts::PI;

// The following conversions between degrees and radians are exact:
assert_eq!(Deg(180.), Deg::from(Rad(PI)));
for n in 0..9 {
    // for n == 0..8
    assert_eq!(Rad(PI/(n as f64)), Deg(180./(n as f64)).into());
}

// These identities hold when the arguments are scaled up or down by any power
// of 2. Some similar identities are also true, for example,
assert_eq!(Rad(PI/3.), Deg(60.).into());

// But be aware that this type of identity does not hold in general. For example,
assert_ne!(Rad(PI/60.), Deg(3.).into());

// Similarly, the conversion to radians means that Deg::from(Angle::from(Deg(x)))
// does not always equal x. For example,

// for n == 0..8
for n in 0..9 {
    let x = 45. * (n as f64);
    assert_eq!(Deg(x), Deg::from(Angle::from(Deg(x))));
}

// but
assert_ne!(Deg(60.), Deg::from(Angle::from(Deg(60.))));

When testing for equality, you should allow for numerical errors (float64Eq) or convert to discrete E5/E6/E7 values first.

Implementations

impl Angle

pub fn rad(&self) -> f64

rad returns the angle in radians.

pub fn deg(&self) -> f64

deg returns the angle in degrees.

pub fn inf() -> Self

inf returns an angle larger than any finite angle.

pub fn is_infinite(&self) -> bool

is_infinite reports whether this Angle is infinite.

pub fn abs(&self) -> Self

abs returns the absolute value of the angle.

pub fn normalized(&self) -> Self

normalized returns an equivalent angle in [0, 2π).

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

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

Trait Implementations

impl Add<f64> for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

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<'a> From<&'a Angle> for ChordAngle

fn from(a: &'a Angle) -> Self

returns a ChordAngle from the given Angle.

impl<'a> From<&'a Angle> for Deg

fn from(a: &Angle) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Angle> for E5

fn from(a: &Angle) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Angle> for E6

fn from(a: &Angle) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Angle> for E7

fn from(a: &Angle) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Angle> for Rad

fn from(a: &Angle) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ChordAngle> for Angle

fn from(ca: &'a ChordAngle) -> Self

converts this ChordAngle to an Angle.

impl<'a> From<&'a Deg> for Angle

fn from(a: &Deg) -> Self

Converts to this type from the input type.

impl<'a> From<&'a E5> for Angle

fn from(a: &E5) -> Self

Converts to this type from the input type.

impl<'a> From<&'a E6> for Angle

fn from(a: &E6) -> Self

Converts to this type from the input type.

impl<'a> From<&'a E7> for Angle

fn from(a: &E7) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Rad> for Angle

fn from(a: &Rad) -> Self

Converts to this type from the input type.

impl From<Angle> for ChordAngle

fn from(a: Angle) -> Self

returns a ChordAngle from the given Angle.

impl From<Angle> for Deg

fn from(a: Angle) -> Self

Converts to this type from the input type.

impl From<Angle> for E5

fn from(a: Angle) -> Self

Converts to this type from the input type.

impl From<Angle> for E6

fn from(a: Angle) -> Self

Converts to this type from the input type.

impl From<Angle> for E7

fn from(a: Angle) -> Self

Converts to this type from the input type.

impl From<Angle> for Rad

fn from(a: Angle) -> Self

Converts to this type from the input type.

impl From<ChordAngle> for Angle

fn from(ca: ChordAngle) -> Self

converts this ChordAngle to an Angle.

impl From<Deg> for Angle

fn from(a: Deg) -> Self

Converts to this type from the input type.

impl From<E5> for Angle

fn from(a: E5) -> Self

Converts to this type from the input type.

impl From<E6> for Angle

fn from(a: E6) -> Self

Converts to this type from the input type.

impl From<E7> for Angle

fn from(a: E7) -> Self

Converts to this type from the input type.

impl From<Rad> for Angle

fn from(a: Rad) -> Self

Converts to this type from the input type.

impl Mul<f64> for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Self

Performs the * operation.

impl PartialEq<Angle> for Angle

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

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

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Angle

impl StructuralPartialEq for Angle