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
100
101
102
103
104
105

use crate::{CoordFloat, Destination, Haversine, Point};
use num_traits::FromPrimitive;

#[deprecated(
    since = "0.29.0",
    note = "Please use the `Haversine.destination` method from the `Destination` trait instead"
)]
/// Returns a new Point using the distance to the existing Point and a bearing for the direction
///
/// *Note*: this implementation uses a mean earth radius of 6371.088 km, based on the [recommendation of
/// the IUGG](ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf)
pub trait HaversineDestination<T: CoordFloat> {
    /// Returns a new Point using distance to the existing Point and a bearing for the direction
    ///
    /// # Units
    ///
    /// - `bearing`: degrees, zero degrees is north
    /// - `distance`: meters
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[allow(deprecated)]
    /// use geo::HaversineDestination;
    /// use geo::Point;
    /// use approx::assert_relative_eq;
    ///
    /// let p_1 = Point::new(9.177789688110352, 48.776781529534965);
    /// # #[allow(deprecated)]
    /// let p_2 = p_1.haversine_destination(45., 10000.);
    /// assert_relative_eq!(p_2, Point::new(9.274409949623548, 48.84033274015048), epsilon = 1e-6)
    /// ```
    fn haversine_destination(&self, bearing: T, distance: T) -> Point<T>;
}

#[allow(deprecated)]
impl<T> HaversineDestination<T> for Point<T>
where
    T: CoordFloat + FromPrimitive,
{
    fn haversine_destination(&self, bearing: T, distance: T) -> Point<T> {
        Haversine.destination(*self, bearing, distance)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    #[allow(deprecated)]
    use crate::{HaversineBearing, HaversineDistance};
    use num_traits::pow;

    #[test]
    fn returns_a_new_point() {
        let p_1 = Point::new(9.177789688110352, 48.776781529534965);
        #[allow(deprecated)]
        let p_2 = p_1.haversine_destination(45., 10000.);
        assert_relative_eq!(
            p_2,
            Point::new(9.274409949623548, 48.84033274015048),
            epsilon = 1.0e-6
        );
        #[allow(deprecated)]
        let distance = p_1.haversine_distance(&p_2);
        assert_relative_eq!(distance, 10000., epsilon = 1.0e-6)
    }

    #[test]
    fn direct_and_indirect_destinations_are_close() {
        let p_1 = Point::new(9.177789688110352, 48.776781529534965);
        #[allow(deprecated)]
        let p_2 = p_1.haversine_destination(45., 10000.);
        let square_edge = { pow(10000., 2) / 2f64 }.sqrt();
        #[allow(deprecated)]
        let p_3 = p_1.haversine_destination(0., square_edge);
        #[allow(deprecated)]
        let p_4 = p_3.haversine_destination(90., square_edge);
        assert_relative_eq!(p_4, p_2, epsilon = 1.0e-6);
    }

    #[test]
    fn bearing_zero_is_north() {
        let p_1 = Point::new(9.177789688110352, 48.776781529534965);
        #[allow(deprecated)]
        let p_2 = p_1.haversine_destination(0., 1000.);
        assert_relative_eq!(p_1.x(), p_2.x(), epsilon = 1.0e-6);
        assert!(p_2.y() > p_1.y())
    }

    #[test]
    fn should_wrap_correctly() {
        let pt1 = Point::new(170.0, -30.0);
        let pt2 = Point::new(-170.0, -30.0);

        for (start, end) in [(pt1, pt2), (pt2, pt1)] {
            #[allow(deprecated)]
            let bearing = start.haversine_bearing(end);
            #[allow(deprecated)]
            let results: Vec<_> = (0..8)
                .map(|n| start.haversine_destination(bearing, n as f64 * 250_000.))
                .collect();
            assert!(results.iter().all(|pt| pt.x() >= -180.0 && pt.x() <= 180.0));
        }
    }
}