Struct angle_sc::Radians

pub struct Radians(pub f64);

The Radians newtype an f64.

Tuple Fields

0: f64

Implementations

impl Radians

pub fn normalise(&self) -> Self

Normalise a Radians into the range: -PI < value <= PI

Examples

use angle_sc::Radians;

assert_eq!(0.0, Radians(-core::f64::consts::TAU).normalise().0);
assert_eq!(core::f64::consts::PI, Radians(-core::f64::consts::PI).normalise().0);
assert_eq!(core::f64::consts::PI, Radians(core::f64::consts::PI).normalise().0);
assert_eq!(0.0, Radians(core::f64::consts::TAU).normalise().0);

Trait Implementations

impl Add for Radians

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

Add a pair of angles in Radians, wraps around +/-PI.

Examples

use angle_sc::{Radians, is_within_tolerance};

let angle_120 = Radians(2.0 * core::f64::consts::FRAC_PI_3);
let result = angle_120 + angle_120;
assert!(is_within_tolerance(-2.0 * core::f64::consts::FRAC_PI_3, result.0,  4.0 * core::f64::EPSILON));

type Output = Radians

The resulting type after applying the + operator.

impl Clone for Radians

fn clone(&self) -> Radians

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Radians

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

Formats the value using the given formatter.

impl From<Angle> for Radians

fn from(a: Angle) -> Self

Convert an Angle to Radians.

impl From<Radians> for Angle

fn from(a: Radians) -> Self

Construct an Angle from an angle in Radians.
In order to minimize round-off errors, this function calculates sines of angles with sine values <= 1 / sqrt(2)

impl From<Radians> for Degrees

fn from(a: Radians) -> Self

Create an angle in Degrees from an angle in Radians.

Examples

use angle_sc::{Degrees, Radians};

let arg = Radians(core::f64::consts::FRAC_PI_2);
let answer = Degrees::from(arg);
assert_eq!(90.0, answer.0);

impl Neg for Radians

fn neg(self) -> Self

An implementation of Neg for Radians, i.e. -angle.

Examples

use angle_sc::Radians;

let angle_45 = Radians(core::f64::consts::FRAC_PI_4);
let result_m45 = -angle_45;
assert_eq!(-core::f64::consts::FRAC_PI_4, result_m45.0);

type Output = Radians

The resulting type after applying the - operator.

impl PartialEq for Radians

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

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

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

Subtract a pair of angles in Radians, wraps around +/-PI.

Examples

use angle_sc::{Radians, is_within_tolerance};

let angle_120 = Radians(2.0 * core::f64::consts::FRAC_PI_3);
let angle_m120 = -angle_120;
let result = angle_m120 - angle_120;
assert!(is_within_tolerance(angle_120.0, result.0,  4.0 * core::f64::EPSILON));

type Output = Radians

The resulting type after applying the - operator.

impl Copy for Radians

impl StructuralPartialEq for Radians