Repository files navigation

This is aRust port of theRoaring bitmap data structure, initiallydefined as aJava library and described inBetter bitmapperformance with Roaring bitmaps.

This crate only supports the current stable version of Rust, patch releases mayuse new features at any time.

This project usesClippy,rustfmt, and denies warnings in CI builds. Available viarustup component add clippy rustfmt.

To ensure your changes will be accepted please check them with:

cargo fmt -- --checkcargo clippy --all-targets -- -D warnings

In addition, ensure all tests are passing withcargo test

It is recommended to run thecargo bench command.Thebenchmarks directory contains a library that is dedicated to benchmarking theRoaring library by using a set ofreal-world datasets. It is also advised to run the benchmarkson a bare-metal machine, running them on the base branch and then on the contribution PRbranch to better see the changes.

Those benchmarks are designed on top of the Criterion library,you can read more about iton the user guide.

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE orhttps://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttps://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in the work by you shall be dual licensed as above, without anyadditional terms or conditions.

Thesimd feature is in active development. It has not been tested. If you would like to build withsimd note thatstd::simd is only available in Rust nightly.