Struct AngularDistance 

pub struct AngularDistance<T>(/* private fields */);

An angular distance.

This type stores the cosine of the angle, to avoid computing the expensive trancendental acos() function until absolutely necessary.

let zero = AngularDistance::from_cos(1.0);
let pi_2 = AngularDistance::from_cos(0.0);
let pi = AngularDistance::from_cos(-1.0);
assert!(zero < pi_2 && pi_2 < pi);

Implementations

impl<T: Real + Value> AngularDistance<T>

pub fn from_cos(value: T) -> Self

Creates an AngularDistance from the cosine of an angle.

pub fn cos(self) -> T

Get the cosine of this angle.

Trait Implementations

impl<T: Clone> Clone for AngularDistance<T>

fn clone(&self) -> AngularDistance<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for AngularDistance<T>

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

Formats the value using the given formatter.

impl Distance for AngularDistance<f32>

type Value = f32

The type of actual numerical distances.

fn value(self) -> Self::Value

Get the real numerical value of this distance.

impl Distance for AngularDistance<f64>

type Value = f64

The type of actual numerical distances.

fn value(self) -> Self::Value

Get the real numerical value of this distance.

impl From<AngularDistance<f32>> for f32

fn from(value: AngularDistance<f32>) -> f32

Converts to this type from the input type.

impl From<AngularDistance<f64>> for f64

fn from(value: AngularDistance<f64>) -> f64

Converts to this type from the input type.

impl PartialEq<AngularDistance<f32>> for f32

fn eq(&self, other: &AngularDistance<f32>) -> 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 PartialEq<AngularDistance<f64>> for f64

fn eq(&self, other: &AngularDistance<f64>) -> 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 PartialEq<f32> for AngularDistance<f32>

fn eq(&self, other: &f32) -> 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 PartialEq<f64> for AngularDistance<f64>

fn eq(&self, other: &f64) -> 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<T: PartialEq> PartialEq for AngularDistance<T>

fn eq(&self, other: &AngularDistance<T>) -> 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<AngularDistance<f32>> for f32

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

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

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

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

fn partial_cmp(&self, other: &AngularDistance<T>) -> 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 TryFrom<f32> for AngularDistance<f32>

type Error = InvalidAngleError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for AngularDistance<f64>

type Error = InvalidAngleError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy> Copy for AngularDistance<T>

impl<T: Eq> Eq for AngularDistance<T>

impl<T> StructuralPartialEq for AngularDistance<T>