const_sized_bit_set 0.5.0

Bitsets of all sizes an extensive array of associated functions.
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
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
use crate::SetElement;
use crate::iterator::BitSetIterator;
use core::fmt::{self, Binary, LowerHex, UpperHex};
#[cfg(any(test, feature = "serde"))]
use serde::{Deserialize, Serialize};

macro_rules! define_bit_set_n {
    ($name:ident, $inner: ty) => {
        #[must_use]
        #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
        #[cfg_attr(any(test, feature = "serde"), derive(Serialize, Deserialize))]
        pub struct $name($inner);

        impl $name {
            pub const EMPTY: Self = Self(0);
            pub const ALL: Self = Self(<$inner>::MAX);
            pub const CAPACITY: SetElement = <$inner>::BITS;

            #[must_use]
            #[inline]
            pub const fn is_empty_const(&self) -> bool {
                self.0 == 0
            }

            #[must_use]
            #[inline]
            pub const fn is_all_const(&self) -> bool {
                self.0 == Self::ALL.0
            }

            #[inline]
            pub const fn clear_const(&mut self) {
                self.0 = Self::EMPTY.0;
            }

            /// Returns the number of elements in the set
            #[must_use]
            #[inline]
            pub const fn count_const(&self) -> SetElement {
                self.len_const()
            }

            /// Returns the number of elements in the set
            #[must_use]
            #[inline]
            pub const fn len_const(&self) -> SetElement {
                self.0.count_ones()
            }

            /// The inner value of the set
            #[must_use]
            #[inline]
            pub const fn into_inner_const(&self) -> $inner {
                self.0
            }

            /// Creates a new set from an inner value
            #[must_use]
            #[inline]
            pub const fn from_inner_const(inner: $inner) -> Self {
                Self(inner)
            }

            /// Whether this set contains the element
            #[must_use]
            pub const fn contains_const(&self, element: SetElement) -> bool {
                debug_assert!(
                    element < Self::CAPACITY,
                    "Element is too big to be contained in bitset"
                );
                (self.0 >> element) & 1 == 1
            }

            /// Whether two sets are equal
            #[inline]
            #[must_use]
            pub const fn eq_const(&self, rhs: &Self) -> bool {
                self.0 == rhs.0
            }

            /// Returns the negation of a set
            /// The negation contains exactly those elements which are not in the original set
            #[inline]
            pub const fn negate_const(&mut self) {
                self.0 = !self.0
            }

            #[inline]
            pub const fn reverse_const(&mut self) {
                self.0 = self.0.reverse_bits();
            }

            /// Insert an element into the set
            /// Returns whether the element was inserted (it was not already present)
            #[inline]
            pub const fn insert_const(&mut self, element: SetElement) -> bool {
                debug_assert!(
                    element < Self::CAPACITY,
                    "Element is too big to insert into bitset"
                );

                let mask = 1 << element;
                let r = self.0 & mask == 0;

                self.0 |= mask;
                r
            }

            /// Toggle the value of an element.
            /// Returns the new value.
            #[inline]
            pub const fn toggle_const(&mut self, element: SetElement) -> bool {
                debug_assert!(
                    element < Self::CAPACITY,
                    "Element is too big to insert into bitset"
                );

                let mask = 1 << element;

                self.0 ^= mask;
                self.0 & mask != 0
            }

            /// Remove an element from the set
            /// Returns whether the element was removed (was previously present)
            #[inline]
            pub const fn remove_const(&mut self, element: SetElement) -> bool {
                debug_assert!(
                    element < Self::CAPACITY,
                    "Element is too big to remove from bitset"
                );
                let mask = 1 << element;
                let r = self.0 & mask != 0;
                self.0 &= !mask;
                r
            }

            /// Create a set of the elements 0..n
            #[must_use]
            #[inline]
            pub const fn from_first_n_const(n: SetElement) -> Self {
                debug_assert!(
                    n <= Self::CAPACITY,
                    "Too many elements to create bitset from first n"
                );

                if n == Self::CAPACITY {
                    Self::ALL
                } else {
                    let inner = !(<$inner>::MAX << n);
                    Self(inner)
                }
            }

            /// Swap the values of the bits at i and j
            #[inline]
            pub const fn swap_bits_const(&mut self, i: SetElement, j: SetElement) {
                debug_assert!(
                    i <= Self::CAPACITY,
                    "Element i is too big to swap in bitset"
                );
                debug_assert!(
                    j <= Self::CAPACITY,
                    "Element J is too big to swap in bitset"
                );

                let x = (self.0 >> i ^ self.0 >> j) & 1;
                self.0 ^= x << i | x << j;
            }

            #[inline]
            pub const fn intersect_with_const(&mut self, rhs: &Self) {
                self.0 &= rhs.0
            }

            pub const fn union_with_const(&mut self, rhs: &Self) {
                self.0 |= rhs.0
            }

            pub const fn except_with_const(&mut self, rhs: &Self) {
                let mut o = *rhs;
                o.negate_const();
                self.intersect_with_const(&o)
            }

            ///Changes this set to contain only the elements that are either currently present or present in `rhs` but not both.
            pub const fn symmetric_difference_with_const(&mut self, rhs: &Self) {
                self.0 ^= rhs.0
            }

            #[must_use]
            #[inline]
            pub const fn is_subset_const(&self, rhs: &Self) -> bool {
                let mut s = *self;
                s.intersect_with_const(rhs);
                s.eq_const(self)
            }

            #[must_use]
            #[inline]
            pub const fn is_superset_const(&self, rhs: &Self) -> bool {
                rhs.is_subset_const(self)
            }

            #[must_use]
            pub const fn overlaps_const(&self, rhs: &Self) -> bool {
                let mut s = *self;
                s.intersect_with_const(rhs);
                !s.eq_const(&Self::EMPTY)
            }

            /// Returns the first (minimum) element in this set
            #[must_use]
            #[inline]
            #[doc(alias = "min_const")]
            pub const fn first_const(&self) -> Option<SetElement> {
                if self.0 == 0 {
                    return None;
                }
                let element = self.0.trailing_zeros();

                return Some(element);
            }

            /// Returns the first (minimum) element in this set
            #[must_use]
            #[inline]
            #[doc(alias = "max_const")]
            pub const fn last_const(&self) -> Option<SetElement> {
                if self.0 == 0 {
                    return None;
                }
                let element = (Self::CAPACITY - 1) - self.0.leading_zeros();
                return Some(element);
            }

            /// The removes the first (smallest) element of the set and returns it
            /// Returns `None` if the set is empty
            #[must_use]
            #[inline]
            pub const fn pop_const(&mut self) -> Option<SetElement> {
                if self.0 == 0 {
                    return None;
                }
                let tz = self.0.trailing_zeros();

                let t = self.0 & (<$inner>::MIN.wrapping_sub(self.0));
                self.0 ^= t;

                return Some(tz);
            }

            /// Removes the last (biggest) element of the set and returns it
            /// Returns `None` if the set is empty
            #[must_use]
            #[inline]
            pub const fn pop_last_const(&mut self) -> Option<SetElement> {
                if self.0 == 0 {
                    return None;
                }
                let element = (Self::CAPACITY - 1) - self.0.leading_zeros();

                self.0 ^= (1 << element);
                return Some(element);
            }

            /// Returns the number of elements less than `element` in the set
            /// Returns the same result regardless of whether `element` is present
            #[must_use]
            #[inline]
            pub const fn count_lesser_elements_const(&self, element: SetElement) -> u32 {
                let shift = Self::CAPACITY - element;

                match self.0.checked_shl(shift) {
                    Some(x) => x.count_ones(),
                    None => 0,
                }
            }

            /// Returns the number of elements less than `element` in the set
            /// Returns the same result regardless of whether `element` is present
            #[must_use]
            #[inline]
            pub const fn count_greater_elements_const(&self, element: SetElement) -> u32 {
                let shift = element + 1;

                match self.0.checked_shr(shift) {
                    Some(x) => x.count_ones(),
                    None => 0,
                }
            }

            /// Returns the n+1th element present in the set, if there are at least n + 1 elements
            /// To return the first element, use n == 0
            #[must_use]
            #[inline]
            pub const fn nth_const(&self, n: u32) -> Option<SetElement> {
                if n >= self.0.count_ones() {
                    return None;
                }

                let desired_ones = self.0.count_ones() - n;

                let mut shifted_away = 0u32;
                let mut remaining = self.0;

                let mut chunk_size = Self::CAPACITY / 2;

                // Note I have tested a branchless version of this, but it seems slower
                loop {
                    let r = remaining.unbounded_shr(chunk_size);
                    if r.count_ones() == desired_ones {
                        return Some(shifted_away + chunk_size + r.trailing_zeros());
                    }
                    let cmp = (r.count_ones() > desired_ones) as u32;
                    shifted_away += cmp * chunk_size;
                    remaining = remaining.unbounded_shr(chunk_size * cmp);
                    chunk_size /= 2;
                }
            }

            /// Return the smallest element greater than `index`
            /// Will return `None` if no such element exists
            /// Will return the same regardless of whether `element` is present
            #[must_use]
            #[inline]
            pub const fn smallest_element_greater_than_const(
                &self,
                index: SetElement,
            ) -> Option<SetElement> {
                let Some(inner) = self.into_inner_const().checked_shr(index.wrapping_add(1)) else {
                    return None;
                };
                if inner == 0 {
                    return None;
                }
                return Some(inner.trailing_zeros() + index + 1);
            }

            /// Return the largest element less than `index`
            /// Will return `None` if no such element exists
            /// Will return the same regardless of whether `element` is present
            #[must_use]
            #[inline]
            pub const fn largest_element_less_than_const(
                &self,
                index: SetElement,
            ) -> Option<SetElement> {
                let Some(inner) = self
                    .into_inner_const()
                    .checked_shl(Self::CAPACITY.wrapping_sub(index))
                else {
                    return None;
                };
                if inner == 0 {
                    return None;
                }
                return Some(index - 1 - inner.leading_zeros());
            }

            #[must_use]
            pub const fn iter_const(&self) -> BitSetIterator<Self> {
                BitSetIterator::new(*self)
            }

            #[must_use]
            pub const fn trailing_ones_const(&self) -> u32 {
                self.0.trailing_ones()
            }

            pub const fn shift_right_const(&mut self, n: SetElement) {
                self.0 >>= n
            }

            pub const fn shift_left_const(&mut self, n: SetElement) {
                self.0 <<= n
            }
        }

        impl Extend<SetElement> for $name {
            fn extend<T: IntoIterator<Item = SetElement>>(&mut self, iter: T) {
                for x in iter {
                    self.insert_const(x);
                }
            }
        }

        impl FromIterator<SetElement> for $name {
            fn from_iter<T: IntoIterator<Item = SetElement>>(iter: T) -> Self {
                let mut set = Self::default();
                set.extend(iter);
                set
            }
        }

        impl IntoIterator for $name {
            type Item = SetElement;
            type IntoIter = BitSetIterator<Self>;

            fn into_iter(self) -> Self::IntoIter {
                BitSetIterator::new(self)
            }
        }
    };
}

