Struct U32Set

pub struct U32Set {
    pages: Vec<BitPage>,
    page_map: Vec<PageInfo>,
    length: u64,
    last_page_map_index: AtomicUsize,
}

A fast, efficient, sparse, & ordered u32 set.

For a higher-level API that supports inversion and generic int types, use super::IntSet

Fields

pages: Vec<BitPage>

page_map: Vec<PageInfo>

length: u64

last_page_map_index: AtomicUsize

Implementations

impl U32Set

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

Add val as a member of this set.

If the set did not previously contain this value, returns true.

pub fn insert_range(&mut self, range: RangeInclusive<u32>)

Add all values in range as members of this set.

pub fn extend_unsorted<U: IntoIterator<Item = u32>>(&mut self, iter: U)

An alternate version of extend() which is optimized for inserting an unsorted iterator of values.

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

Remove val from this set.

Returns true if the value was present.

pub fn remove_all<U: IntoIterator<Item = u32>>(&mut self, iter: U)

pub fn remove_range(&mut self, range: RangeInclusive<u32>)

Removes all values in range as members of this set.

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

Returns true if val is a member of this set.

pub const fn empty() -> U32Set

pub fn clear(&mut self)

Remove all members from this set.

pub fn is_empty(&self) -> bool

Return true if there are no members in this set.

fn recompute_length(&mut self)

pub fn len(&self) -> u64

Returns the number of members in this set.

pub(crate) fn num_pages(&self) -> usize

pub fn union(&mut self, other: &U32Set)

Sets the members of this set to the union of self and other.

pub fn intersect(&mut self, other: &U32Set)

Sets the members of this set to the intersection of self and other.

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

Sets the members of this set to self - other.

pub fn reversed_subtract(&mut self, other: &U32Set)

Sets the members of this set to other - self.

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

Iterator over the members of this set. In sorted order (ascending).

pub fn iter_from(&self, value: u32) -> impl Iterator<Item = u32> + '_

Iterator over the members of this set starting from value.

So value is included in the iterator if it’s in the set.

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

Iterate over the ranges of contiguous values in this set.

fn iter_pages(&self) -> impl DoubleEndedIterator<Item = (u32, &BitPage)> + '_

fn iter_non_empty_pages( &self, ) -> impl DoubleEndedIterator<Item = (u32, &BitPage)> + '_

fn passthrough_behavior<Op>(op: &Op) -> (bool, bool)

where Op: Fn(&BitPage, &BitPage) -> BitPage,

Determine the passthrough behaviour of the operator.

The passthrough behaviour is what happens to a page on one side of the operation if the other side is 0. For example union passes through both left and right sides since it preserves the left or right side when the other side is 0. Knowing this lets us optimize some cases when only one page is present on one side.

fn process<Op>(&mut self, op: Op, other: &U32Set)

where Op: Fn(&BitPage, &BitPage) -> BitPage,

fn compact(&mut self, new_len: usize)

fn compact_pages(&mut self, old_index_to_page_map_index: Vec<usize>)

fn resize(&mut self, new_len: usize)

const fn get_major_value(value: u32) -> u32

Return the major value (top 23 bits) of the page associated with value.

const fn major_start(major: u32) -> u32

const fn major_end(major: u32) -> u32

fn page_index_for_major(&self, major_value: u32) -> Option<usize>

Returns the index in self.pages (if it exists) for the page with the same major as major_value.

fn page_map_index_for_major(&self, major_value: u32) -> Option<usize>

fn ensure_page_index_for_major(&mut self, major_value: u32) -> usize

Returns the index in self.pages for the page with the same major as major_value. Will create the page if it does not yet exist.

fn page_for_mut(&mut self, value: u32) -> Option<&mut BitPage>

Return a mutable reference to the page that value resides in.

Insert a new page if it doesn’t exist.

fn page_for_major_mut(&mut self, major_value: u32) -> Option<&mut BitPage>

Return a mutable reference to the page with major value equal to major_value.

fn ensure_page_for_mut(&mut self, value: u32) -> &mut BitPage

Return a mutable reference to the page that value resides in.

Insert a new page if it doesn’t exist.

fn ensure_page_for_major_mut(&mut self, major_value: u32) -> &mut BitPage

Return a mutable reference to the page with major value equal to major_value. Inserts a new page if it doesn’t exist.

fn page_for_index_mut(&mut self, index: usize) -> Option<&mut BitPage>

Return the mutable page at a given index

fn page_for_index(&self, index: usize) -> Option<&BitPage>

Trait Implementations

impl Clone for U32Set

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 U32Set

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

Formats the value using the given formatter.

impl Default for U32Set

fn default() -> Self

Returns the “default value” for a type.

impl Extend<u32> for U32Set

fn extend<U: IntoIterator<Item = u32>>(&mut self, iter: U)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<u32> for U32Set

fn from_iter<I: IntoIterator<Item = u32>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for U32Set

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for U32Set

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for U32Set

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.

impl PartialOrd for U32Set

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for U32Set