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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
use crate::metric::HaversineDistance;
use crate::models::{LatLngCoord, Neighbor, ObjectIdentifier};
use ahash::AHasher;
use geohash::GeohashError;
use hashbrown::hash_table::Entry;
use hashbrown::{HashSet, HashTable};
use kiddo::distance_metric::DistanceMetric;
use kiddo::KdTree;
use log::debug;
use patricia_tree::StringPatriciaMap;
use rayon::prelude::*;
use std::hash::{BuildHasher, BuildHasherDefault};

#[inline]
fn build_search_space(
    prefix_tree: &StringPatriciaMap<HashSet<ObjectIdentifier>>,
    subregion_hash: &str,
) -> KdTree<f64, 2> {
    let mut search_tree = KdTree::new();

    // ? locate nearby geohashes and populate spatial index
    debug!("building kd-tree for region: {}", &subregion_hash);

    for (ghash, members) in prefix_tree.iter_prefix(subregion_hash) {
        if let Ok((position, _, _)) = geohash::decode(&ghash) {
            members.into_iter().for_each(|id: &ObjectIdentifier| {
                debug!("adding object to kd-tree: id={} geohash={}", id, ghash);
                // ? geohash position uses (lng, lat)
                search_tree.add(&[position.y, position.x], *id);
            });
        }
    }

    search_tree
}

#[derive(Clone, Default)]
pub struct SpatialIndex {
    /// maps geohash to common objects
    prefix_tree: StringPatriciaMap<HashSet<ObjectIdentifier>>,
    /// maps object key, geohash to hash id (object id)
    position_map: HashTable<[String; 2]>,
    /// internal hasher
    hasher: BuildHasherDefault<AHasher>,
}

impl SpatialIndex {
    /// determines the maximum number of elements the spatial index can hold before it needs to reallocate.
    pub const MAX_CAPACITY: usize = u16::MAX as usize;

    pub fn new(capacity: usize) -> Self {
        let position_map = {
            if capacity.gt(&Self::MAX_CAPACITY) {
                HashTable::with_capacity(Self::MAX_CAPACITY)
            } else {
                HashTable::with_capacity(capacity)
            }
        };
        Self {
            position_map,
            ..Default::default()
        }
    }

    /// Insert key into index at some geographical location
    pub fn insert(&mut self, key: &str, ghash: &str) {
        let id: ObjectIdentifier = self.hasher.hash_one(key);
        // ? remove object from previous locations
        if let Entry::Occupied(entry) = self.position_map.entry(
            id,
            |[key, _]| key.eq(key),
            |[key, _]| self.hasher.hash_one(key),
        ) {
            let ([_, old_ghash], _) = entry.remove();
            debug!(
                "removing object from previous ghash: id={} geohash={}",
                id, &old_ghash
            );
            if let Some(prev_members) = self.prefix_tree.get_mut(&old_ghash) {
                prev_members.remove(&id);
            } else {
                self.prefix_tree.remove(old_ghash);
            }
        }
        // ? update position_map & prefix_tree
        debug!("storing object: id={} key={}", id, key);

        self.position_map
            .insert_unique(id, [key.to_owned(), ghash.into()], |[key, _]| {
                self.hasher.hash_one(key)
            });
        // ? insert current region into prefix tree
        if let Some(members) = self.prefix_tree.get_mut(ghash) {
            members.insert(id);
        } else {
            self.prefix_tree.insert(ghash, HashSet::from([id]));
        };
    }

    /// insert multiple objects at once
    pub fn insert_many(&mut self, objects: impl IntoIterator<Item = (String, String)>) {
        objects
            .into_iter()
            .for_each(|(key, ghash)| self.insert(&key, &ghash));
    }

    /// Remove key from index
    pub fn remove(&mut self, key: &str) -> bool {
        let id: ObjectIdentifier = self.hasher.hash_one(key);
        if let Entry::Occupied(entry) = self.position_map.entry(
            id,
            |[key, _]| key.eq(key),
            |[key, _]| self.hasher.hash_one(key),
        ) {
            let ([_, ghash], _) = entry.remove();
            if let Some(members) = self.prefix_tree.get_mut(&ghash) {
                members.remove(&id);
                if members.is_empty() {
                    self.prefix_tree.remove(&ghash);
                }
            }
        }
        true
    }

    /// remove multiple objects at once
    pub fn remove_many(&mut self, keys: HashSet<String>) -> bool {
        // returns false if any failed
        keys.iter().fold(true, |_, key| self.remove(key))
    }