define_bit_set_n!(BitSet8, u8);
define_bit_set_n!(BitSet16, u16);
define_bit_set_n!(BitSet32, u32);
define_bit_set_n!(BitSet64, u64);
define_bit_set_n!(BitSet128, u128);

macro_rules! impl_binary_debug {
    ($set: ty, $name: expr) => {
        impl core::fmt::Debug for $set {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                write!(f, "{}(0b{:b})", $name, self.0)
            }
        }
    };
}

macro_rules! impl_hex_debug {
    ($set: ty, $name: expr) => {
        impl fmt::Debug for $set {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                write!(f, "{}(0x{:x})", $name, self.0)
            }
        }
    };
}

macro_rules! impl_binary_and_hex {
    ($set: ty) => {
        impl core::fmt::Binary for $set {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                Binary::fmt(&self.0, f)
            }
        }

        impl core::fmt::LowerHex for $set {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                LowerHex::fmt(&self.0, f)
            }
        }

        impl core::fmt::UpperHex for $set {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                UpperHex::fmt(&self.0, f)
            }
        }
    };
}

impl_binary_debug!(BitSet8, "BitSet8");
impl_binary_debug!(BitSet16, "BitSet16");
impl_hex_debug!(BitSet32, "BitSet32");
impl_hex_debug!(BitSet64, "BitSet64");
impl_hex_debug!(BitSet128, "BitSet128");

