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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
#![deny(
    unsafe_code,
    unused,
    warnings,
    clippy::all,
    clippy::cargo,
    clippy::complexity,
    clippy::correctness,
    clippy::nursery,
    clippy::pedantic,
    clippy::perf,
    clippy::restriction,
    clippy::style,
    clippy::suspicious
)]
#![allow(
    clippy::blanket_clippy_restriction_lints,
    clippy::implicit_return,
    clippy::min_ident_chars,
    clippy::missing_trait_methods,
    clippy::semicolon_outside_block,
    clippy::single_char_lifetime_names
)]
extern crate alloc;
use crate::SetOrd;
use alloc::collections::btree_map::{
    BTreeMap, CursorMut, IntoIter, IntoKeys, IntoValues, Iter, IterMut, Keys, OccupiedEntry, Range,
    RangeMut, Values, ValuesMut,
};
use core::borrow::Borrow;
use core::ops::{Bound, Index, RangeBounds};
/// A minimal collection of `(K, V)`s.
/// Internally it is based on a [`BTreeMap`].
/// When a `(K, V)` is [`SupersetMap::insert`]ed,
/// it won't actually be inserted unless
/// there isn't a `K` already in
/// the map that is a superset of it.
/// In such event, all `K`s that
/// are subsets of the to-be-inserted `K`
/// are removed before inserting the `K`.
/// Note this can have quite good performance due to the
/// fact that a single search is necessary to detect
/// if insertion should occur; furthermore since all
/// subsets occur immediately before where the key
/// will be inserted, a simple linear scan is sufficient
/// to remove subsets avoiding the need to search
/// the entire map.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct SupersetMap<K, V> {
    /// Collection of `(K, V)`s.
    map: BTreeMap<K, V>,
}
impl<K, V> Default for SupersetMap<K, V> {
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}
impl<K, V> SupersetMap<K, V> {
    /// Read [`BTreeMap::clear`].
    #[inline]
    pub fn clear(&mut self) {
        self.map.clear();
    }
    /// Read [`BTreeMap::into_keys`].
    #[inline]
    pub fn into_keys(self) -> IntoKeys<K, V> {
        self.map.into_keys()
    }
    /// Read [`BTreeMap::into_values`].
    #[inline]
    pub fn into_values(self) -> IntoValues<K, V> {
        self.map.into_values()
    }
    /// Read [`BTreeMap::is_empty`].
    #[inline]
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.map.is_empty()
    }
    /// Read [`BTreeMap::iter`].
    #[inline]
    pub fn iter(&self) -> Iter<'_, K, V> {
        self.map.iter()
    }
    /// Read [`BTreeMap::iter_mut`].
    #[inline]
    pub fn iter_mut(&mut self) -> IterMut<'_, K, V> {
        self.map.iter_mut()
    }
    /// Read [`BTreeMap::keys`].
    #[inline]
    pub fn keys(&self) -> Keys<'_, K, V> {
        self.map.keys()
    }
    /// Read [`BTreeMap::len`].
    #[inline]
    #[must_use]
    pub fn len(&self) -> usize {
        self.map.len()
    }
    /// Makes a new, empty `SupersetMap`.
    /// Does not allocate anything on its own.
    #[inline]
    #[must_use]
    pub const fn new() -> Self {
        Self {
            map: BTreeMap::new(),
        }
    }
    /// Read [`BTreeMap::values`].
    #[inline]
    pub fn values(&self) -> Values<'_, K, V> {
        self.map.values()
    }
    /// Read [`BTreeMap::values_mut`].
    #[inline]
    pub fn values_mut(&mut self) -> ValuesMut<'_, K, V> {
        self.map.values_mut()
    }
}
impl<K, V> SupersetMap<K, V>
where
    K: Ord,
{
    /// Read [`BTreeMap::contains_key`].
    #[inline]
    pub fn contains_key<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.contains_key(key)
    }
    /// Read [`BTreeMap::first_entry`].
    #[inline]
    pub fn first_entry(&mut self) -> Option<OccupiedEntry<'_, K, V>> {
        self.map.first_entry()
    }
    /// Read [`BTreeMap::first_key_value`].
    #[inline]
    #[must_use]
    pub fn first_key_value(&self) -> Option<(&K, &V)> {
        self.map.first_key_value()
    }
    /// Read [`BTreeMap::get`].
    #[inline]
    pub fn get<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.get(key)
    }
    /// Read [`BTreeMap::get_key_value`].
    #[inline]
    pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.get_key_value(key)
    }
    /// Read [`BTreeMap::get_mut`].
    #[inline]
    pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.get_mut(key)
    }
    /// Read [`BTreeMap::last_entry`].
    #[inline]
    pub fn last_entry(&mut self) -> Option<OccupiedEntry<'_, K, V>> {
        self.map.last_entry()
    }
    /// Read [`BTreeMap::last_key_value`].
    #[inline]
    #[must_use]
    pub fn last_key_value(&self) -> Option<(&K, &V)> {
        self.map.last_key_value()
    }
    /// Read [`BTreeMap::pop_first`].
    #[inline]
    pub fn pop_first(&mut self) -> Option<(K, V)> {
        self.map.pop_first()
    }
    /// Read [`BTreeMap::pop_last`].
    #[inline]
    pub fn pop_last(&mut self) -> Option<(K, V)> {
        self.map.pop_last()
    }
    /// Read [`BTreeMap::range`].
    #[inline]
    pub fn range<T, R>(&self, range: R) -> Range<'_, K, V>
    where
        K: Borrow<T>,
        T: Ord + ?Sized,
        R: RangeBounds<T>,
    {
        self.map.range(range)
    }
    /// Read [`BTreeMap::range_mut`].
    #[inline]
    pub fn range_mut<T, R>(&mut self, range: R) -> RangeMut<'_, K, V>
    where
        K: Borrow<T>,
        T: Ord + ?Sized,
        R: RangeBounds<T>,
    {
        self.map.range_mut(range)
    }
    /// Read [`BTreeMap::remove`].
    #[inline]
    pub fn remove<Q>(&mut self, key: &Q) -> Option<V>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.remove(key)
    }
    /// Read [`BTreeMap::remove_entry`].
    #[inline]
    pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.map.remove_entry(key)
    }
    /// Read [`BTreeMap::split_off`].
    #[inline]
    #[must_use]
    pub fn split_off<Q>(&mut self, key: &Q) -> Self
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        Self {
            map: self.map.split_off(key),
        }
    }
}
impl<K, V> SupersetMap<K, V>
where
    K: SetOrd,
{
    /// Moves all elements from `other` into `self`, consuming `other`.
    /// If a key from `other` is a proper superset of a key in `self`, the respective key and value from `self` will be removed before inserting
    /// the key and value from `other`.
    /// If a key from `other` is a subset of a key in `self`, it won't be inserted.
    #[inline]
    pub fn append(&mut self, other: Self) {
        if self.is_empty() {
            *self = other;
        } else {
            other.into_iter().fold((), |(), (key, val)| {
                self.insert(key, val);
            });
        }
    }
    /// Returns `true` if the map contains a value for a proper subset of the specified key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn contains_proper_subset<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_greatest_proper_subset(key).is_some()
    }
    /// Returns `true` if the map contains a value for a proper superset of the specified key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn contains_proper_superset<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_least_proper_superset(key).is_some()
    }
    /// Returns `true` if the map contains a value for a subset of the specified key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn contains_subset<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_greatest_subset(key).is_some()
    }
    /// Returns `true` if the map contains a value for a superset of the specified key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn contains_superset<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_least_superset(key).is_some()
    }
    /// Returns a reference to the value corresponding to the greatest proper subset of key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn get_greatest_proper_subset<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_greatest_proper_subset_key_value(key)
            .map(|(_, val)| val)
    }
    /// Returns a reference to the key-value pair corresponding to the greatest proper subset of the supplied key.
    /// The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type
    #[inline]
    pub fn get_greatest_proper_subset_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.map
            .upper_bound(Bound::Excluded(key))
            .peek_prev()
            .and_then(|pair| pair.0.borrow().is_proper_subset(key).then_some(pair))
    }
    /// Returns a reference to the value corresponding to the greatest subset of key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn get_greatest_subset<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_greatest_subset_key_value(key).map(|(_, val)| val)
    }
    /// Returns a reference to the key-value pair corresponding to the greatest subset of the supplied key.
    /// The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type
    #[inline]
    pub fn get_greatest_subset_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.map
            .upper_bound(Bound::Included(key))
            .peek_prev()
            .and_then(|pair| pair.0.borrow().is_subset(key).then_some(pair))
    }
    /// Returns a reference to the value corresponding to the least proper superset of key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn get_least_proper_superset<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_least_proper_superset_key_value(key)
            .map(|(_, val)| val)
    }
    /// Returns a reference to the key-value pair corresponding to the least proper superset of the supplied key.
    /// The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type
    #[inline]
    pub fn get_least_proper_superset_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.map
            .lower_bound(Bound::Excluded(key))
            .peek_next()
            .and_then(|pair| pair.0.borrow().is_proper_superset(key).then_some(pair))
    }
    /// Returns a reference to the value corresponding to the least superset of key.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn get_least_superset<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.get_least_superset_key_value(key).map(|(_, val)| val)
    }
    /// Returns a reference to the key-value pair corresponding to the least superset of the supplied key.
    /// The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type
    #[inline]
    pub fn get_least_superset_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.map
            .lower_bound(Bound::Included(key))
            .peek_next()
            .and_then(|pair| pair.0.borrow().is_superset(key).then_some(pair))
    }
    /// `(key, value)` is inserted iff there doesn't already
    /// exist a `K` that is a superset of `key`.
    /// In the event `(key, value)` will be inserted, all `(K, V)`s
    /// where the `K` is a subset of `key` are first removed before
    /// inserting.
    #[inline]
    #[allow(unsafe_code)]
    pub fn insert(&mut self, key: K, value: V) -> bool {
        // Since the only way to `insert` a `(K, V)` is via this function,
        // the following is true:
        // The smallest value greater than or equal to `key` will be a superset
        // of `key` iff there exists a superset of `key`.
        // This means that we simply have to check this one value to decide
        // if `(key, value)` needs to be inserted; furthermore, in the event `(key, value)`
        // does need to be inserted, we only have to traverse backwards until
        // the beginning of `map` or a `K` is not a subset of `key`
        // removing all `(K, V)`s where the `K` is a subset before we insert `(key, value)`.
        let mut cursor = self.map.lower_bound_mut(Bound::Included(&key));
        if let Some(ge) = cursor.peek_next() {
            if ge.0.is_superset(&key) {
                return false;
            }
        }
        loop {
            match cursor.prev() {
                None => break,
                Some(lt) => {
                    if key.is_proper_superset(lt.0) {
                        cursor.remove_next();
                    } else {
                        cursor.next();
                        break;
                    }
                }
            }
        }
        // SAFETY:
        // If `key` already existed in the map, then cursor
        // would begin pointing at it. Since `Set::is_superset`
        // returns true when both values are the same, we would
        // immediately return from this function. This guarantees
        // that `key` is unique before inserting.
        // Since we only move to smaller values and each time we do
        // we remove said value (or stop), the insert of `key` will occur after
        // all smaller values and before larger values ensuring the sorted
        // order of `map` is retained.
        // Note that due to the requirements of `SetOrd`, a `K` that
        // `is_proper_superset` another `K` is also strictly greater.
        unsafe {
            cursor.insert_before_unchecked(key, value);
        }
        true
    }
    /// Allows for `SupersetSet::replace` to be implemented for supersets.
    #[inline]
    pub(crate) fn lower_bound_mut<Q>(&mut self, bound: Bound<&Q>) -> CursorMut<'_, K, V>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        self.map.lower_bound_mut(bound)
    }
    /// Removes the greatest proper subset of key from the map, returning the key and value if such a subset exists.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn remove_greatest_proper_subset<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.upper_bound_mut(Bound::Excluded(key));
        if let Some(lt) = cursor.peek_prev() {
            if lt.0.borrow().is_proper_subset(key) {
                return cursor.remove_prev();
            }
        }
        None
    }
    /// Removes the greatest subset of key from the map, returning the key and value if such a subset exists.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn remove_greatest_subset<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.upper_bound_mut(Bound::Included(key));
        if let Some(le) = cursor.peek_prev() {
            if le.0.borrow().is_subset(key) {
                return cursor.remove_prev();
            }
        }
        None
    }
    /// Removes the least proper superset of key from the map, returning the key and value if such a superset exists.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn remove_least_proper_superset<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.lower_bound_mut(Bound::Excluded(key));
        if let Some(gt) = cursor.peek_next() {
            if gt.0.borrow().is_proper_superset(key) {
                return cursor.remove_next();
            }
        }
        None
    }
    /// Removes the least superset of key from the map, returning the key and value if such a superset exists.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    #[inline]
    pub fn remove_least_superset<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.lower_bound_mut(Bound::Included(key));
        if let Some(ge) = cursor.peek_next() {
            if ge.0.borrow().is_superset(key) {
                return cursor.remove_next();
            }
        }
        None
    }
    /// Removes all proper subsets of key from the map, returning the count removed.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    /// # Overflow Behavior
    ///
    /// The method does no guarding against overflows, so the removal of more than `usize::MAX` elements either produces the wrong result or panics. If debug assertions are enabled, a panic is guaranteed.
    /// # Panics
    ///
    /// This function might panic if the number of elements removed is greater than `usize::MAX`.
    #[inline]
    #[allow(clippy::arithmetic_side_effects)]
    pub fn remove_proper_subsets<Q>(&mut self, key: &Q) -> usize
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.upper_bound_mut(Bound::Excluded(key));
        let mut count = 0;
        while let Some(lt) = cursor.prev() {
            if lt.0.borrow().is_proper_subset(key) {
                cursor.remove_next();
                count += 1;
            } else {
                return count;
            }
        }
        count
    }
    /// Removes all proper supersets of key from the map, returning the count removed.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    /// # Overflow Behavior
    ///
    /// The method does no guarding against overflows, so the removal of more than `usize::MAX` elements either produces the wrong result or panics. If debug assertions are enabled, a panic is guaranteed.
    /// # Panics
    ///
    /// This function might panic if the number of elements removed is greater than `usize::MAX`.
    #[inline]
    #[allow(clippy::arithmetic_side_effects)]
    pub fn remove_proper_supersets<Q>(&mut self, key: &Q) -> usize
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.lower_bound_mut(Bound::Excluded(key));
        let mut count = 0;
        while let Some(gt) = cursor.next() {
            if gt.0.borrow().is_proper_superset(key) {
                cursor.remove_prev();
                count += 1;
            } else {
                return count;
            }
        }
        count
    }
    /// Removes all subsets of key from the map, returning the count removed.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    /// # Overflow Behavior
    ///
    /// The method does no guarding against overflows, so the removal of more than `usize::MAX` elements either produces the wrong result or panics. If debug assertions are enabled, a panic is guaranteed.
    /// # Panics
    ///
    /// This function might panic if the number of elements removed is greater than `usize::MAX`.
    #[inline]
    #[allow(clippy::arithmetic_side_effects)]
    pub fn remove_subsets<Q>(&mut self, key: &Q) -> usize
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.upper_bound_mut(Bound::Included(key));
        let mut count = 0;
        // To avoid unnecessary checks for equivalence,
        // we separately call `is_subset` on the first element
        // while calling `is_proper_subset` on the other elements.
        if let Some(le) = cursor.prev() {
            if le.0.borrow().is_subset(key) {
                cursor.remove_next();
                count += 1;
                while let Some(lt) = cursor.prev() {
                    if lt.0.borrow().is_proper_subset(key) {
                        cursor.remove_next();
                        count += 1;
                    } else {
                        return count;
                    }
                }
            } else {
                return count;
            }
        }
        count
    }
    /// Removes all supersets of key from the map, returning the count removed.
    /// The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
    /// # Overflow Behavior
    ///
    /// The method does no guarding against overflows, so the removal of more than `usize::MAX` elements either produces the wrong result or panics. If debug assertions are enabled, a panic is guaranteed.
    /// # Panics
    ///
    /// This function might panic if the number of elements removed is greater than `usize::MAX`.
    #[inline]
    #[allow(clippy::arithmetic_side_effects)]
    pub fn remove_supersets<Q>(&mut self, key: &Q) -> usize
    where
        K: Borrow<Q>,
        Q: SetOrd + ?Sized,
    {
        let mut cursor = self.map.lower_bound_mut(Bound::Included(key));
        let mut count = 0;
        // To avoid unnecessary checks for equivalence,
        // we separately call `is_superset` on the first element
        // while calling `is_proper_superset` on the other elements.
        if let Some(ge) = cursor.next() {
            if ge.0.borrow().is_superset(key) {
                cursor.remove_prev();
                count += 1;
                while let Some(gt) = cursor.next() {
                    if gt.0.borrow().is_proper_superset(key) {
                        cursor.remove_prev();
                        count += 1;
                    } else {
                        return count;
                    }
                }
            } else {
                return count;
            }
        }
        count
    }
    /// Retains only the elements specified by the predicate.
    /// In other words, remove all pairs `(k, v)` for which `f(&k, &mut v)` returns `false`. The elements are visited in ascending key order.
    #[inline]
    pub fn retain<F>(&mut self, f: F)
    where
        F: FnMut(&K, &mut V) -> bool,
    {
        self.map.retain(f);
    }
}
impl<K, V> Extend<(K, V)> for SupersetMap<K, V>
where
    K: SetOrd,
{
    #[inline]
    fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T) {
        iter.into_iter().fold((), |(), (k, v)| {
            self.insert(k, v);
        });
    }
}
impl<'a, K, V> Extend<(&'a K, &'a V)> for SupersetMap<K, V>
where
    K: SetOrd + Copy,
    V: Copy,
{
    #[inline]
    fn extend<T: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: T) {
        iter.into_iter().fold((), |(), (k, v)| {
            self.insert(*k, *v);
        });
    }
}
impl<K, V, const N: usize> From<[(K, V); N]> for SupersetMap<K, V>
where
    K: SetOrd,
{
    #[inline]
    fn from(value: [(K, V); N]) -> Self {
        let mut map = Self::new();
        map.extend(value);
        map
    }
}
impl<K, V> FromIterator<(K, V)> for SupersetMap<K, V>
where
    K: SetOrd,
{
    #[inline]
    fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self {
        let mut map = Self::new();
        map.extend(iter);
        map
    }
}
impl<K, Q, V> Index<&Q> for SupersetMap<K, V>
where
    K: Borrow<Q> + Ord,
    Q: Ord + ?Sized,
{
    type Output = V;
    #[inline]
    fn index(&self, index: &Q) -> &Self::Output {
        self.map.index(index)
    }
}
impl<K, V> IntoIterator for SupersetMap<K, V> {
    type Item = (K, V);
    type IntoIter = IntoIter<K, V>;
    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.map.into_iter()
    }
}
impl<'a, K, V> IntoIterator for &'a SupersetMap<K, V> {
    type Item = (&'a K, &'a V);
    type IntoIter = Iter<'a, K, V>;
    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}
