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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
use crate::{Coordinate, DistanceUnit};
use crate::utils::{divisor};
pub struct CoordinateBoundaries {
latitude: f64,
longitude: f64,
distance: f64,
distance_unit: DistanceUnit,
max_lon: f64,
min_lon: f64,
max_lat: f64,
min_lat: f64,
}
impl CoordinateBoundaries {
/// # Summary
/// Create a new `CoordinateBoundaries` struct. Returns `None` if `Coordinate` is invalid
///
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coords = Coordinate::new(0.0, 0.0);
/// let bounds = CoordinateBoundaries::new(coords, 12.0, None);
///
/// assert!(bounds.is_some());
/// ```
pub fn new(origin: Coordinate, distance: f64, unit: Option<DistanceUnit>) -> Option<Self> {
if !Self::validate(&origin) {
return None;
}
let unit = unit.unwrap_or(DistanceUnit::Miles);
let (min_lat, max_lat, min_lon, max_lon) =
Self::calculate(&unit, distance, origin.latitude, origin.longitude);
let to_return = Self {
distance,
distance_unit: unit.clone(),
latitude: origin.latitude,
longitude: origin.longitude,
max_lat,
max_lon,
min_lat,
min_lon,
};
Some(to_return)
}
/// # Summary
/// Get the max longitude for the coords bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coord = Coordinate::new(0.0, 0.0);
/// let bounds = CoordinateBoundaries::new(coord, 1.0, None).unwrap();
///
/// let max_lon = bounds.max_longitude();
/// assert_eq!(max_lon, 0.014492753623188406);
/// ```
pub fn max_longitude(&self) -> f64 {
self.max_lon
}
/// # Summary
/// Get the min longitude for the coords bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coord = Coordinate::new(0.0, 0.0);
/// let bounds = CoordinateBoundaries::new(coord, 1.0, None).unwrap();
///
/// let min_lon = bounds.min_longitude();
/// assert_eq!(min_lon, -0.014492753623188406);
/// ```
pub fn min_longitude(&self) -> f64 {
self.min_lon
}
/// # Summary
/// Get the max latitude for the coords bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coord = Coordinate::new(0.0, 0.0);
/// let bounds = CoordinateBoundaries::new(coord, 1.0, None).unwrap();
///
/// let max_lat = bounds.max_latitude();
/// assert_eq!(max_lat, 0.014492753623188406);
/// ```
pub fn max_latitude(&self) -> f64 {
self.max_lat
}
/// # Summary
/// Get the min latitude for the coords bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coord = Coordinate::new(0.0, 0.0);
/// let bounds = CoordinateBoundaries::new(coord, 1.0, None).unwrap();
///
/// let min_lat = bounds.min_latitude();
/// assert_eq!(min_lat, -0.014492753623188406);
/// ```
pub fn min_latitude(&self) -> f64 {
self.min_lat
}
/// # Summary
/// Sets the coordinates used to calculate bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coords = Coordinate::new(0.0, 0.0);
/// let mut bounds = CoordinateBoundaries::new(coords, 1.0, None).unwrap();
/// let min_lat = bounds.min_latitude();
///
/// bounds.set_coords(Coordinate::new(1.0, 1.5));
/// let new_min_lat = bounds.min_latitude();
///
/// assert_ne!(min_lat, new_min_lat);
/// ```
pub fn set_coords(&mut self, coords: Coordinate) {
self.latitude = coords.latitude;
self.longitude = coords.longitude;
let (min_lat, max_lat, min_lon, max_lon) = Self::calculate(
&self.distance_unit,
self.distance,
coords.latitude,
coords.longitude,
);
self.min_lat = min_lat;
self.max_lat = max_lat;
self.min_lon = min_lon;
self.max_lon = max_lon;
}
/// # Summary
/// Sets the distance and optionally the distance unit to calculate bounds
/// # Example
/// ```rust
/// use geolocation_utils::{Coordinate, CoordinateBoundaries};
///
/// let coords = Coordinate::new(0.0, 0.0);
/// let mut bounds = CoordinateBoundaries::new(coords, 1.0, None).unwrap();
/// let min_lat = bounds.min_latitude();
///
/// bounds.set_distance(12.0, None);
/// let new_min_lat = bounds.min_latitude();
///
/// assert_ne!(min_lat, new_min_lat);
/// ```
pub fn set_distance(&mut self, distance: f64, unit: Option<DistanceUnit>) {
self.distance = distance;
self.distance_unit = unit.unwrap_or(DistanceUnit::Miles);
let (min_lat, max_lat, min_lon, max_lon) = Self::calculate(
&self.distance_unit,
self.distance,
self.latitude,
self.longitude,
);
self.min_lat = min_lat;
self.max_lat = max_lat;
self.min_lon = min_lon;
self.max_lon = max_lon;
}
/// # Summary
/// Calculate min_lat, max_lat, min_lon, and max_lon bounds
fn calculate(unit: &DistanceUnit, distance: f64, lat: f64, lon: f64) -> (f64, f64, f64, f64) {
let divisor = divisor(unit);
let latitude_conversion_factor = distance / divisor;
let longitude_conversion_factor = distance / divisor / lat.to_radians().cos().abs();
let min_latitude = lat - latitude_conversion_factor;
let max_latitude = lat + latitude_conversion_factor;
let min_longitude = lon - longitude_conversion_factor;
let max_longitude = lon + longitude_conversion_factor;
(min_latitude, max_latitude, min_longitude, max_longitude)
}
fn validate(coord: &Coordinate) -> bool {
if coord.latitude < -90.0 || coord.latitude > 90.0 {
return false;
}
if coord.longitude < -180.0 || coord.longitude > 180.0 {
return false;
}
return true;
}
}