impl_binary_and_hex!(BitSet8);
impl_binary_and_hex!(BitSet16);
impl_binary_and_hex!(BitSet32);
impl_binary_and_hex!(BitSet64);
impl_binary_and_hex!(BitSet128);

#[cfg(test)]
mod tests {
    use crate::prelude::*;

    #[test]
    fn test_serde_empty() {
        use serde_test::*;
        let set = BitSet16::EMPTY;

        assert_tokens(
            &set,
            &[Token::NewtypeStruct { name: "BitSet16" }, Token::U16(0)],
        );
    }

    #[test]
    fn test_serde() {
        use serde_test::*;
        let set = BitSet16::from_fn(|x| x % 2 == 1);

        assert_tokens(
            &set,
            &[
                Token::NewtypeStruct { name: "BitSet16" },
                Token::U16(0b1010101010101010),
            ],
        );
    }

    #[test]
    fn test_bit_set16() {
        assert_eq!(BitSet16::from_inner(0b1101).count(), 3);

        assert_eq!(
            BitSet16::from_inner(0b1101).with_inserted(1).into_inner(),
            0b1111
        );

        assert_eq!(BitSet16::from_inner(0b1101).into_inner(), 0b1101);

        assert_eq!(BitSet16::from_fn(|x| x == 2), BitSet16::from_inner(0b0100));

        assert!(!BitSet16::from_inner(0b0100).is_empty());
        assert!(BitSet16::from_inner(0b0000).is_empty());

        let set1 = BitSet16::from_inner(0b1110);
        let negated = set1.with_negated();
        assert_eq!(set1.with_union(&negated), BitSet16::ALL);
        assert_eq!(set1.with_intersect(&negated), BitSet16::EMPTY);

        assert_eq!(
            BitSet16::from_inner(0b0010).with_inserted(2),
            BitSet16::from_inner(0b0110)
        );

        assert_eq!(
            BitSet16::from_inner(0b0110).with_removed(2),
            BitSet16::from_inner(0b0010)
        );

        assert_eq!(
            BitSet16::from_inner(0b0110)
                .with_bit_set(3, true)
                .with_bit_set(2, false),
            BitSet16::from_inner(0b1010)
        );

        assert_eq!(BitSet16::from_first_n(3), BitSet16::from_inner(0b111));

        assert_eq!(
            BitSet16::from_inner(0b10),
            BitSet16::from_inner(0b01).with_bits_swapped(0, 1)
        );

        assert_eq!(
            BitSet16::from_inner(0b001),
            BitSet16::from_inner(0b101).with_intersect(&BitSet16::from_inner(0b011))
        );

        assert_eq!(
            BitSet16::from_inner(0b111),
            BitSet16::from_inner(0b101).with_union(&BitSet16::from_inner(0b011))
        );

        assert_eq!(
            BitSet16::from_inner(0b0100),
            BitSet16::from_inner(0b0111).with_except(&BitSet16::from_inner(0b0011))
        );

        assert!(BitSet16::from_inner(0b0101).is_subset(&BitSet16::from_inner(0b1101)));

        assert!(BitSet16::from_inner(0b1101).is_superset_const(&BitSet16::from_inner(0b0101)));

        assert!(BitSet16::from_inner(0b1101).overlaps_const(&BitSet16::from_inner(0b0101)));

        assert!(!BitSet16::from_inner(0b1010).overlaps_const(&BitSet16::from_inner(0b0101)));

        assert!(BitSet16::from_inner(0b100).contains(2));
        assert!(!BitSet16::from_inner(0b100).contains(1));

        assert_eq!(BitSet16::from_inner(0b1100).first(), Some(2));
        assert_eq!(BitSet16::from_inner(0b0000).first(), None);

        assert_eq!(BitSet16::from_inner(0b1100).last(), Some(3));
        assert_eq!(BitSet16::from_inner(0b0000).last(), None);

        let mut set = BitSet16::from_inner(0b1100);
        assert_eq!(set.pop(), Some(2));
        assert_eq!(set.pop(), Some(3));
        assert_eq!(set.pop(), None);

        let mut set = BitSet16::from_inner(0b1100);
        assert_eq!(set.pop_last(), Some(3));
        assert_eq!(set.pop_last(), Some(2));
        assert_eq!(set.pop_last(), None);

        assert_eq!(
            BitSet16::from_first_n(8).min_set_by_key(|x| x % 2),
            BitSet16::from_inner(0b01010101)
        );
    }

