Struct geod_types::DecimalDegree

pub struct DecimalDegree { /* fields omitted */ }

High-precision (10^-7 degrees) and compact (32 bits) angular type.

The length of the Earth’s equator arc second is roughly 30m, so we need smaller units to represent smaller things.

The current precision (10^-7 degrees) can represent things about 11 mm on the equator. https://en.wikipedia.org/wiki/Decimal_degrees#Precision

Implementations

impl DecimalDegree

pub fn with_dms(
    degree: u16,
    minutes: u8,
    seconds: u8,
    milli_seconds: u16
) -> Result<Self, AngleNotInRange>

Degree, minute, second, centisecond.

Errors

When some part of the angle is out of scope (e.g. minutes > 60 or degree > 360), the AngleNotInRange returned.

pub fn degrees(self) -> u16

The whole number of degrees in the angle

pub const fn deg_fract(self) -> u32

The fractional part of the angle represented in the small units (10^-7 degrees)

pub fn arc_minutes(self) -> u8

The arc minutes component of the angle.

pub fn arc_seconds(self) -> u8

The arc seconds component of the angle.

pub fn milli_arc_seconds(self) -> u16

The milli arc seconds (1/1000-th of the arc second) component of the angle.

Use with caution! The overflow of 0.999_999_9 degrees intentionally handled incorrectly to keep the degrees value valid. To get the accurate value in such a boundary condition, use deg_min_sec_mas instead.

pub fn deg_min_sec_mas(self) -> (u16, u8, u8, u16)

Parts of the angle as in the DMS scheme.

There is a corner case when the degree part returned is not the same as the result of degrees(): when the angle’s value is too close to a whole degree in terms of internal representation, but still slightly less than it.

However, in terms of the DMS, it is already represented as a whole degree since the distance is too small to be represented in DMS scheme.

 let a = DecimalDegree::try_from(35.9999999).unwrap();

 assert_eq!(a.degrees(), 35);
 assert_eq!(a.arc_minutes(), 59);
 assert_eq!(a.arc_seconds(), 59);
 assert_eq!(a.milli_arc_seconds(), 999);

 // the value is closer to 36 than to 35 59'59.999"
 // and therefore rounds up
 assert_eq!(a.deg_min_sec_mas(), (36, 0, 0, 0));

pub fn almost_equal(self, rhs: Self) -> bool

As the decimal representation is 2.777 times more precise, a gap may appear when converting to the DMS representation

Trait Implementations

impl Add<DecimalDegree> for DecimalDegree

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Angle for DecimalDegree

type NumErr = AngleNotInRange

The error that can appear when representing some part of the angle with a number

type ParseErr = ParseAngleError

The error that can appear while parsing the angle from a string

fn obtuse_err() -> Self::NumErr

Produce an error variant indicating an angle is more than the right one

fn reflex_err() -> Self::NumErr

Produce an error variant indicating an angle is reflex

fn turn_err() -> Self::NumErr

Produce an error variant indicating an angle does not fall into full circle

fn complement(self) -> Option<Self>

Adjacent angle which sum to a right angle

fn supplement(self) -> Option<Self>

Adjacent angle which sum to a straight angle

fn explement(self) -> Self

Adjacent angle which sum to a complete angle

fn abs_diff(self, rhs: Self) -> Self

Difference between the angles by modulo independent of the order

fn turn_eq(self, other: Self) -> bool

Is the other angle differs by an exact multiple of a full turn

fn and_not_obtuse(self) -> Result<Self, Self::NumErr>

Check the angle is less than or equal to the right one

fn and_not_reflex(self) -> Result<Self, Self::NumErr>

Check the angle is less than or equal to the straight one

impl AngleNames for DecimalDegree

fn zero() -> Self

No angle

fn right() -> Self

The angle made of perpendicular rays

fn straight() -> Self

The angle made of two exactly opposite direction

fn complete() -> Self

The angle made of full circle (perigon)

fn is_zero(self) -> bool

No angle

fn is_acute(self) -> bool

Is the angle sharp?

fn is_right(self) -> bool

Are the lines perpendicular?

fn is_obtuse(self) -> bool

Is the angle blunt?

fn is_straight(self) -> bool

Is the angle forms a straight line?

fn is_reflex(self) -> bool

Is the angle more than a straight line?

fn is_complete(self) -> bool

Is the angle full round?

impl CheckedAdd for DecimalDegree

fn checked_add(&self, rhs: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedSub for DecimalDegree

fn checked_sub(&self, rhs: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for DecimalDegree

fn clone(&self) -> DecimalDegree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DecimalDegree

impl Debug for DecimalDegree

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

Formats the value using the given formatter.

impl Default for DecimalDegree

fn default() -> DecimalDegree

Returns the “default value” for a type.

impl Display for DecimalDegree

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

Formats the value using the given formatter.

impl Eq for DecimalDegree

impl FromStr for DecimalDegree

type Err = ParseAngleError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Into<f64> for DecimalDegree

fn into(self) -> f64

Performs the conversion.

impl Ord for DecimalDegree

fn cmp(&self, other: &DecimalDegree) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DecimalDegree> for DecimalDegree

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<DecimalDegree> for DecimalDegree

fn partial_cmp(&self, other: &DecimalDegree) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub 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 StructuralEq for DecimalDegree

impl StructuralPartialEq for DecimalDegree

impl Sub<DecimalDegree> for DecimalDegree

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<[u16; 2]> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

fn try_from(value: [u16; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u16; 3]> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

fn try_from(value: [u16; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u16; 4]> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

fn try_from(value: [u16; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(u16, u8, u8, u16)> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<(u16, u8, u8)> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<(u16, u8)> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

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

Use with caution: the floating numbers has bad precision in the fraction part

impl TryFrom<u16> for DecimalDegree

type Error = AngleNotInRange

The type returned in the event of a conversion error.

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

Performs the conversion.