qutee 0.2.1

A quadtree implementation
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
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

use std::fmt::{Debug, Display};

use crate::Point;

/// Trait defining methods shared by all shapes
pub trait Area<C: Coordinate>: Clone {
    /// Checks if this shape contains the given point
    fn contains(&self, point: &Point<C>) -> bool;
    /// Checks if this shape and a given boundary intersect at any point
    fn intersects(&self, boundary: &Boundary<C>) -> bool;
    /// Checks if this area fully encloses a given boundary
    fn encloses(&self, boundary: &Boundary<C>) -> bool;
}

/// A rectangular area
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Boundary<C>
where
    C: Coordinate,
{
    pub(crate) p1: Point<C>,
    pub(crate) p2: Point<C>,
}

impl<C> Display for Boundary<C>
where
    C: Coordinate,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{},{}", self.p1, self.p2)
    }
}

/// This trait is required for coordinates
pub trait Coordinate:
    num_traits::NumOps + Sized + Clone + Copy + num_traits::NumCast + PartialOrd + Debug
{
}

impl <T> Coordinate for T where T: num_traits::NumOps + Sized + Clone + Copy + num_traits::NumCast + PartialOrd + Debug
{
}

impl<C> Boundary<C>
where
    C: Coordinate,
{
    /// create a new Boundary from x,y with width and height
    pub fn new(point: impl Into<Point<C>>, width: C, height: C) -> Self {
        let p1 = point.into();
        let p2 = (p1.x + width, p1.y + height).into();
        Self { p1, p2 }
    }

    /// Create a new Area between two points
    pub fn between_points(p1: impl Into<Point<C>>, p2: impl Into<Point<C>>) -> Self {
        let mut p1: Point<_> = p1.into();
        let mut p2: Point<_> = p2.into();

        if p1.x > p2.x {
            std::mem::swap(&mut p1.x, &mut p2.x)
        }
        if p1.y > p2.y {
            std::mem::swap(&mut p1.y, &mut p2.y)
        }

        Self { p1, p2 }
    }

    fn between_points_unchecked(p1: impl Into<Point<C>>, p2: impl Into<Point<C>>) -> Self {
        Self {
            p1: p1.into(),
            p2: p2.into(),
        }
    }

    /// Returns the left border (the smaller x value given at creation)
    pub fn left_border(&self) -> C {
        self.p1.x
    }

    /// Returns the right border (the bigger x value given at creation)
    pub fn right_border(&self) -> C {
        self.p2.x
    }

    /// Returns the top border (the smaller y value given at creation)
    pub fn top_border(&self) -> C {
        self.p1.y
    }

    /// Returns the bottom border (the bigger y value given at creation)
    pub fn bottom_border(&self) -> C {
        self.p2.y
    }

    /// Returns the width
    pub fn width(&self) -> C {
        self.right_border() - self.left_border()
    }

    /// Returns the height
    pub fn height(&self) -> C {
        self.top_border() - self.bottom_border()
    }

    pub(crate) fn split(&self) -> [Boundary<C>; 4] {
        let dx = self.p2.x - self.p1.x;
        let dy = self.p2.y - self.p1.y;
        let two = C::from(2).expect("Could not convert 2 to required type");
        let half_dx = dx / two;
        let half_dy = dy / two;
        [
            Boundary::new(self.p1, half_dx, half_dy),
            Boundary::between_points_unchecked(
                (self.p1.x + half_dx, self.p1.y),
                (self.p2.x, self.p1.y + half_dy),
            ),
            Boundary::between_points_unchecked(
                (self.p1.x, self.p1.y + half_dy),
                (self.p1.x + half_dx, self.p2.y),
            ),
            Boundary::between_points_unchecked((self.p1.x + half_dx, self.p1.y + half_dy), self.p2),
        ]
    }

    /// Get top left corner
    pub fn top_left(&self) -> &Point<C> {
        &self.p1
    }

    /// Get Bottom right corner
    pub fn bottom_right(&self) -> &Point<C> {
        &self.p2
    }
}
impl<C> Area<C> for Boundary<C>
where
    C: Coordinate,
{
    fn contains(&self, point: &Point<C>) -> bool {
        !(point.x < self.p1.x || point.x > self.p2.x || point.y < self.p1.y || point.y > self.p2.y)
    }

    fn intersects(&self, Boundary { p1, p2 }: &Boundary<C>) -> bool {
        !(p2.x < self.p1.x || p1.x > self.p2.x || p2.y < self.p1.y || p1.y > self.p2.y)
    }

    fn encloses(&self, boundary: &Boundary<C>) -> bool {
        self.contains(&boundary.p1) && self.contains(&boundary.p2)
    }
}

#[cfg(test)]
mod tests {
    use crate::{Area, Boundary, Point};
    use test_case::test_case;