    #[test]
    fn test_nth_const() {
        assert_eq!(BitSet8::EMPTY.nth_const(0), None);
        assert_eq!(BitSet8::EMPTY.nth_const(1), None);

        assert_eq!(BitSet8::from_inner(0b01010101).nth_const(0), Some(0));
        assert_eq!(BitSet8::from_inner(0b01010101).nth_const(1), Some(2));
        assert_eq!(BitSet8::from_inner(0b01010101).nth_const(2), Some(4));
        assert_eq!(BitSet8::from_inner(0b01010101).nth_const(3), Some(6));
        assert_eq!(BitSet8::from_inner(0b01010101).nth_const(4), None);

        assert_eq!(BitSet8::ALL.nth_const(0), Some(0));
        assert_eq!(BitSet8::ALL.nth_const(1), Some(1));
        assert_eq!(BitSet8::ALL.nth_const(7), Some(7));
        assert_eq!(BitSet8::ALL.nth_const(8), None);

        assert_eq!(BitSet64::EMPTY.nth_const(0), None);
        assert_eq!(BitSet64::EMPTY.nth_const(1), None);

        assert_eq!(BitSet64::from_inner(0b01010101).nth_const(0), Some(0));
        assert_eq!(BitSet64::from_inner(0b01010101).nth_const(1), Some(2));
        assert_eq!(BitSet64::from_inner(0b01010101).nth_const(2), Some(4));
        assert_eq!(BitSet64::from_inner(0b01010101).nth_const(3), Some(6));
        assert_eq!(BitSet64::from_inner(0b01010101).nth_const(4), None);

        assert_eq!(BitSet64::ALL.nth_const(0), Some(0));
        assert_eq!(BitSet64::ALL.nth_const(1), Some(1));
        assert_eq!(BitSet64::ALL.nth_const(7), Some(7));
        assert_eq!(BitSet64::ALL.nth_const(63), Some(63));
        assert_eq!(BitSet64::ALL.nth_const(64), None);
    }
    #[test]
    fn test_count_lesser_elements() {
        assert_eq!(BitSet8::EMPTY.count_lesser_elements_const(0), 0);
        assert_eq!(BitSet8::EMPTY.count_lesser_elements_const(1), 0);

        assert_eq!(
            BitSet8::from_inner(0b01010101).count_lesser_elements_const(0),
            0
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_lesser_elements_const(1),
            1
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_lesser_elements_const(2),
            1
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_lesser_elements_const(3),
            2
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_lesser_elements_const(4),
            2
        );

        assert_eq!(BitSet8::ALL.count_lesser_elements_const(0), 0);
        assert_eq!(BitSet8::ALL.count_lesser_elements_const(1), 1);
        assert_eq!(BitSet8::ALL.count_lesser_elements_const(7), 7);
        assert_eq!(BitSet8::ALL.count_lesser_elements_const(8), 8);
    }

