Struct GrowSet 

pub struct GrowSet { /* private fields */ }

A GrowSet is a set of integers that supports efficient addition and clearing.

It supports the following additional operations with the associated complexity:

• add - add an integer to the set in O(1) time
• clear - remove all members from the set in O(1) time
• pop - remove and return a random member of the set in O(1) time

GrowSets are useful for sets that need to be cleared frequently and rebuilt.

The implementation of GrowSet is based on “An Efficient Represtation of Sparse Sets” by Briggs and Torczon (1993).

Implementations

impl<'a> GrowSet

pub fn with_capacity(size: usize) -> Self

Returns a GrowSet with the given capacity.

Arguments

• size - the set can store all integers up to, but not including, this value.

Examples

// This set can store the integers 0, 1, 2, 3, and 4.
use intset::GrowSet;
let mut set = GrowSet::with_capacity(5);
set.add(3);
assert!(set.contains(3));

pub fn capacity(&self) -> usize

Returns one greater than the largest integer that can be stored in this set. That is, a set that can store integers from 0 to 5 will have a capacity of 6.

pub fn len(&self) -> usize

Return the number of integers in the set.

Examples

use intset::GrowSet;
let mut set = GrowSet::with_capacity(5);
set.add(1);
set.add(4);
assert_eq!(set.len(), 2);

pub fn contains(&self, value: usize) -> bool

Returns true if the specified value is in the set.

Arguments

• value - the element to test

Examples

use intset::GrowSet;
let mut set = GrowSet::with_capacity(5);
set.add(1);
assert!(set.contains(1));
assert!(!set.contains(3));

pub fn clear(&mut self)

Remove all items from the set.

pub fn add(&mut self, value: usize)

Add an item to the set. The item must be less than the capacity of the set.

Arguments

• value - the value to store

Examples

use intset::GrowSet;
let mut set = GrowSet::with_capacity(100);
set.add(42);
assert!(set.contains(42));

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

Returns an iterator over the values in the set. Uniqueness is guaranteed; ordering is not.

pub fn pop(&mut self) -> Option<usize>

Returns a random element of the set in constant time, or None if the set is empty.

Trait Implementations

impl Debug for GrowSet

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

Formats the value using the given formatter.