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
use crate::bits::{BitBlock, BitPos, BitSetView, BitSetViewExt, MAX_LEVEL};
use arrayvec::ArrayVec;
use std::slice;

/// Hierarchical bitset.
/// Each level indicates if any bit is set in the subtree.
/// http://www.cs.loyola.edu/~binkley/papers/tcsrt08-hbit-vectors.pdf
pub struct BitSet<B: BitBlock> {
    capacity: usize,
    set_count: usize,
    top: B,
    levels: ArrayVec<[Vec<B>; MAX_LEVEL]>,
}

impl<B: BitBlock> BitSet<B> {
    pub fn new() -> BitSet<B> {
        BitSet {
            capacity: B::bit_count(),
            set_count: 0,
            top: B::zero(),
            levels: ArrayVec::new(),
        }
    }

    pub fn new_with_capacity(capacity: usize) -> BitSet<B> {
        let mut set = Self::new();
        set.reserve(capacity);
        set
    }

    /// return the number of set bits
    pub fn number_of_set(&self) -> usize {
        self.set_count
    }

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

    pub fn increase_capacity_to(&mut self, capacity: usize) {
        if self.capacity >= capacity {
            return;
        }

        let amount = capacity - self.capacity;
        self.reserve(amount);
    }

    /// Return the count of the bitset that can be stored without (re)allocation.
    pub fn get_capacity(&self) -> usize {
        self.levels.first().map(|l| l.len()).unwrap_or(1) << B::bit_shift()
    }

    /// Reserve memory to store some more bits and return the new capacity.
    /// Capacity is rouned up to the nearest block-size.
    pub fn reserve(&mut self, additional: usize) -> usize {
        let reserved_bits = self.get_capacity();
        let required_bits = reserved_bits + additional;
        let mut bit_count = (required_bits + B::bit_mask()) & !B::bit_mask();
        self.capacity = bit_count;
        let mut level = 0;
        while bit_count > 8 {
            let block_count = (bit_count + B::bit_mask()) >> B::bit_shift();
            if self.levels.len() <= level {
                // append a new level
                self.levels.push(Vec::new());
                let blocks = self.levels.last_mut().unwrap();
                blocks.resize(block_count, B::zero());
                blocks[0] = self.top;
                // after first append, the remaining levels are either 0 or 1
                self.top = if self.top.is_zero() { B::zero() } else { B::one() };
            } else {
                assert!(self.levels[level].len() <= block_count);
                self.levels[level].resize(block_count, B::zero());
            }
            level += 1;
            bit_count = block_count;
        }
        self.capacity
    }

    pub fn get_level(&self, level: usize) -> &[B] {
        assert!(level < self.get_level_count());
        if level < self.levels.len() {
            &self.levels[level]
        } else {
            unsafe { slice::from_raw_parts(&self.top, 1) }
        }
    }

    fn get_level_mut(&mut self, level: usize) -> &mut [B] {
        assert!(level < self.get_level_count());
        if level < self.levels.len() {
            &mut self.levels[level]
        } else {
            unsafe { slice::from_raw_parts_mut(&mut self.top, 1) }
        }
    }

    // Sets a bit of the given level and return if the modification has
    /// effect on the parent levels (block changed from zero to non-zero)
    fn set_level(&mut self, idx: &BitPos<B>) -> bool {
        let block = &mut self.get_level_mut(idx.level())[idx.block()];
        let changed = block.is_zero();
        *block = *block | idx.mask();
        changed
    }

    /// Clears a bit of the given level and return if the modification has
    /// effect on the parent levels (block changed from non-zero to zero)
    fn unset_level(&mut self, idx: &BitPos<B>) -> bool {
        let block = &mut self.get_level_mut(idx.level())[idx.block()];
        let mask = idx.mask();
        let changed = *block == mask;
        *block = *block & !mask;
        changed
    }

    pub fn add(&mut self, pos: usize) -> bool {
        if self.capacity <= pos {
            self.increase_capacity_to(pos + 1);
        }
        let mut idx = BitPos::from_pos(pos, self.get_level_count());

        if self.get(pos) {
            // bit already set
            return true;
        }

        self.set_count += 1;
        // update levels
        while self.set_level(&idx) && idx.level_up() {}
        false
    }

    pub fn remove(&mut self, pos: usize) -> bool {
        if self.capacity <= pos {
            return false;
        }
        let mut idx = BitPos::from_pos(pos, self.get_level_count());

        if !self.get(pos) {
            // bit already cleared
            return false;
        }

        self.set_count -= 1;
        // update levels
        while self.unset_level(&idx) && idx.level_up() {}
        true
    }

    pub fn clear(&mut self) {
        self.capacity = 0;
        self.set_count = 0;
        self.top = B::zero();
        for level in self.levels.iter_mut() {
            level.clear();
        }
    }
}

impl<B: BitBlock> Default for BitSet<B> {
    fn default() -> Self {
        Self::new()
    }
}

impl<B: BitBlock> BitSetView for BitSet<B> {
    type Bits = B;

    fn is_empty(&self) -> bool {
        self.top.is_zero()
    }

    fn get_level_count(&self) -> usize {
        self.levels.len() + 1
    }

    fn get_block(&self, level: usize, block: usize) -> B {
        if level < self.get_level_count() {
            let level = self.get_level(level);
            if block < level.len() {
                level[block]
            } else {
                B::zero()
            }
        } else if self.top.is_zero() || block > 0 {
            B::zero()
        } else {
            B::one()
        }
    }
}

pub type BitSetu8 = BitSet<u8>;
pub type BitSetu16 = BitSet<u16>;
pub type BitSetu32 = BitSet<u32>;
pub type BitSetu64 = BitSet<u64>;
pub type BitSetu128 = BitSet<u128>;