    #[test]
    fn test_count_greater_elements() {
        assert_eq!(BitSet8::EMPTY.count_greater_elements_const(0), 0);
        assert_eq!(BitSet8::EMPTY.count_greater_elements_const(1), 0);
        assert_eq!(BitSet8::EMPTY.count_greater_elements_const(7), 0);
        assert_eq!(BitSet8::EMPTY.count_greater_elements_const(8), 0);

        assert_eq!(
            BitSet8::from_inner(0b01010101).count_greater_elements_const(0),
            3
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_greater_elements_const(1),
            3
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_greater_elements_const(2),
            2
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_greater_elements_const(3),
            2
        );
        assert_eq!(
            BitSet8::from_inner(0b01010101).count_greater_elements_const(4),
            1
        );

        assert_eq!(BitSet8::ALL.count_greater_elements_const(0), 7);
        assert_eq!(BitSet8::ALL.count_greater_elements_const(1), 6);
        assert_eq!(BitSet8::ALL.count_greater_elements_const(7), 0);
        assert_eq!(BitSet8::ALL.count_greater_elements_const(8), 0);
    }

    #[test]
    fn test_largest_element_less_than() {
        let set = BitSet8::from_fn(|x| x % 2 == 0);

        for e in 0..=8u32 {
            let expected = if e % 2 == 0 {
                e.checked_sub(2)
            } else {
                e.checked_sub(1)
            };
            let actual = set.largest_element_less_than(e);
            assert_eq!(actual, expected);
        }
    }

