Struct Radians

pub struct Radians(pub f64);

The Radians newtype an f64.

Tuple Fields

0: f64

Implementations

impl Radians

pub fn abs(self) -> Self

The absolute value of the angle.

pub fn opposite(self) -> Self

The opposite angle on the circle, i.e. +/- PI.

pub const fn clamp(self, max_value: Self) -> Self

Clamp value into the range: 0.0..=max_value.

Examples

use angle_sc::Radians;

let value = Radians(-f64::EPSILON);
assert_eq!(Radians(0.0), value.clamp(Radians(1.0)));
let value = Radians(0.0);
assert_eq!(Radians(0.0), value.clamp(Radians(1.0)));
let value = Radians(1.0);
assert_eq!(Radians(1.0), value.clamp(Radians(1.0)));
let value = Radians(1.0 + f64::EPSILON);
assert_eq!(Radians(1.0), value.clamp(Radians(1.0)));

Trait Implementations

impl Add for Radians

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

Add a pair of angles in Radians, wraps around +/-PI. Uses the 2Sum algorithm to reduce round-off error.

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 * f64::EPSILON));

type Output = Radians

The resulting type after applying the + operator.

impl AddAssign for Radians

fn add_assign(&mut self, other: Self)

Performs the += operation.

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 Default for Radians

fn default() -> Self

Returns the “default value” for a type.

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.

Examples:

use angle_sc::{Angle, Radians, trig};

let angle = Angle::from(Radians(-core::f64::consts::FRAC_PI_6));
assert_eq!(-0.5, angle.sin().0);
assert_eq!(trig::COS_30_DEGREES, angle.cos().0);
assert_eq!(-core::f64::consts::FRAC_PI_6, Radians::from(angle).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

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 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

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 Sub for Radians

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

Subtract a pair of angles in Radians, wraps around +/-PI. Uses the 2Sum algorithm to reduce round-off error.

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 * f64::EPSILON));

type Output = Radians

The resulting type after applying the - operator.

impl SubAssign for Radians

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Radians

impl StructuralPartialEq for Radians