The bitvector from filipncs

bitvector's Introduction

bitvector, a simple bitvector implementation in Rust-lang

This crate is a modification of librustc_data_structures/bitvec.rs for set operator support.

Documentation

Visit the online documentation or run

cargo doc

to generate a local copy.

How to use

Add the following line to [dependencies] in your Cargo.toml file:

bitvector = 0.1

Then you can use the BitVector:

extern crate bitvector;
use bitvector::*;

fn main() {
    let mut test_vec = BitVector::new(50);
    for i in vec![0,1,3,5,7,11,13,17,19,23] { test_vec.insert(i); }

    let mut test_vec2 = BitVector::new(50);
    for i in vec![3,5,9,13,19,40,45] { test_vec2.insert(i); }

    // union of test_vec and test_vec2
    // other possible operators: intersection, difference
    let union = test_vec.union(&test_vec2);


    assert!(union.contains(3));
    assert!(union.contains(5));
    assert!(union.contains(13));
    assert!(union.contains(19));
    assert!(union.contains(9));
    assert!(union.contains(40));

    // all the operators also have `*_inplace` variants
    // which directly modify `self` to avoid extra memory operations.
    test_vec.union_inplace(&test_vec2);

    assert!(test_vec.contains(3));
    assert!(test_vec.contains(5));
    assert!(test_vec.contains(13));
    assert!(test_vec.contains(19));
    assert!(test_vec.contains(0));
    assert!(test_vec.contains(9));
    assert!(test_vec.contains(40));
}

Performance Comparison against std::collections::{HashSet,BTreeSet}

test bench::bench_bitset_operator         ... bench:         610 ns/iter (+/- 114)
test bench::bench_bitset_operator_inplace ... bench:         377 ns/iter (+/- 21)
test bench::bench_btreeset_operator       ... bench:       2,782 ns/iter (+/- 169)
test bench::bench_hashset_operator        ... bench:       3,490 ns/iter (+/- 395)