engeom 0.5.0

Library for working with geometry with a focus on engineering metrology applications.
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
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use super::IntervalOps;

// ================================================================================================
// Merge Domain
// ================================================================================================

pub struct MergeDomain<T: IntervalOps> {
    pub items: Vec<T>,
}

impl<T: IntervalOps> MergeDomain<T> {
    pub fn from_intervals(mut intervals: Vec<T>) -> Self {
        intervals.sort_by(|a, b| a.min().partial_cmp(&b.min()).unwrap());
        let mut items: Vec<T> = Vec::with_capacity(intervals.len());
        for x in intervals {
            match items.last_mut() {
                Some(last) if last.overlaps(x) => {
                    *last = x.new_containing(last);
                }
                _ => items.push(x),
            }
        }

        let mut constructed = MergeDomain { items };
        constructed.mut_resolve_wrap();
        constructed
    }

    pub fn new_empty() -> Self {
        MergeDomain { items: Vec::new() }
    }

    pub fn is_empty(&self) -> bool {
        self.items.is_empty()
    }

    pub fn len(&self) -> usize {
        self.items.len()
    }

    pub fn insert(&mut self, item: T) {
        let search = self
            .items
            .binary_search_by(|i| i.min().partial_cmp(&item.min()).unwrap());

        // The interval either has the same minimum value as the element at check_i, or is just
        // below the minimum value of the interval at check_i.
        let check_i = search.unwrap_or_else(|i| i);

        // Now we determine which intervals it overlaps with.
        let overlaps = self.find_overlaps_no_wrap(&item, check_i.saturating_sub(1));

        if overlaps.is_empty() {
            self.items.insert(check_i, item);
        } else {
            // If there are overlaps, we work in reverse order (to preserve earlier indices),
            // removing intervals and merging them into a working replacement interval.
            let mut working = item;
            for i in overlaps.iter().rev() {
                let popped = self.items.remove(*i);
                working = working.new_containing(&popped);
            }

            // Finally, we insert the accumulated interval back into the collection.
            self.items.insert(overlaps[0], working);
        }

        self.mut_resolve_wrap();
    }

    fn mut_resolve_wrap(&mut self) {
        if T::wraps() && self.items.len() > 2 {
            // If the domain wraps, it is possible that the last and the first element may overlap.
            // There cannot be additional overlaps, because the item after the first element is
            // guaranteed to not overlap with the first element, and the item before the last
            // element is guaranteed to not overlap with the last element. Therefore, we only need
            // to check the first and last.
            //
            // If there is an overlap, the easiest thing to do is to pop the last element off of
            // the list and replace the first.
            if self.items[0].overlaps(self.items[self.items.len() - 1]) {
                let last = self.items.pop().unwrap();
                self.items[0] = last.new_containing(&self.items[0]);
            }
        }
    }

    /// Starting at `start_i`, will return a Vec of all indices which overlap with the given
    /// interval. These will inherently be arranged in ascending order.
    fn find_overlaps_no_wrap(&self, item: &T, start_i: usize) -> Vec<usize> {
        let mut overlaps = vec![];
        for i in start_i..self.items.len() {
            if self.items[i].min() > item.max() {
                break;
            }
            if item.overlaps(self.items[i]) {
                overlaps.push(i);
            }
        }
        overlaps
    }

    pub fn modify_at(&'_ mut self, index: usize) -> Option<ItemEditHandle<'_, T>> {
        if index < self.items.len() {
            Some(ItemEditHandle {
                domain: self,
                index,
            })
        } else {
            None
        }
    }

    pub fn modify_all(&'_ mut self, action: &dyn Fn(T) -> Option<T>) {
        let modified = self
            .items
            .iter()
            .filter_map(|item| action(*item))
            .filter(|item| !item.is_empty())
            .collect::<Vec<_>>();
        let surrogate = Self::from_intervals(modified);
        self.items = surrogate.items;
    }
}

// ================================================================================================
// Editing Features
// ================================================================================================
#[allow(dead_code)] // WIP editing API, not yet wired up
enum ModAct<T: IntervalOps> {
    None,
    Delete,
    Replace(T),
}

#[allow(dead_code)] // WIP editing API, not yet wired up
pub trait IntervalHandleEdit<T: IntervalOps> {
    fn delete(self);
    fn replace(self, item: T);
    fn modify(self, action: &dyn Fn(&T) -> Option<T>);
}

pub struct ItemEditHandle<'a, T: IntervalOps> {
    domain: &'a mut MergeDomain<T>,
    index: usize,
}

impl<'a, T: IntervalOps> ItemEditHandle<'a, T> {
    pub fn item(&self) -> &T {
        &self.domain.items[self.index]
    }
}

impl<'a, T: IntervalOps> IntervalHandleEdit<T> for ItemEditHandle<'a, T> {
    fn delete(self) {
        self.domain.items.remove(self.index);
    }

    fn replace(self, item: T) {
        self.domain.items.remove(self.index);
        if !item.is_empty() {
            self.domain.insert(item);
        }
    }

