Struct Coverage 

pub struct Coverage { /* private fields */ }

In-memory coverage over a discrete set of bucket ids.

This is a thin wrapper over RoaringBitmap that adds convenience methods for gap analysis.

Implementations

impl Coverage

pub fn empty() -> Self

Construct an empty coverage set (no bucket present).

pub fn from_bitmap(bitmap: RoaringBitmap) -> Self

Wrap an existing RoaringBitmap as Coverage.

pub fn present(&self) -> &RoaringBitmap

Borrow the underlying bitmap of present buckets.

pub fn into_bitmap(self) -> RoaringBitmap

Consume the Coverage and return the underlying bitmap.

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

Return the union of self and other.

pub fn intersect(&self, other: &Coverage) -> Coverage

Return the intersection of self and other.

pub fn cardinality(&self) -> u64

Number of buckets present in this coverage.

pub fn missing_points(&self, expected: &RoaringBitmap) -> RoaringBitmap

Return bucket ids that are expected but not present in this coverage.

This is expected - present.

pub fn missing_runs( &self, expected: &RoaringBitmap, max_run_len: Option<u64>, ) -> Vec<RangeInclusive<Bucket>>

Group missing buckets into contiguous runs, optionally splitting long runs into chunks of at most max_run_len.

• expected defines the domain we care about.
• Missing buckets are expected - present.
• Each returned range is inclusive in bucket space.

pub fn last_run_with_min_len( &self, expected: &RoaringBitmap, min_len: u64, ) -> Option<RangeInclusive<Bucket>>

Return the last (highest) contiguous run of coverage of length at least min_len, relative to expected.

“Coverage” here means buckets that are both in expected and in self.present().

pub fn coverage_ratio(&self, expected: &RoaringBitmap) -> f64

Coverage ratio in [0.0, 1.0] relative to expected.

Defined as:

(|present ∩ expected| as f64) / (|expected| as f64)

For expected.is_empty(), this returns 1.0 by convention (vacuous full coverage).

pub fn max_gap_len(&self, expected: &RoaringBitmap) -> u64

Maximum gap length (in buckets) relative to expected.

This is the length (number of buckets) of the longest missing run. If there are no missing buckets, returns 0.

pub fn union_inplace(&mut self, other: &Coverage)

Merge another coverage bitmap into this one, accumulating all buckets.

This performs an in-place union, so after the call self contains every bucket that was set in either self or other.

pub fn last_window_at_or_before( &self, end_bucket: Bucket, len: u64, ) -> Option<RangeInclusive<Bucket>>

Return the last fully-covered contiguous window of length len ending at or before end_bucket, based on present buckets only.

Trait Implementations

impl Clone for Coverage

fn clone(&self) -> Coverage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Coverage

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

Formats the value using the given formatter.

impl Default for Coverage

fn default() -> Coverage

Returns the “default value” for a type.

impl FromIterator<u32> for Coverage

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Bucket>,

Creates a value from an iterator.