Struct RoaringBitmap 

pub struct RoaringBitmap { /* private fields */ }

A compressed bitset for u32 values using the Roaring Bitmap format.

Example

use akar_storage::roaring_bitmap::RoaringBitmap;

let mut rb = RoaringBitmap::new();
rb.add(42);
rb.add(100000);
assert!(rb.contains(42));
assert!(!rb.contains(0));
assert_eq!(rb.len(), 2);

Implementations

impl RoaringBitmap

pub fn new() -> Self

Create an empty bitmap.

pub fn from_sorted(values: &[u32]) -> Self

Create a bitmap from a sorted Vec<u32>.

pub fn add(&mut self, value: u32) -> bool

Insert a value. Returns true if the value was newly added.

pub fn remove(&mut self, value: u32) -> bool

Remove a value. Returns true if the value was present.

pub fn contains(&self, value: u32) -> bool

Check if a value is present.

pub fn len(&self) -> usize

Number of elements in the bitmap.

pub fn is_empty(&self) -> bool

Whether the bitmap is empty.

pub fn union_with(&mut self, other: &RoaringBitmap)

Union with another bitmap in-place.

pub fn intersect_with(&mut self, other: &RoaringBitmap)

Intersection with another bitmap in-place.

pub fn difference_with(&mut self, other: &RoaringBitmap)

Difference with another bitmap in-place (self = self \ other).

pub fn union(&self, other: &RoaringBitmap) -> RoaringBitmap

Return a new bitmap as the union of self and other.

pub fn intersection(&self, other: &RoaringBitmap) -> RoaringBitmap

Return a new bitmap as the intersection of self and other.

pub fn difference(&self, other: &RoaringBitmap) -> RoaringBitmap

Return a new bitmap as the difference of self and other.

pub fn iter(&self) -> RoaringIter<'_>

Iterator over all values in sorted order.

pub fn to_vec(&self) -> Vec<u32>

Collect all values into a sorted Vec<u32>.

Trait Implementations

impl Clone for RoaringBitmap

fn clone(&self) -> RoaringBitmap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoaringBitmap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RoaringBitmap

fn default() -> Self

Returns the “default value” for a type.