Struct VectorBitmap 

pub struct VectorBitmap {
    pub vector_ids: RoaringTreemap,
}

A compressed bitmap storing a set of vector IDs.

Uses RoaringTreemap for efficient compression and fast set operations.

Value Layout

+----------------------------------------------------------------+
|  vector_ids:  RoaringTreemap serialization                     |
|               (compressed u64 bitmap, variable length)         |
+----------------------------------------------------------------+

Fields

vector_ids: RoaringTreemap

Compressed set of vector IDs.

Implementations

impl VectorBitmap

pub fn new() -> Self

pub fn from_treemap(vector_ids: RoaringTreemap) -> Self

pub fn singleton(vector_id: u64) -> Self

Create a VectorBitmap containing a single vector ID.

pub fn insert(&mut self, vector_id: u64) -> bool

Insert a vector ID into the bitmap.

pub fn remove(&mut self, vector_id: u64) -> bool

Remove a vector ID from the bitmap.

pub fn contains(&self, vector_id: u64) -> bool

Check if a vector ID is in the bitmap.

pub fn len(&self) -> u64

Returns the number of vector IDs in the bitmap.

pub fn is_empty(&self) -> bool

Returns true if the bitmap is empty.

pub fn iter(&self) -> impl Iterator<Item = u64> + '_

Returns an iterator over the vector IDs.

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

Union (OR) this bitmap with another.

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

Difference (AND-NOT) this bitmap with another.

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

Intersection (AND) this bitmap with another.

pub fn encode_to_bytes(&self) -> Result<Bytes, EncodingError>

pub fn decode_from_bytes(buf: &[u8]) -> Result<Self, EncodingError>

Trait Implementations

impl Clone for VectorBitmap

fn clone(&self) -> VectorBitmap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorBitmap

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

Formats the value using the given formatter.

impl Default for VectorBitmap

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for VectorBitmap

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.