    /// search for objects within the area of some location
    pub fn search(
        &self,
        origin: LatLngCoord,
        radius: f64,
        count: usize,
        sorted: bool,
        search_depth: usize,
    ) -> Result<Vec<Neighbor>, GeohashError> {
        if self.position_map.is_empty() || count.eq(&0) {
            return Ok(vec![]);
        }
        let search_region: String = {
            // ? geohash crate uses (lng, lat) convention
            let mut ghash = geohash::encode([origin[1], origin[0]].into(), search_depth)?;
            // ? truncate subregion hash until it contains the radius
            while ghash.len().gt(&1) {
                let (point, _, _) = geohash::decode(&ghash)?;
                if HaversineDistance::dist(&origin, &[point.y, point.x]).gt(&radius) {
                    break;
                } else {
                    ghash.pop();
                }
            }
            ghash
        };

        // ? compute nearest neighbors
        let neighbors: Vec<Neighbor> = build_search_space(&self.prefix_tree, &search_region)
            .nearest_n_within::<HaversineDistance>(&origin, radius, count, sorted)
            .par_iter()
            .filter_map(|node| {
                self.position_map
                    .find(node.item, |[key, _]| {
                        self.hasher.hash_one(key).eq(&node.item)
                    })
                    .map(|[key, _]| Neighbor {
                        distance: node.distance,
                        key: key.to_owned(),
                    })
            })
            .collect();
        Ok(neighbors)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use rand::prelude::*;

    const DEFAULT_DEPTH: usize = 10;

    fn encode_lat_lng([lat, lng]: LatLngCoord, depth: usize) -> String {
        geohash::encode([lng, lat].into(), depth).unwrap()
    }

    #[test]
    fn can_upsert() {
        let mut geo_index = SpatialIndex::default();
        let insert_depth = 6;
        let range = 1.0;
        let origin: LatLngCoord = [0.0, 0.0];
        let key = "test-key";

        // place key within the search area
        geo_index.insert(key, &encode_lat_lng(origin, insert_depth));

        let res = geo_index
            .search(origin, range, 100, false, DEFAULT_DEPTH)
            .unwrap();
        assert_eq!(res.len(), 1);

        // move key out of search area
        geo_index.insert(key, &encode_lat_lng([-70.0, 100.0], insert_depth));

        let res = geo_index
            .search(origin, range, 100, false, DEFAULT_DEPTH)
            .unwrap();
        assert_eq!(res.len(), 0);

        // move key back into search area
        geo_index.insert(key, &encode_lat_lng(origin, insert_depth));

        let res = geo_index
            .search(origin, range, 100, false, DEFAULT_DEPTH)
            .unwrap();
        assert_eq!(res.len(), 1);
    }

    #[test]
    fn can_remove() {
        let mut geo_index = SpatialIndex::default();
        let depth = 6;
        let range = 10.0;
        let origin: LatLngCoord = [0.0, 0.0];

        geo_index.insert(&"a", &encode_lat_lng(origin, depth));
        geo_index.insert(&"b", &encode_lat_lng(origin, depth));

        let res = geo_index
            .search(origin, range, 100, false, DEFAULT_DEPTH)
            .unwrap();
        assert_eq!(res.len(), 2);

        geo_index.remove(&"a");
        geo_index.remove(&"b");

        let res = geo_index
            .search(origin, range, 100, false, DEFAULT_DEPTH)
            .unwrap();
        assert_eq!(res.len(), 0);
    }

    #[test]
    fn can_search() {
        let mut geo_index = SpatialIndex::default();
        let depth: usize = 6;
        let range = 1000.0;
        let count = 100;
        let sorted = false;
        let origin: LatLngCoord = [0.0, 0.0];

        geo_index.insert_many(vec![
            ("a".to_string(), encode_lat_lng([1.0, 0.0], depth)),
            ("b".to_string(), encode_lat_lng([1.0, 1.0], depth)),
            ("c".to_string(), encode_lat_lng([0.0, 1.0], depth)),
            ("d".to_string(), encode_lat_lng([0.0, 0.0], depth)),
            ("e".to_string(), encode_lat_lng([-1., 0.0], depth)),
            ("f".to_string(), encode_lat_lng([-1.0, -1.0], depth)),
            ("g".to_string(), encode_lat_lng([0.0, -1.0], depth)),
            ("h".to_string(), encode_lat_lng([0.0, 0.0], depth)),
        ]);

        let res = geo_index
            .search(origin, range, count, sorted, DEFAULT_DEPTH)
            .unwrap();

        res.iter().for_each(|neighbor| {
            assert!(neighbor.distance <= range);
        });
    }

    #[test]
    fn can_search_count() {
        let mut geo_index = SpatialIndex::default();
        let depth: usize = 6;
        let range = 1000.0;
        let count = 5;
        let sorted = false;
        let origin: LatLngCoord = [0.0, 0.0];

        geo_index.insert_many(vec![
            ("a".to_string(), encode_lat_lng([1.0, 0.0], depth)),
            ("b".to_string(), encode_lat_lng([1.0, 1.0], depth)),
            ("c".to_string(), encode_lat_lng([0.0, 1.0], depth)),
            ("d".to_string(), encode_lat_lng([0.0, 0.0], depth)),
            ("e".to_string(), encode_lat_lng([-1., 0.0], depth)),
            ("f".to_string(), encode_lat_lng([-1.0, -1.0], depth)),
            ("g".to_string(), encode_lat_lng([0.0, -1.0], depth)),
            ("h".to_string(), encode_lat_lng([0.0, 0.0], depth)),
        ]);

        let res = geo_index
            .search(origin, range, count, sorted, DEFAULT_DEPTH)
            .unwrap();
        assert!(res.len() <= count);
    }

    #[test]
    fn can_search_sorted_count() {
        // ? see, https://github.com/sdd/kiddo/issues/168
        let mut geo_index = SpatialIndex::default();
        let depth: usize = 6;
        let range = 1000.0;
        let origin: LatLngCoord = [0.0, 0.0];

        geo_index.insert_many(vec![
            ("a".to_string(), encode_lat_lng([1.0, 0.0], depth)),
            ("b".to_string(), encode_lat_lng([1.0, 1.0], depth)),
            ("c".to_string(), encode_lat_lng([0.0, 1.0], depth)),
            ("d".to_string(), encode_lat_lng([0.0, 0.0], depth)),
            ("e".to_string(), encode_lat_lng([-1., 0.0], depth)),
            ("f".to_string(), encode_lat_lng([-1.0, -1.0], depth)),
            ("g".to_string(), encode_lat_lng([0.0, -1.0], depth)),
            ("h".to_string(), encode_lat_lng([0.0, 0.0], depth)),
        ]);

        let count = 1;

        let res_sorted = geo_index
            .search(origin, range, count, true, DEFAULT_DEPTH)
            .unwrap();
        let res_unsorted = geo_index
            .search(origin, range, count, false, DEFAULT_DEPTH)
            .unwrap();

        assert_eq!(res_sorted.len(), count);
        assert_eq!(res_unsorted.len(), count);

        let count = 0;

        let res_sorted = geo_index
            .search(origin, range, count, true, DEFAULT_DEPTH)
            .unwrap();
        let res_unsorted = geo_index
            .search(origin, range, count, false, DEFAULT_DEPTH)
            .unwrap();

        assert_eq!(res_sorted.len(), count);
        assert_eq!(res_unsorted.len(), count);
    }

    #[test]
    fn can_search_sorted() {
        let mut geo_index = SpatialIndex::default();
        let depth: usize = 10;
        let range = 1000.0;
        let count = 100;
        let sorted = true;
        let origin: LatLngCoord = [0.0, 0.0];

        geo_index.insert_many(vec![
            ("a".to_string(), encode_lat_lng([1.0, 0.0], depth)),
            ("b".to_string(), encode_lat_lng([1.0, 1.0], depth)),
            ("c".to_string(), encode_lat_lng([0.0, 1.0], depth)),
            ("d".to_string(), encode_lat_lng([0.0, 0.0], depth)),
            ("e".to_string(), encode_lat_lng([-1., 0.0], depth)),
            ("f".to_string(), encode_lat_lng([-1.0, -1.0], depth)),
            ("g".to_string(), encode_lat_lng([0.0, -1.0], depth)),
            ("h".to_string(), encode_lat_lng([0.0, 0.0], depth)),
        ]);

        let res = geo_index
            .search(origin, range, count, sorted, DEFAULT_DEPTH)
            .unwrap();

        let mut sorted_neighbors = res.to_vec();
        sorted_neighbors.sort_by(|a, b| a.distance.partial_cmp(&b.distance).unwrap());

        assert_eq!(res, sorted_neighbors);
    }

    #[test]
    fn can_capacity() {
        let capacity = i16::MAX;
        let mut geo_index = SpatialIndex::new(capacity as usize);
        let mut rng = rand::thread_rng();
        let depth: usize = 5;
        let count = 100;
        let sorted = true;

        for n in 0..capacity {
            let (lat, lng) = (rng.gen_range(-90f64..90f64), rng.gen_range(-180f64..180f64));
            geo_index.insert(&n.to_string(), &encode_lat_lng([lat, lng], depth));
        }

        let center = [0f64, 0f64];
        let range = 200f64;

        let res = geo_index
            .search(center, range, count, sorted, DEFAULT_DEPTH)
            .unwrap();
        assert!(res.len() <= count);
        res.iter().for_each(|neighbor| {
            assert!(neighbor.distance <= range);
        });
    }
}