This is a Rust port of the Roaring bitmap data structure, initially defined as a Java library and described in Better bitmap performance with Roaring bitmaps.
This crate only supports the current stable version of Rust, patch releases may use new features at any time.
This project uses Clippy, rustfmt, and denies warnings in CI builds. Available via
rustup component add clippy rustfmt.
To ensure your changes will be accepted please check them with:
cargo fmt -- --check
cargo clippy --all-targets -- -D warnings
In addition, ensure all tests are passing with cargo test
It is recommended to run the cargo bench command.
The benchmarks directory contains a library that is dedicated to benchmarking the
Roaring library by using a set of real-world datasets. It is also advised to run the benchmarks
on a bare-metal machine, running them on the base branch and then on the contribution PR
branch to better see the changes.
Those benchmarks are designed on top of the Criterion library, you can read more about it on the user guide.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.
The simd feature is in active development. It has not been tested. If you would like to build with simd note that
std::simd is only available in Rust nightly.