    fn modify(self, action: &dyn Fn(&T) -> Option<T>) {
        if let Some(result) = action(self.item()) {
            self.replace(result);
        } else {
            self.delete();
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::common::IntervalMergeDomain;
    use crate::common::interval::{Interval, IntervalMerge};

    fn no_overlaps(x: &IntervalMerge) -> bool {
        for i in 0..x.items.len() {
            for k in i + 1..x.items.len() {
                if x.items[i].overlaps(x.items[k]) {
                    return false;
                }
            }
        }
        true
    }

    fn is_sorted(x: &IntervalMerge) -> bool {
        for i in 0..(x.items.len().saturating_sub(1)) {
            if x.items[i + 1].min < x.items[i].min {
                return false;
            }
        }
        true
    }

    fn interval(min: f64, max: f64) -> Interval {
        Interval::new(min, max)
    }

    // Insert a single interval into an empty domain.
    #[test]
    fn insert_into_empty() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(1.0, 3.0));
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 1.0);
        assert_eq!(d.items[0].max, 3.0);
    }

    // Two disjoint intervals inserted in order : both should be kept, sorted.
    #[test]
    fn insert_two_disjoint_in_order() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(2.0, 3.0));
        assert_eq!(d.items.len(), 2);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[1].min, 2.0);
    }

    // Two disjoint intervals inserted in reverse order : result must be sorted.
    #[test]
    fn insert_two_disjoint_reverse_order() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(2.0, 3.0));
        d.insert(interval(0.0, 1.0));
        assert_eq!(d.items.len(), 2);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[1].min, 2.0);
    }

    // Three disjoint intervals inserted in random order.
    #[test]
    fn insert_three_disjoint_random_order() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(4.0, 5.0));
        d.insert(interval(0.0, 1.0));
        d.insert(interval(2.0, 3.0));
        assert_eq!(d.items.len(), 3);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
    }

    // Two overlapping intervals should merge into one.
    #[test]
    fn insert_overlapping_merges() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 2.0));
        d.insert(interval(1.0, 3.0));
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 3.0);
    }

    // Inserting a fully-contained interval leaves the existing one unchanged.
    #[test]
    fn insert_contained_interval() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 10.0));
        d.insert(interval(3.0, 7.0));
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 10.0);
    }

    // Inserting an interval that contains an existing one expands outward.
    #[test]
    fn insert_containing_interval() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(3.0, 7.0));
        d.insert(interval(0.0, 10.0));
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 10.0);
    }

    // A new interval that bridges two existing ones should merge all three.
    #[test]
    fn insert_bridges_two_existing() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(3.0, 4.0));
        d.insert(interval(0.5, 3.5)); // overlaps both
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 4.0);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
    }

    // A new interval that bridges three existing ones should merge all four.
    #[test]
    fn insert_bridges_three_existing() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(2.0, 3.0));
        d.insert(interval(4.0, 5.0));
        d.insert(interval(0.5, 4.5)); // spans all three
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 5.0);
    }

    // from_intervals with an empty vec produces an empty domain.
    #[test]
    fn from_intervals_empty() {
        let d = IntervalMerge::from_intervals(vec![]);
        assert_eq!(d.items.len(), 0);
    }

    // from_intervals sorts and keeps disjoint intervals.
    #[test]
    fn from_intervals_disjoint_unsorted() {
        let d = IntervalMerge::from_intervals(vec![
            interval(4.0, 5.0),
            interval(0.0, 1.0),
            interval(2.0, 3.0),
        ]);
        assert_eq!(d.items.len(), 3);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[1].min, 2.0);
        assert_eq!(d.items[2].min, 4.0);
    }

    // from_intervals merges overlapping intervals.
    #[test]
    fn from_intervals_with_overlaps() {
        let d = IntervalMerge::from_intervals(vec![
            interval(0.0, 2.0),
            interval(3.0, 5.0),
            interval(1.5, 4.0), // bridges the first two
        ]);
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 5.0);
    }

    // from_intervals handles a mix: some overlap, some don't.
    #[test]
    fn from_intervals_mixed() {
        let d = IntervalMerge::from_intervals(vec![
            interval(0.0, 1.0),
            interval(0.5, 1.5), // overlaps first
            interval(3.0, 4.0),
            interval(3.5, 5.0), // overlaps previous
            interval(7.0, 8.0), // disjoint
        ]);
        assert_eq!(d.items.len(), 3);
        assert!(is_sorted(&d));
        assert!(no_overlaps(&d));
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 1.5);
        assert_eq!(d.items[1].min, 3.0);
        assert_eq!(d.items[1].max, 5.0);
        assert_eq!(d.items[2].min, 7.0);
        assert_eq!(d.items[2].max, 8.0);
    }

    // modify_at: removing an interval shrinks the domain.
    #[test]
    fn modify_at_remove() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(2.0, 3.0));
        d.insert(interval(4.0, 5.0));
        let h = d.modify_at(1).unwrap();
        assert_eq!(h.item().min, 2.0);
        h.delete();
        assert_eq!(d.items.len(), 2);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[1].min, 4.0);
    }

    // modify_at: no queued action leaves the domain unchanged.
    #[test]
    fn modify_at_no_action_is_noop() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.modify_at(0).unwrap();
        assert_eq!(d.items.len(), 1);
    }

    // modify_at: replacing an interval re-inserts and merges if needed.
    #[test]
    fn modify_at_replace_merges() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(5.0, 6.0));
        d.modify_at(0).unwrap().replace(interval(0.0, 5.5)); // now overlaps the second interval
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 0.0);
        assert_eq!(d.items[0].max, 6.0);
    }

    // modify_at: set with a zero-length interval acts as remove.
    #[test]
    fn modify_at_set_zero_length_removes() {
        let mut d = IntervalMerge::new_empty();
        d.insert(interval(0.0, 1.0));
        d.insert(interval(2.0, 3.0));
        d.modify_at(0).unwrap().replace(interval(0.5, 0.5));
        assert_eq!(d.items.len(), 1);
        assert_eq!(d.items[0].min, 2.0);
    }

    // modify_at: out-of-bounds index returns None.
    #[test]
    fn modify_at_out_of_bounds() {
        let mut d = IntervalMergeDomain::empty();
        d.insert(interval(0.0, 1.0));
        assert!(d.modify_at(1).is_none());
    }
}