rstar/primitives/
point_with_data.rs

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
use crate::{Point, PointDistance, RTreeObject, AABB};

/// A point with some associated data that can be inserted into an r-tree.
///
/// **Note**: `PointWithData` has been deprecated in favour of [`GeomWithData`](crate::primitives::GeomWithData)
///
/// Often, adding metadata (like a database index) to a point is required before adding them
/// into an r-tree. This struct removes some of the boilerplate required to do so.
///
/// # Example
/// ```
/// use rstar::{RTree, PointDistance};
/// use rstar::primitives::PointWithData;
///
/// type RestaurantLocation = PointWithData<&'static str, [f64; 2]>;
///
/// let mut restaurants = RTree::new();
/// restaurants.insert(RestaurantLocation::new("Pete's Pizza Place", [0.3, 0.2]));
/// restaurants.insert(RestaurantLocation::new("The Great Steak", [-0.8, 0.0]));
/// restaurants.insert(RestaurantLocation::new("Fishy Fortune", [0.2, -0.2]));
///
/// let my_location = [0.0, 0.0];
///
/// // Now find the closest restaurant!
/// let place = restaurants.nearest_neighbor(&my_location).unwrap();
/// println!("Let's go to {}", place.data);
/// println!("It's really close, only {} miles", place.distance_2(&my_location))
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PointWithData<T, P> {
    /// Any data associated with a point.
    pub data: T,
    point: P, // Private to prevent modification.
}

impl<T, P> PointWithData<T, P> {
    /// Creates a new `PointWithData` with the provided data.
    #[deprecated(note = "`PointWithData` is deprecated. Please switch to `GeomWithData`")]
    pub fn new(data: T, point: P) -> Self {
        PointWithData { data, point }
    }

    /// Returns this point's position.
    pub fn position(&self) -> &P {
        &self.point
    }
}

impl<T, P> RTreeObject for PointWithData<T, P>
where
    P: Point,
{
    type Envelope = AABB<P>;

    fn envelope(&self) -> Self::Envelope {
        self.point.envelope()
    }
}

impl<T, P> PointDistance for PointWithData<T, P>
where
    P: Point,
{
    fn distance_2(&self, point: &P) -> <P as Point>::Scalar {
        self.point.distance_2(point)
    }

    fn contains_point(&self, point: &P) -> bool {
        self.point.contains_point(point)
    }
}