19 releases

0.6.3 Feb 16, 2020
0.6.2 Jul 26, 2019
0.6.1 Jun 28, 2019
0.5.4 Jan 4, 2019
0.1.3 Jun 15, 2017

#25 in Data structures

Download history 2983/week @ 2019-12-15 2196/week @ 2019-12-22 3369/week @ 2019-12-29 3363/week @ 2020-01-05 4116/week @ 2020-01-12 3461/week @ 2020-01-19 3035/week @ 2020-01-26 2673/week @ 2020-02-02 3819/week @ 2020-02-09 4019/week @ 2020-02-16 3725/week @ 2020-02-23 3260/week @ 2020-03-01 3042/week @ 2020-03-08 4237/week @ 2020-03-15 3640/week @ 2020-03-22 4339/week @ 2020-03-29

14,901 downloads per month
Used in 173 crates (19 directly)

MIT/Apache

84KB
2K SLoC

hibitset

Build Status Crates.io

Provides hierarchical bit sets, which allow very fast iteration on sparse data structures.

Usage

Just add this to your Cargo.toml:

[dependencies]
hibitset = "0.6"

License

This library is licensed under the Apache License 2.0, see the LICENSE file for more information.


lib.rs:

hibitset

Provides hierarchical bit sets, which allow very fast iteration on sparse data structures.

What it does

A BitSet may be considered analogous to a HashSet<u32>. It tracks whether or not certain indices exist within it. Its implementation is very different, however.

At its root, a BitSet relies on an array of bits, which express whether or not indices exist. This provides the functionality to add( ) and remove( ) indices.

This array is referred to as Layer 0. Above it, there is another layer: Layer 1. Layer 1 acts as a 'summary' of Layer 0. It contains one bit for each usize bits of Layer 0. If any bit in that usize of Layer 0 is set, the bit in Layer 1 will be set.

There are, in total, four layers. Layers 1 through 3 are each a a summary of the layer immediately below them.

Example, with an imaginary 4-bit usize:

Layer 3: 1------------------------------------------------ ...
Layer 2: 1------------------ 1------------------ 0-------- ...
Layer 1: 1--- 0--- 0--- 0--- 1--- 0--- 1--- 0--- 0--- 0--- ...
Layer 0: 0010 0000 0000 0000 0011 0000 1111 0000 0000 0000 ...

This method makes operations that operate over the whole BitSet, such as unions, intersections, and iteration, very fast (because if any bit in any summary layer is zero, an entire range of bits below it can be skipped.)

However, there is a maximum on index size. The top layer (Layer 3) of the BitSet is a single usize long. This makes the maximum index usize**4 (1,048,576 for a 32-bit usize, 16,777,216 for a 64-bit usize). Attempting to add indices larger than that will cause the BitSet to panic.

Dependencies

~72–305KB