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

位图使用示例

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.and_inplace(&rb2);
rb3.add(5);
rb3.or_inplace(&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);

对于64位位图支持，请查看Treemap. Treemap与Bitmap不兼容API，但大多数功能重叠。

Treemap使用示例

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);

构建

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

在croaring-rs中，与CRoaring一样，一些与CPU相关的代码优化在运行时动态启用。如果您为特定的CPU架构构建二进制文件，可以指定ROARING_ARCH环境变量来控制启用的代码优化，例如ROARING_ARCH=ivybridge cargo build --release。

测试

运行单元测试和文档测试

cargo test

运行基准测试套件（目前仅在Rust nightly工具链上）

cargo bench

文档

当前文档可在https://docs.rs/croaring/latest/croaring/找到

CRoaring版本

此crate使用CRoaring版本4.1.1。此crate的版本不一定与CRoaring版本匹配：crate的主版本号仅在Rust API发生重大更改时增加：CRoaring C API的更改不一定会导致此crate的主版本号增加（实际上已经发生过这种情况）。