croaring-rs

A Rust wrapper for CRoaring (a C/C++ implementation at https://github.com/RoaringBitmap/CRoaring)

The original java version can be found at https://github.com/RoaringBitmap/RoaringBitmap

Bitmap usage example

```rust use croaring::Bitmap;

let mut rb1 = Bitmap::new(); rb1.add(1); rb1.add(2); rb1.add(3); rb1.add(4); rb1.add(5); rb1.add(100); rb1.add(1000); rb1.run_optimize();

let mut rb2 = Bitmap::new(); rb2.add(3); rb2.add(4); rb2.add(1000); rb2.run_optimize();

let mut rb3 = Bitmap::new();

assert_eq!(rb1.cardinality(), 7); assert!(rb1.contains(3));

rb1.andinplace(&rb2); rb3.add(5); rb3.orinplace(&rb1);

let mut rb4 = Bitmap::fast_or(&[&rb1, &rb2, &rb3]);

rb1.and_inplace(&rb2); println!("{:?}", rb1);

rb3.add(5); rb3.or_inplace(&rb1);

println!("{:?}", rb1);

rb3.add(5); rb3.or_inplace(&rb1);

println!("{:?}", rb3.to_vec()); println!("{:?}", rb3); println!("{:?}", rb4);

rb4 = Bitmap::fast_or(&[&rb1, &rb2, &rb3]);

println!("{:?}", rb4); ```

For 64bit Bitmap support, checkout the Treemap. Treemap is not API-compatible with Bitmap, yet most the functionality is overlapping.

Treemap usage example

```rust use std::u64; use croaring::Treemap;

let mut treemap = Treemap::new(); treemap.add(u64::MAX); treemap.remove(u64::MAX);

/// Serialization compatible with croaring Treemap version at https://github.com/RoaringBitmap/CRoaring/blob/b88b002407b42fafaea23ea5009a54a24d1c1ed4/cpp/roaring64map.hh

use croaring::treemap::NativeSerializer;

let mut treemap1 = Treemap::new();

for i in 100..1000 { treemap1.add(i); }

treemap1.add(std::u32::MAX as u64); treemap1.add(std::u64::MAX);

/// Serialization compatible with JVM Treemap version at https://github.com/RoaringBitmap/RoaringBitmap/blob/34654b2d5c3e75e7f9bca1672f4c0b5800d60cf3/roaringbitmap/src/main/java/org/roaringbitmap/longlong/Roaring64NavigableMap.java use croaring::treemap::JvmSerializer;

let mut treemap2 = Treemap::new();

for i in 100..1000 { treemap2.add(i); }

treemap2.add(std::u32::MAX as u64); treemap2.add(std::u64::MAX); ```

Building

git clone --recursive https://github.com/RoaringBitmap/croaring-rs/ cd croaring-rs cargo build

In croaring-rs, just like in CRoaring, some CPU related code optimizations are enabled dynamically at runtime. If you are building binaries for specific CPU architectures you can specify ROARING_ARCH environment variable to control enabled code optimizations, e.g. ROARING_ARCH=ivybridge cargo build --release.

C binding generation

Since version 0.7.0 croaring-rs ships with pre-generated bindings to CRoaring library in order to speed up builds and remove the need for a recent clang version. However you can revert to old behaviour and generate bindings with bindgen during build time. In order to do it please use buildtime_bindgen feature flag, e.g.:

[dependencies.croaring] version = "0.7" features = ["buildtime_bindgen"]

Testing

Running unit tests and doc tests:

cargo test

Running benchmark suite (currently on Rust nightly toolchain only):

cargo bench

Documentation

Current documentation is available at https://docs.rs/croaring/latest/croaring/