impl<'a, K, V> IntoIterator for &'a mut SupersetMap<K, V> {
    type Item = (&'a K, &'a mut V);
    type IntoIter = IterMut<'a, K, V>;
    #[inline]
    fn into_iter(self) -> Self::IntoIter {
        self.iter_mut()
    }
}
#[cfg(test)]
mod tests {
    use super::SupersetMap;
    use crate::SetOrd;
    use core::borrow::Borrow;
    use core::cmp::Ordering;
    use num_bigint::BigUint;
    use zfc::{BoundedCardinality, Cardinality, Set};
    #[derive(Eq, PartialEq)]
    struct ClosedInterval {
        min: usize,
        max: usize,
    }
    impl PartialOrd<Self> for ClosedInterval {
        fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
            Some(self.cmp(other))
        }
    }
    impl Ord for ClosedInterval {
        fn cmp(&self, other: &Self) -> Ordering {
            match self.min.cmp(&other.min) {
                Ordering::Less => {
                    if self.max >= other.max {
                        Ordering::Greater
                    } else {
                        Ordering::Less
                    }
                }
                Ordering::Equal => self.max.cmp(&other.max),
                Ordering::Greater => {
                    if self.max > other.max {
                        Ordering::Greater
                    } else {
                        Ordering::Less
                    }
                }
            }
        }
    }
    impl Set for ClosedInterval {
        type Elem = usize;
        fn bounded_cardinality(&self) -> BoundedCardinality {
            BoundedCardinality::from_biguint_exact(
                BigUint::from(self.max - self.min) + BigUint::from(1usize),
            )
        }
        fn cardinality(&self) -> Option<Cardinality> {
            Some(Cardinality::Finite(
                BigUint::from(self.max - self.min) + BigUint::from(1usize),
            ))
        }
        fn contains<Q>(&self, elem: &Q) -> bool
        where
            Q: ?Sized + Borrow<Self::Elem> + Eq,
        {
            self.min <= *elem.borrow() && self.max >= *elem.borrow()
        }
        fn is_proper_subset(&self, val: &Self) -> bool {
            match self.min.cmp(&val.min) {
                Ordering::Less => false,
                Ordering::Equal => self.max < val.max,
                Ordering::Greater => self.max <= val.max,
            }
        }
        fn is_subset(&self, val: &Self) -> bool {
            self.min >= val.min && self.max <= val.max
        }
    }
    impl SetOrd for ClosedInterval {}
    #[test]
    fn test_insert() {
        let mut map = SupersetMap::new();
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 4 }, ());
        map.insert(ClosedInterval { min: 1, max: 4 }, ());
        map.insert(ClosedInterval { min: 4, max: 6 }, ());
        map.insert(ClosedInterval { min: 2, max: 7 }, ());
        map.insert(ClosedInterval { min: 10, max: 17 }, ());
        let mut keys = map.into_keys();
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 0, max: 4 }));
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 2, max: 7 }));
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 10, max: 17 }));
        assert!(keys.next().is_none());
        assert!(keys.next().is_none());
        assert!(keys.next().is_none());
    }
    #[test]
    fn test_append() {
        let mut map = SupersetMap::new();
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 4 }, ());
        map.insert(ClosedInterval { min: 1, max: 4 }, ());
        map.insert(ClosedInterval { min: 4, max: 6 }, ());
        map.insert(ClosedInterval { min: 2, max: 7 }, ());
        map.insert(ClosedInterval { min: 10, max: 17 }, ());
        let mut map2 = SupersetMap::new();
        map2.insert(ClosedInterval { min: 0, max: 1 }, ());
        map2.insert(ClosedInterval { min: 1, max: 14 }, ());
        map2.insert(ClosedInterval { min: 11, max: 18 }, ());
        map.append(map2);
        let mut keys = map.into_keys();
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 0, max: 4 }));
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 1, max: 14 }));
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 10, max: 17 }));
        assert!(keys
            .next()
            .map_or(false, |set| set == ClosedInterval { min: 11, max: 18 }));
        assert!(keys.next().is_none());
        assert!(keys.next().is_none());
        assert!(keys.next().is_none());
    }
    #[test]
    fn test_contains() {
        let mut map = SupersetMap::new();
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 4 }, ());
        map.insert(ClosedInterval { min: 1, max: 4 }, ());
        map.insert(ClosedInterval { min: 4, max: 6 }, ());
        map.insert(ClosedInterval { min: 2, max: 7 }, ());
        map.insert(ClosedInterval { min: 10, max: 17 }, ());
        assert!(map.contains_proper_subset(&ClosedInterval { min: 0, max: 10 }));
        assert!(!map.contains_proper_subset(&ClosedInterval { min: 10, max: 17 }));
        assert!(!map.contains_proper_subset(&ClosedInterval { min: 210, max: 217 }));
        assert!(map.contains_proper_superset(&ClosedInterval { min: 0, max: 1 }));
        assert!(!map.contains_proper_superset(&ClosedInterval { min: 10, max: 17 }));
        assert!(!map.contains_proper_superset(&ClosedInterval { min: 210, max: 217 }));
        assert!(map.contains_subset(&ClosedInterval { min: 0, max: 10 }));
        assert!(map.contains_subset(&ClosedInterval { min: 10, max: 17 }));
        assert!(!map.contains_subset(&ClosedInterval { min: 210, max: 217 }));
        assert!(map.contains_superset(&ClosedInterval { min: 0, max: 1 }));
        assert!(map.contains_superset(&ClosedInterval { min: 10, max: 17 }));
        assert!(!map.contains_superset(&ClosedInterval { min: 210, max: 217 }));
    }
    #[test]
    fn test_get() {
        let mut map = SupersetMap::new();
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 4 }, ());
        map.insert(ClosedInterval { min: 1, max: 4 }, ());
        map.insert(ClosedInterval { min: 4, max: 6 }, ());
        map.insert(ClosedInterval { min: 2, max: 7 }, ());
        map.insert(ClosedInterval { min: 10, max: 17 }, ());
        assert!(map
            .get_greatest_proper_subset_key_value(&ClosedInterval { min: 0, max: 10 })
            .map_or(false, |(key, _)| *key == ClosedInterval { min: 2, max: 7 }));
        assert!(map
            .get_greatest_proper_subset_key_value(&ClosedInterval { min: 10, max: 17 })
            .map_or(true, |_| false));
        assert!(map
            .get_greatest_proper_subset_key_value(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .get_least_proper_superset_key_value(&ClosedInterval { min: 3, max: 4 })
            .map_or(false, |(key, _)| *key == ClosedInterval { min: 0, max: 4 }));
        assert!(map
            .get_least_proper_superset_key_value(&ClosedInterval { min: 10, max: 17 })
            .map_or(true, |_| false));
        assert!(map
            .get_least_proper_superset_key_value(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .get_greatest_subset_key_value(&ClosedInterval { min: 0, max: 10 })
            .map_or(false, |(key, _)| *key == ClosedInterval { min: 2, max: 7 }));
        assert!(map
            .get_greatest_subset_key_value(&ClosedInterval { min: 10, max: 17 })
            .map_or(false, |(key, _)| *key
                == ClosedInterval { min: 10, max: 17 }));
        assert!(map
            .get_greatest_subset_key_value(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .get_least_superset_key_value(&ClosedInterval { min: 3, max: 4 })
            .map_or(false, |(key, _)| *key == ClosedInterval { min: 0, max: 4 }));
        assert!(map
            .get_least_superset_key_value(&ClosedInterval { min: 10, max: 17 })
            .map_or(false, |(key, _)| *key
                == ClosedInterval { min: 10, max: 17 }));
        assert!(map
            .get_least_superset_key_value(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
    }
    #[test]
    fn test_remove() {
        let mut map = SupersetMap::new();
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 3 }, ());
        map.insert(ClosedInterval { min: 0, max: 4 }, ());
        map.insert(ClosedInterval { min: 1, max: 4 }, ());
        map.insert(ClosedInterval { min: 4, max: 6 }, ());
        map.insert(ClosedInterval { min: 2, max: 7 }, ());
        map.insert(ClosedInterval { min: 10, max: 17 }, ());
        assert!(map
            .remove_greatest_proper_subset(&ClosedInterval { min: 0, max: 10 })
            .map_or(false, |(key, _)| key == ClosedInterval { min: 2, max: 7 }));
        assert!(map
            .remove_greatest_proper_subset(&ClosedInterval { min: 10, max: 17 })
            .map_or(true, |_| false));
        assert!(map
            .remove_greatest_proper_subset(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .remove_least_proper_superset(&ClosedInterval { min: 3, max: 4 })
            .map_or(false, |(key, _)| key == ClosedInterval { min: 0, max: 4 }));
        assert!(map
            .remove_least_proper_superset(&ClosedInterval { min: 10, max: 17 })
            .map_or(true, |_| false));
        assert!(map
            .remove_least_proper_superset(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .remove_greatest_subset(&ClosedInterval { min: 0, max: 10 })
            .map_or(true, |_| false));
        assert!(map
            .remove_greatest_subset(&ClosedInterval { min: 10, max: 17 })
            .map_or(false, |(key, _)| key == ClosedInterval { min: 10, max: 17 }));
        assert!(map
            .remove_greatest_subset(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        assert!(map
            .remove_least_superset(&ClosedInterval { min: 3, max: 4 })
            .map_or(true, |_| false));
        assert!(map
            .remove_least_superset(&ClosedInterval { min: 10, max: 17 })
            .map_or(true, |_| false));
        assert!(map
            .remove_least_superset(&ClosedInterval { min: 210, max: 217 })
            .map_or(true, |_| false));
        let mut map2 = SupersetMap::new();
        map2.insert(ClosedInterval { min: 0, max: 3 }, ());
        map2.insert(ClosedInterval { min: 0, max: 3 }, ());
        map2.insert(ClosedInterval { min: 0, max: 4 }, ());
        map2.insert(ClosedInterval { min: 1, max: 4 }, ());
        map2.insert(ClosedInterval { min: 4, max: 6 }, ());
        map2.insert(ClosedInterval { min: 2, max: 7 }, ());
        map2.insert(ClosedInterval { min: 10, max: 17 }, ());
        assert!(map2.remove_supersets(&ClosedInterval { min: 0, max: 20 }) == 0);
        assert!(map2.remove_subsets(&ClosedInterval { min: 0, max: 1 }) == 0);
        assert!(map2.remove_subsets(&ClosedInterval { min: 0, max: 20 }) == 3);
        map2.insert(ClosedInterval { min: 0, max: 3 }, ());
        map2.insert(ClosedInterval { min: 0, max: 3 }, ());
        map2.insert(ClosedInterval { min: 0, max: 4 }, ());
        map2.insert(ClosedInterval { min: 1, max: 4 }, ());
        map2.insert(ClosedInterval { min: 4, max: 6 }, ());
        map2.insert(ClosedInterval { min: 2, max: 7 }, ());
        map2.insert(ClosedInterval { min: 10, max: 17 }, ());
        assert!(map2.remove_supersets(&ClosedInterval { min: 3, max: 4 }) == 2);
    }
}