Struct IntSet

pub struct IntSet<T>(/* private fields */);

A fast & efficient invertible ordered set for small (up to 32-bit) unsigned integer types.

Implementations

impl IntSet<u32>

pub fn from_sparse_bit_set(data: &[u8]) -> Result<IntSet<u32>, DecodingError>

Populate this set with the values obtained from decoding the provided sparse bit set bytes.

Sparse bit sets are a specialized, compact encoding of bit sets defined in the IFT specification: https://w3c.github.io/IFT/Overview.html#sparse-bit-set-decoding

pub fn from_sparse_bit_set_bounded( data: &[u8], bias: u32, max_value: u32, ) -> Result<(IntSet<u32>, &[u8]), DecodingError>

Populate this set with the values obtained from decoding the provided sparse bit set bytes.

During decoding bias will be added to each decoded set members value. The final set will not contain any values larger than max_value: any encoded values larger than max_value after the bias is applied are ignored.

Sparse bit sets are a specialized, compact encoding of bit sets defined in the IFT specification: https://w3c.github.io/IFT/Overview.html#sparse-bit-set-decoding

pub fn to_sparse_bit_set(&self) -> Vec<u8>

Encode this set as a sparse bit set byte encoding.

Sparse bit sets are a specialized, compact encoding of bit sets defined in the IFT specification: https://w3c.github.io/IFT/Overview.html#sparse-bit-set-decoding

impl<T> IntSet<T>

where T: Domain,

pub fn iter(&self) -> impl DoubleEndedIterator

Returns an iterator over all members of the set in sorted ascending order.

Note: iteration of inverted sets can be extremely slow due to the very large number of members in the set care should be taken when using .iter() in combination with an inverted set.

pub fn inclusive_iter(&self) -> Option<impl DoubleEndedIterator>

If this is an inclusive membership set then returns an iterator over the members, otherwise returns None.

pub fn iter_after(&self, value: T) -> impl Iterator<Item = T>

Returns an iterator over the members of this set that are after value in ascending order.

Note: iteration of inverted sets can be extremely slow due to the very large number of members in the set care should be taken when using .iter() in combination with an inverted set.

pub fn range<R>(&self, range: R) -> impl Iterator<Item = T>

where R: RangeBounds<T>,

Returns an iterator over members of this set that are in range.

pub fn iter_ranges(&self) -> impl Iterator<Item = RangeInclusive<T>>

Returns an iterator over all disjoint ranges of values within the set in sorted ascending order.

pub fn iter_excluded_ranges(&self) -> impl Iterator<Item = RangeInclusive<T>>

Returns an iterator over all disjoint ranges of values not within the set in sorted ascending order.

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

Adds a value to the set.

Returns true if the value was newly inserted.

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

Add all values in range as members of this set.

pub fn extend_unsorted<U>(&mut self, iter: U)

where U: IntoIterator<Item = T>,

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

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

Removes a value from the set. Returns whether the value was present in the set.

pub fn remove_all<U>(&mut self, iter: U)

where U: IntoIterator<Item = T>,

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

Removes all values in range as members of this set.

pub fn union(&mut self, other: &IntSet<T>)

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

pub fn intersect(&mut self, other: &IntSet<T>)

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

pub fn subtract(&mut self, other: &IntSet<T>)

Sets the members of this set to self - other.

pub fn intersects_range(&self, range: RangeInclusive<T>) -> bool

Returns true if this set contains at least one element in ‘range’.

pub fn intersects_set(&self, other: &IntSet<T>) -> bool

Returns true if this set contains at least one element in ‘other’.

pub fn first(&self) -> Option<T>

Returns first element in the set, if any. This element is always the minimum of all elements in the set.

pub fn last(&self) -> Option<T>

Returns the last element in the set, if any. This element is always the maximum of all elements in the set.

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

Returns true if the set contains a value.

pub fn len(&self) -> u64

Returns the number of members in this set.

pub fn is_empty(&self) -> bool

Return true if there are no members in this set.

impl<T> IntSet<T>

pub const fn new() -> IntSet<T>

Create a new, (empty) IntSet.

You can create a new full set with IntSet::all.

pub const fn empty() -> IntSet<T>

Create a new empty set (inclusive).

pub const fn all() -> IntSet<T>

Create a new set which contains all integers (exclusive).

pub fn is_inverted(&self) -> bool

Returns true if this set is inverted (has exclusive membership).

pub fn invert(&mut self)

Return the inverted version of this set.

pub fn clear(&mut self)

Clears the set, removing all values.

Trait Implementations

impl<T> Clone for IntSet<T>

where T: Clone,

fn clone(&self) -> IntSet<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for IntSet<T>

where T: Domain + Debug,

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

Formats the value using the given formatter.

impl<T> Default for IntSet<T>

fn default() -> IntSet<T>

Returns the “default value” for a type.

impl<T> Display for IntSet<T>

where T: Domain + Display,

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

Formats the value using the given formatter.

impl<T> Extend<T> for IntSet<T>

where T: Domain,

fn extend<U>(&mut self, iter: U)

where U: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator.

This implementation is optimized to provide the best performance when the iterator contains sorted values. Consider using extend_unsorted() if the iterator is known to contain unsorted values.

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<T, const N: usize> From<[T; N]> for IntSet<T>

where T: Domain,

fn from(value: [T; N]) -> IntSet<T>

Converts to this type from the input type.

impl<T> FromIterator<T> for IntSet<T>

where T: Domain,

fn from_iter<I>(iter: I) -> IntSet<T>

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T> Hash for IntSet<T>

where T: Domain,

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

where H: Hasher,

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<T> Ord for IntSet<T>

where T: Domain + Ord,

fn cmp(&self, other: &IntSet<T>) -> 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<T> PartialEq for IntSet<T>

where T: Domain,

fn eq(&self, other: &IntSet<T>) -> 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<T> PartialOrd for IntSet<T>

where T: Domain + Ord,

fn partial_cmp(&self, other: &IntSet<T>) -> 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<T> Eq for IntSet<T>

where T: Domain,