    #[test_case(1,1,2,2 => Boundary::new((1,1),1,1); "Simple case")]
    #[test_case(2,1,1,2 => Boundary::new((1,1),1,1); "Swap x")]
    #[test_case(1,2,2,1 => Boundary::new((1,1),1,1); "Swap y")]
    #[test_case(2,2,1,1 => Boundary::new((1,1),1,1); "Swap both")]
    fn boundary_between_points(x1: usize, y1: usize, x2: usize, y2: usize) -> Boundary<usize> {
        Boundary::between_points((x1, y1), (x2, y2))
    }

    #[test]
    fn split_boundary_equal() {
        let b = Boundary::new((0, 0), 10, 10);
        let split = b.split();
        assert_eq!(split[0], Boundary::new((0, 0), 5, 5));
        assert_eq!(split[1], Boundary::new((5, 0), 5, 5));
        assert_eq!(split[2], Boundary::new((0, 5), 5, 5));
        assert_eq!(split[3], Boundary::new((5, 5), 5, 5));
    }

    #[test_case(3,3 => true; "Contains point")]
    #[test_case(2,2 => true; "Contains point on border")]
    #[test_case(4,4 => true; "Contains point on border 2")]
    #[test_case(1,3 => false; "Point above")]
    #[test_case(5,3 => false; "Point below")]
    #[test_case(3,1 => false; "Point left")]
    #[test_case(3,5 => false; "Point right")]
    fn boundary_contains_point(x: usize, y: usize) -> bool {
        let b = Boundary::new((2, 2), 2, 2);
        let p = Point { x, y };
        b.contains(&p)
    }

    #[test_case(2,2,1,1 => true; "b inside a")]
    #[test_case(0,0,6,6 => true; "a inside b")]
    #[test_case(0,2,3,1 => true; "left overlap")]
    #[test_case(4,2,3,1 => true; "right overlap")]
    #[test_case(2,0,1,3 => true; "top overlap")]
    #[test_case(2,4,1,3 => true; "bottom overlap")]
    #[test_case(-1, 2, 1, 1 => false; "b left of a")]
    #[test_case(6, 2, 1, 1 => false; "b right of a")]
    #[test_case(2, -1, 1, 1 => false; "b above of a")]
    #[test_case(2, 6, 1, 1 => false; "b under of a")]
    #[test_case(0,2,1,1 => true; "on left border")]
    #[test_case(5,2,1,1 => true; "on right border")]
    #[test_case(2,0,1,1 => true; "on top border")]
    #[test_case(2,5,1,1 => true; "on bottom border")]
    fn boundary_overlaps(x: isize, y: isize, width: isize, height: isize) -> bool {
        let a = Boundary::new((1, 1), 4, 4);
        let b = Boundary::new((x, y), width, height);
        a.intersects(&b)
    }

    #[test]
    fn format_point() {
        let p = Point::new(12, 34);
        assert_eq!("(12,34)", format!("{p}"))
    }

    #[test]
    fn format_boundary() {
        let b = Boundary::between_points((12, 34), (23, 45));
        assert_eq!("(12,34),(23,45)", format!("{b}"))
    }

    #[test]
    fn tree_spit_test() {
        let b = Boundary::between_points((16383usize, 16383), (32766, 32766));
        let sub_bounds = b.split();
        assert_eq!(
            sub_bounds[0],
            Boundary {
                p1: (16383, 16383).into(),
                p2: (16383 + 8191, 16383 + 8191).into(),
            }
        );
        assert_eq!(
            sub_bounds[1],
            Boundary {
                p1: (16383 + 8191, 16383).into(),
                p2: (32766, 16383 + 8191).into(),
            }
        );
        assert_eq!(
            sub_bounds[2],
            Boundary {
                p1: (16383, 16383 + 8191).into(),
                p2: (16383 + 8191, 32766).into(),
            }
        );
        assert_eq!(
            sub_bounds[3],
            Boundary {
                p1: (16383 + 8191, 16383 + 8191).into(),
                p2: (32766, 32766).into(),
            }
        );
    }

    #[test_case((1,2), (10,20) => 1;"0")]
    #[test_case((-1,-2), (10,20) => -1;"1")]
    fn left_border(p1: impl Into<Point<i32>>, p2: impl Into<Point<i32>>) -> i32 {
        Boundary::between_points(p1, p2).left_border()
    }

    #[test_case((1,2), (10,20) => 10;"0")]
    #[test_case((-1,-2), (20,20) => 20;"1")]
    fn right_border(p1: impl Into<Point<i32>>, p2: impl Into<Point<i32>>) -> i32 {
        Boundary::between_points(p1, p2).right_border()
    }

    #[test_case((1,2), (10,20) => 2;"0")]
    #[test_case((-1,-2), (10,20) => -2;"1")]
    fn top_border(p1: impl Into<Point<i32>>, p2: impl Into<Point<i32>>) -> i32 {
        Boundary::between_points(p1, p2).top_border()
    }

    #[test_case((1,2), (20,10) => 10;"0")]
    #[test_case((-1,-2), (10,20) => 20;"1")]
    fn bottom_border(p1: impl Into<Point<i32>>, p2: impl Into<Point<i32>>) -> i32 {
        Boundary::between_points(p1, p2).bottom_border()
    }
}