geo 0.33.0

Geospatial primitives and algorithms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use num_traits::FromPrimitive;

use crate::{Bearing, CoordFloat, Point, Rhumb};

#[deprecated(
    since = "0.29.0",
    note = "Please use the `Rhumb.bearing` method from the `Bearing` trait instead"
)]
/// Returns the bearing to another Point in degrees.
///
/// Bullock, R.: Great Circle Distances and Bearings Between Two Locations, 2007.
/// (<https://dtcenter.org/met/users/docs/write_ups/gc_simple.pdf>)
pub trait RhumbBearing<T: CoordFloat + FromPrimitive> {
    /// Returns the bearing to another Point in degrees along a [rhumb line], where North is 0° and East is 90°.
    ///
    /// # Examples
    ///
    /// ```
    /// # use approx::assert_relative_eq;
    /// # #[allow(deprecated)]
    /// use geo::RhumbBearing;
    /// use geo::Point;
    ///
    /// let p_1 = Point::new(9.177789688110352, 48.776781529534965);
    /// let p_2 = Point::new(9.274348757829898, 48.84037308229984);
    /// # #[allow(deprecated)]
    /// let bearing = p_1.rhumb_bearing(p_2);
    /// assert_relative_eq!(bearing, 45., epsilon = 1.0e-6);
    /// ```
    /// [rhumb line]: https://en.wikipedia.org/wiki/Rhumb_line
    fn rhumb_bearing(&self, point: Point<T>) -> T;
}

#[allow(deprecated)]
impl<T> RhumbBearing<T> for Point<T>
where
    T: CoordFloat + FromPrimitive,
{
    fn rhumb_bearing(&self, point: Point<T>) -> T {
        Rhumb.bearing(*self, point)
    }
}

#[cfg(test)]
mod test {
    #[allow(deprecated)]
    use crate::RhumbBearing;
    #[allow(deprecated)]
    use crate::RhumbDestination;
    use crate::point;

    #[test]
    fn north_bearing() {
        let p_1 = point!(x: 9., y: 47.);
        let p_2 = point!(x: 9., y: 48.);
        #[allow(deprecated)]
        let bearing = p_1.rhumb_bearing(p_2);
        assert_relative_eq!(bearing, 0.);
    }

    #[test]
    fn equatorial_east_bearing() {
        let p_1 = point!(x: 9., y: 0.);
        let p_2 = point!(x: 10., y: 0.);
        #[allow(deprecated)]
        let bearing = p_1.rhumb_bearing(p_2);
        assert_relative_eq!(bearing, 90.);
    }

    #[test]
    fn east_bearing() {
        let p_1 = point!(x: 9., y: 10.);
        let p_2 = point!(x: 18.131938299366652, y: 10.);

        #[allow(deprecated)]
        let bearing = p_1.rhumb_bearing(p_2);
        assert_relative_eq!(bearing, 90.);
    }

    #[test]
    fn northeast_bearing() {
        let p_1 = point!(x: 9.177789688110352f64, y: 48.776781529534965);
        let p_2 = point!(x: 9.274348757829898, y: 48.84037308229984);
        #[allow(deprecated)]
        let bearing = p_1.rhumb_bearing(p_2);
        assert_relative_eq!(bearing, 45., epsilon = 1.0e-6);
    }

    #[test]
    fn consistent_with_destination() {
        let p_1 = point!(x: 9.177789688110352f64, y: 48.776781529534965);
        #[allow(deprecated)]
        let p_2 = p_1.rhumb_destination(45., 10000.);

        #[allow(deprecated)]
        let b_1 = p_1.rhumb_bearing(p_2);
        assert_relative_eq!(b_1, 45., epsilon = 1.0e-6);
    }
}