    #[test]
    fn test_smallest_element_greater_than() {
        let set = BitSet8::from_fn(|x| x % 2 == 0);

        for e in 0..=8u32 {
            let expected = if e % 2 == 0 { e + 2 } else { e + 1 };
            let expected = if expected >= 8 { None } else { Some(expected) };
            let actual = set.smallest_element_greater_than(e);
            assert_eq!(actual, expected, "e = {e}");
        }
    }

    #[test]
    fn test_reverse() {
        let set = BitSet8::from_fn(|x| x % 2 == 0);
        let expected_set = BitSet8::from_fn(|x| x % 2 == 1);

        assert_eq!(set.with_reversed(), expected_set);
    }

    #[test]
    fn test_retain() {
        let mut set = BitSet128::from_fn(|x| x % 2 == 0);
        let mut c = 0;
        set.retain(|e| {
            c += e;
            e % 3 == 0
        });

        assert_eq!(c, 4032);

        let expected = BitSet128::from_fn(|x| x % 6 == 0);

        assert_eq!(set, expected);
    }

    #[test]
    fn test_clear() {
        let mut set = BitSet128::from_fn(|x| x % 2 == 0);
        set.clear_const();
        assert!(set.is_empty_const());
    }

    #[test]
    fn test_formatting() {
        let bitset8_formatted = format!(
            "{s:?} {s:b} {s:x} {s:X} {s:#b} {s:#x} {s:#X}",
            s = BitSet8::ALL
        );
        assert_eq!(
            bitset8_formatted,
            "BitSet8(0b11111111) 11111111 ff FF 0b11111111 0xff 0xFF"
        );

        let bitset16_formatted = format!(
            "{s:?} {s:b} {s:x} {s:X} {s:#b} {s:#x} {s:#X}",
            s = BitSet16::ALL
        );
        assert_eq!(
            bitset16_formatted,
            "BitSet16(0b1111111111111111) 1111111111111111 ffff FFFF 0b1111111111111111 0xffff 0xFFFF"
        );

        let bitset32_formatted = format!(
            "{s:?} {s:b} {s:x} {s:X} {s:#b} {s:#x} {s:#X}",
            s = BitSet32::ALL
        );
        assert_eq!(
            bitset32_formatted,
            "BitSet32(0xffffffff) 11111111111111111111111111111111 ffffffff FFFFFFFF 0b11111111111111111111111111111111 0xffffffff 0xFFFFFFFF"
        );

        let bitset64_formatted = format!(
            "{s:?} {s:b} {s:x} {s:X} {s:#b} {s:#x} {s:#X}",
            s = BitSet64::ALL
        );
        assert_eq!(
            bitset64_formatted,
            "BitSet64(0xffffffffffffffff) 1111111111111111111111111111111111111111111111111111111111111111 ffffffffffffffff FFFFFFFFFFFFFFFF 0b1111111111111111111111111111111111111111111111111111111111111111 0xffffffffffffffff 0xFFFFFFFFFFFFFFFF"
        );

        let bitset128_formatted = format!(
            "{s:?} {s:b} {s:x} {s:X} {s:#b} {s:#x} {s:#X}",
            s = BitSet128::ALL
        );
        assert_eq!(
            bitset128_formatted,
            "BitSet128(0xffffffffffffffffffffffffffffffff) 11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111 ffffffffffffffffffffffffffffffff FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF 0b11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111 0xffffffffffffffffffffffffffffffff 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
        );
    }
}