Skip to main content

Angle

use_trigonometry

Struct Angle 

Source 
pub struct Angle { /* private fields */ }
Expand description

Explicit angle value stored in radians.

Implementations§

Source§

impl Angle

Source

pub const fn from_radians(radians: f64) -> Self

Creates an angle from a radians value.

Source

pub const fn from_degrees(degrees: f64) -> Self

Creates an angle from a degrees value.

Examples found in repository?
examples/basic_usage.rs (line 6)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub const fn radians(self) -> f64

Returns the angle in radians.

Examples found in repository?
examples/basic_usage.rs (line 10)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub const fn degrees(self) -> f64

Returns the angle in degrees.

Examples found in repository?
examples/basic_usage.rs (line 11)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub fn normalized(self) -> Self

Returns the angle normalized into the interval [0, 2π).

Examples found in repository?
examples/basic_usage.rs (line 7)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub fn normalized_signed(self) -> Self

Returns the angle normalized into the interval (-π, π].

Examples found in repository?
examples/basic_usage.rs (line 8)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub fn sin(self) -> f64

Returns the sine of the angle.

Examples found in repository?
examples/basic_usage.rs (line 12)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub fn cos(self) -> f64

Returns the cosine of the angle.

Examples found in repository?
examples/basic_usage.rs (line 13)
5fn main() {
6    let acute = Angle::from_degrees(30.0);
7    let wrapped = Angle::from_degrees(765.0).normalized();
8    let signed = Angle::from_degrees(-450.0).normalized_signed();
9
10    assert!((acute.radians() - degrees_to_radians(30.0)).abs() < 1.0e-12);
11    assert!((acute.degrees() - radians_to_degrees(acute.radians())).abs() < 1.0e-12);
12    assert!((acute.sin() - 0.5).abs() < 1.0e-12);
13    assert!((acute.cos() - cos_deg(30.0)).abs() < 1.0e-12);
14    assert!((wrapped.degrees() - 45.0).abs() < 1.0e-12);
15    assert!((signed.degrees() + 90.0).abs() < 1.0e-12);
16    assert!((normalize_degrees(-90.0) - 270.0).abs() < 1.0e-12);
17    assert!((sin_deg(30.0) - 0.5).abs() < 1.0e-12);
18    assert!((tan_deg(45.0) - 1.0).abs() < 1.0e-12);
19}
Source

pub fn tan(self) -> f64

Returns the tangent of the angle.

Source

pub fn sin_cos(self) -> (f64, f64)

Returns the sine and cosine of the angle as a pair.

Trait Implementations§

Source§

impl Clone for Angle

Source§

fn clone(&self) -> Angle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Angle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Angle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Angle

Source§

impl StructuralPartialEq for Angle

Auto Trait Implementations§

§

impl Freeze for Angle

§

impl RefUnwindSafe for Angle

§

impl Send for Angle

§

impl Sync for Angle

§

impl Unpin for Angle

§

impl UnsafeUnpin for Angle

§

impl UnwindSafe for Angle

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.