roaring 0.11.4

A better compressed bitset - pure Rust 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

extern crate roaring;
use roaring::{RoaringBitmap, RoaringTreemap};

#[test]
fn smoke() {
    let mut bitmap = RoaringTreemap::new();
    assert_eq!(bitmap.len(), 0);
    assert!(bitmap.is_empty());
    bitmap.remove(0);
    assert_eq!(bitmap.len(), 0);
    assert!(bitmap.is_empty());
    bitmap.insert(1);
    assert!(bitmap.contains(1));
    assert_eq!(bitmap.len(), 1);
    assert!(!bitmap.is_empty());
    bitmap.insert(u64::MAX - 2);
    assert!(bitmap.contains(u64::MAX - 2));
    assert_eq!(bitmap.len(), 2);
    bitmap.insert(u64::MAX);
    assert!(bitmap.contains(u64::MAX));
    assert_eq!(bitmap.len(), 3);
    bitmap.insert(2);
    assert!(bitmap.contains(2));
    assert_eq!(bitmap.len(), 4);
    bitmap.remove(2);
    assert!(!bitmap.contains(2));
    assert_eq!(bitmap.len(), 3);
    assert!(!bitmap.contains(0));
    assert!(bitmap.contains(1));
    assert!(!bitmap.contains(100));
    assert!(bitmap.contains(u64::MAX - 2));
    assert!(!bitmap.contains(u64::MAX - 1));
    assert!(bitmap.contains(u64::MAX));
}

#[test]
fn insert_range() {
    let ranges = 0..0x1000;
    const SIGMA: u64 = u32::MAX as u64;

    let mut bitmap = RoaringTreemap::new();
    assert_eq!(bitmap.insert_range(ranges), 0x1000);
    assert_eq!(bitmap.len(), 0x1000);
    assert_eq!(bitmap.max(), Some(0xFFF));

    assert_eq!(bitmap.insert_range(u32::MAX as u64 - 1..u32::MAX as u64 + 1), 2);
    assert!(bitmap.contains(2));
    assert!(bitmap.contains(0xFFF));
    assert!(!bitmap.contains(0x1000));

    bitmap.clear();
    bitmap.insert_range(2 * SIGMA..=4 * SIGMA);

    assert_eq!(bitmap.min(), Some(2 * SIGMA));
    assert_eq!(bitmap.max(), Some(4 * SIGMA));

    assert!(bitmap.contains(3 * SIGMA));
}

#[test]
fn remove_range() {
    let ranges = [0u64, 1, 63, 64, 65, 100, 4096 - 1, 4096, 4096 + 1, 65536 - 1];
    for (i, &a) in ranges.iter().enumerate() {
        for &b in &ranges[i..] {
            let mut bitmap = (0..=65536).collect::<RoaringTreemap>();
            assert_eq!(bitmap.remove_range(a..b), (b - a));
            assert_eq!(bitmap, ((0..a).chain(b..=65536)).collect::<RoaringTreemap>());
        }
    }
}

#[test]
fn test_max() {
    let mut bitmap = RoaringTreemap::new();
    assert_eq!(bitmap.max(), None);
    bitmap.insert(0);
    assert_eq!(bitmap.max(), Some(0));
    bitmap.insert(1);
    assert_eq!(bitmap.max(), Some(1));
    bitmap.insert(u64::MAX);
    assert_eq!(bitmap.max(), Some(u64::MAX));
}

#[test]
fn test_min() {
    let mut bitmap = RoaringTreemap::new();
    assert_eq!(bitmap.min(), None);
    bitmap.insert(u64::MAX);
    assert_eq!(bitmap.min(), Some(u64::MAX));
    bitmap.insert(1);
    assert_eq!(bitmap.min(), Some(1));
    bitmap.insert(0);
    assert_eq!(bitmap.min(), Some(0));
}

#[test]
fn to_bitmap() {
    let bitmap = (0..5000).collect::<RoaringTreemap>();
    assert_eq!(bitmap.len(), 5000);
    for i in 1..5000 {
        assert!(bitmap.contains(i));
    }
    assert!(!bitmap.contains(5001));
}

#[test]
fn to_array() {
    let mut bitmap = (0..5000).collect::<RoaringTreemap>();
    for i in 3000..5000 {
        bitmap.remove(i);
    }
    assert_eq!(bitmap.len(), 3000);
    for i in 0..3000 {
        assert!(bitmap.contains(i));
    }
    for i in 3000..5000 {
        assert!(!bitmap.contains(i));
    }
}

#[test]
fn optimize_prunes_empty_bitmaps_and_returns_true() {
    let mut treemap = RoaringTreemap::from_bitmaps([
        (0, RoaringBitmap::new()),
        (1, RoaringBitmap::from_iter([1337])),
        (2, RoaringBitmap::new()),
    ]);

    assert_eq!(
        treemap.bitmaps().map(|(partition, _)| partition).collect::<Vec<_>>(),
        vec![0, 1, 2],
    );

    assert!(treemap.optimize());

    assert_eq!(treemap.bitmaps().map(|(partition, _)| partition).collect::<Vec<_>>(), vec![1],);
    assert_eq!(treemap.iter().collect::<Vec<_>>(), vec![(1_u64 << 32) | 1337]);
}

#[test]
fn optimize_works_for_single_shard() {
    // Mirrors `optimize_run` from `tests/lib.rs` to show the treemap forwards
    // optimization to its child bitmap when there are no empty partitions to prune.
    let values = 1000_u64..10000;
    let expected = values.clone().collect::<Vec<_>>();

    let mut treemap = RoaringTreemap::from_iter(values);

    assert!(treemap.optimize());
    assert_eq!(treemap.iter().collect::<Vec<_>>(), expected);
    assert!(!treemap.optimize());
}

#[test]
fn optimize_returns_false_when_nothing_changes() {
    let mut treemap = RoaringTreemap::from_iter([1_u64, 5, 9]);

    assert!(!treemap.optimize());
    assert_eq!(treemap.iter().collect::<Vec<_>>(), vec![1, 5, 9]);
}