Struct DocBitmap 

pub struct DocBitmap { /* private fields */ }

A compressed set of segment-local document identifiers.

Implementations

impl DocBitmap

pub fn new() -> Self

Creates an empty bitmap.

pub fn full(row_count: u32) -> Self

Creates the document universe 0..row_count.

pub fn from_ids(ids: impl IntoIterator<Item = u32>) -> Self

Creates a bitmap from document identifiers.

pub fn insert(&mut self, document: u32) -> bool

Inserts one document identifier and reports whether it was new.

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

Removes one document identifier and reports whether it was present.

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

Returns whether the document identifier is present.

pub fn cardinality(&self) -> u64

Returns the exact bitmap cardinality.

pub fn is_empty(&self) -> bool

Returns whether the bitmap contains no identifiers.

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

Iterates identifiers in ascending order.

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

Mutates this bitmap to its union with other.

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

Mutates this bitmap to its intersection with other.

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

Removes every identifier present in other.

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

Returns whether every identifier is also present in other.

Trait Implementations

impl Clone for DocBitmap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocBitmap

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

Formats the value using the given formatter.

impl Default for DocBitmap

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DocBitmap

impl PartialEq for DocBitmap

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocBitmap