indexical 0.6.0

Utilities for indexed collections
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

//! A bit-set based on [`RoaringBitmap`].
//!
//! If you want roaring's SIMD support, add `roaring-simd` to
//! your indexical feature list.

pub use roaring::{self, RoaringBitmap};

use crate::{
    bitset::BitSet,
    pointer::{ArcFamily, RcFamily, RefFamily},
};

/// Wrapper around a [`RoaringBitmap`] that includes the domain size.
#[derive(PartialEq, Clone)]
pub struct RoaringSet {
    set: RoaringBitmap,
    size: usize,
}

fn to_usize(i: u32) -> usize {
    i as usize
}

impl BitSet for RoaringSet {
    type Iter<'a> = std::iter::Map<roaring::bitmap::Iter<'a>, fn(i: u32) -> usize>;

    fn empty(size: usize) -> Self {
        RoaringSet {
            set: RoaringBitmap::new(),
            size,
        }
    }

    fn insert(&mut self, index: usize) -> bool {
        self.set.insert(index as u32)
    }

    fn contains(&self, index: usize) -> bool {
        self.set.contains(index as u32)
    }

    fn iter(&self) -> Self::Iter<'_> {
        self.set.iter().map(to_usize)
    }

    fn len(&self) -> usize {
        self.set.len() as usize
    }

    fn union(&mut self, other: &Self) {
        self.set |= &other.set;
    }

    fn intersect(&mut self, other: &Self) {
        self.set &= &other.set;
    }

    fn subtract(&mut self, other: &Self) {
        self.set -= &other.set;
    }

    fn invert(&mut self) {
        for i in 0..self.size {
            if self.set.contains(i as u32) {
                self.set.remove(i as u32);
            } else {
                self.set.insert(i as u32);
            }
        }
    }

    fn clear(&mut self) {
        self.set.clear();
    }

    fn insert_all(&mut self) {
        self.set.insert_range(0..(self.size as u32));
    }

    fn copy_from(&mut self, other: &Self) {
        self.set.clone_from(&other.set);
    }
}

/// [`IndexSet`](crate::IndexSet) specialized to the [`RoaringSet`] implementation.
pub type IndexSet<T> = crate::IndexSet<'static, T, RoaringSet, RcFamily>;

/// [`IndexSet`](crate::IndexSet) specialized to the [`RoaringSet`] implementation with the [`ArcFamily`].
pub type ArcIndexSet<'a, T> = crate::IndexSet<'a, T, RoaringSet, ArcFamily>;

/// [`IndexSet`](crate::IndexSet) specialized to the [`RoaringSet`] implementation with the [`RefFamily`].
pub type RefIndexSet<'a, T> = crate::IndexSet<'a, T, RoaringSet, RefFamily<'a>>;

/// [`IndexMatrix`](crate::IndexMatrix) specialized to the [`RoaringSet`] implementation.
pub type IndexMatrix<R, C> = crate::IndexMatrix<'static, R, C, RoaringSet, RcFamily>;

/// [`IndexMatrix`](crate::IndexMatrix) specialized to the [`RoaringSet`] implementation with the [`ArcFamily`].
pub type ArcIndexMatrix<R, C> = crate::IndexMatrix<'static, R, C, RoaringSet, ArcFamily>;

/// [`IndexMatrix`](crate::IndexMatrix) specialized to the [`RoaringSet`] implementation with the [`RefFamily`].
pub type RefIndexMatrix<'a, R, C> = crate::IndexMatrix<'a, R, C, RoaringSet, RefFamily<'a>>;

#[test]
fn test_roaring() {
    crate::test_utils::impl_test::<RoaringSet>();
}