geohashrust 0.0.2

A Rust GeoHash Library
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

use std::ops::Sub;

// The Earth's radius in kilometers.
static EARTH_RADIUS: f64 = 6371.009;

/// A geographic location.
#[derive(Default, Clone, Copy, PartialEq)]
pub struct GeoLocation {
    /// Latitude in degrees.
    pub latitude: f64,
    /// Longitude in degrees.
    pub longitude: f64
}

impl GeoLocation {
    /// Creates a new `GeoLocation` with latitude and longitude set to
    /// zero.
    ///
    /// # Example
    ///
    /// ```
    /// let l = geohashrust::GeoLocation::new();
    /// assert_eq!(l.latitude, 0.0);
    /// assert_eq!(l.longitude, 0.0);
    /// ```
    pub fn new() -> GeoLocation {
        GeoLocation {
            latitude: 0.0,
            longitude: 0.0
        }
    }

    /// Creates a new `GeoLocation` with `latitude` and `longitude`.
    ///
    /// # Example
    ///
    /// ```
    /// let l = geohashrust::GeoLocation::from_coordinates(48.1333, 11.5667);
    /// assert_eq!(l.latitude, 48.1333);
    /// assert_eq!(l.longitude, 11.5667);
    /// ```
    pub fn from_coordinates(latitude: f64, longitude: f64) -> GeoLocation {
        assert!(latitude.abs()<=90.0);
        assert!(longitude.abs()<=180.0);
        GeoLocation {
            latitude: latitude,
            longitude: longitude
        }
    }

    /// Returns the distance between `self` and `other` in meters. The
    /// calculation is done using the Haversine formula.
    ///
    /// # Example
    ///
    /// ```
    /// let new_york = geohashrust::GeoLocation::from_coordinates(40.7127, -74.0059);
    /// let helsinki = geohashrust::GeoLocation::from_coordinates(60.1708, 24.9375);
    /// assert_eq!(new_york.distance_to(&helsinki).round(), 6618.0);
    /// ```
    pub fn distance_to(&self, other: &GeoLocation) -> f64 {
        let lat1 = self.latitude.to_radians();
        let lat2 = other.latitude.to_radians();
        let dlat = (other.latitude - self.latitude).to_radians();
        let dlon = (other.longitude - self.longitude).to_radians();

        let a = (dlat / 2.0).sin() * (dlat / 2.0).sin() +
            lat1.cos() * lat2.cos() *
            (dlon / 2.0).sin() * (dlon / 2.0).sin();
        let c = 2.0 * a.sqrt().atan2((1.0 - a).sqrt());

        EARTH_RADIUS * c
    }
}

/// Returns the distance between `self` and `other` in meters. The
/// calculation is done using the Haversine formula.
///
/// # Example
///
/// ```
/// let new_york = geohashrust::GeoLocation::from_coordinates(40.7127, -74.0059);
/// let helsinki = geohashrust::GeoLocation::from_coordinates(60.1708, 24.9375);
/// assert_eq!((new_york-helsinki).round(), 6618.0);
/// ```
impl Sub<GeoLocation> for GeoLocation {
    type Output = f64;
    fn sub(self, rhs: GeoLocation) -> f64 {
        self.distance_to(&rhs)
    }
}