Struct Coverage 

pub struct Coverage { /* private fields */ }

In-memory coverage over a discrete set of index interval IDs.

Implementations

impl Coverage

pub fn empty() -> Self

Construct an empty coverage set.

pub fn from_treemap(present: RoaringTreemap) -> Self

Wrap an existing treemap.

pub fn present(&self) -> &RoaringTreemap

Borrow the present index interval IDs.

pub fn into_treemap(self) -> RoaringTreemap

Consume the coverage and return its treemap.

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

Return the union of two coverage sets.

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

Merge another coverage set into this one.

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

Return the intersection of two coverage sets.

pub fn intersection_cardinality(&self, other: &Self) -> u64

Count index interval IDs present in both sets without materializing them.

pub fn cardinality(&self) -> u64

Number of present index interval IDs.

pub fn is_empty(&self) -> bool

Whether no index interval IDs are present.

pub fn range_cardinality(range: &RangeInclusive<IndexIntervalId>) -> u128

Number of index interval IDs in an inclusive range.

pub fn covered_cardinality( &self, range: &RangeInclusive<IndexIntervalId>, ) -> u64

Count present index interval IDs in a range without materializing it.

pub fn missing_runs( &self, range: &RangeInclusive<IndexIntervalId>, max_run_len: Option<u64>, ) -> Vec<RangeInclusive<IndexIntervalId>>

Return missing contiguous runs in an inclusive requested range.

Long runs are optionally split into chunks of at most max_run_len. Work is proportional to present index interval IDs and returned runs, not the size of the requested range.

pub fn last_run_with_min_len( &self, range: &RangeInclusive<IndexIntervalId>, min_len: u64, ) -> Option<RangeInclusive<IndexIntervalId>>

Return the last covered contiguous run of at least min_len IDs.

pub fn coverage_ratio(&self, range: &RangeInclusive<IndexIntervalId>) -> f64

Coverage ratio in [0.0, 1.0] for an inclusive range.

pub fn max_gap_len(&self, range: &RangeInclusive<IndexIntervalId>) -> u128

Length of the largest missing run in an inclusive range.

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

Return the last fully-covered window ending at or before an index interval ID.

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 Eq for Coverage

impl FromIterator<u64> for Coverage

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

where I: IntoIterator<Item = IndexIntervalId>,

Creates a value from an iterator.

impl PartialEq for Coverage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Coverage