Struct GenericHashSet

Source

pub struct GenericHashSet<A, S, P>where
    P: SharedPointerKind,
{ /* private fields */ }

Expand description

An unordered set.

An immutable hash set using [hash array mapped tries] 1.

Most operations on this set are O(log_x n) for a suitably high x that it should be nearly O(1) for most sets. Because of this, it’s a great choice for a generic set as long as you don’t mind that values will need to implement Hash and Eq.

Values will have a predictable order based on the hasher being used. Unless otherwise specified, this will be the standard RandomState hasher.

Implementations§

Source §

impl<A, S, P> GenericHashSet<A, S, P>
where A: Hash + Eq + Clone, S: BuildHasher + Default + Clone, P: SharedPointerKind,

Source

pub fn unit(a: A) -> GenericHashSet<A, S, P>

Construct a set with a single value.

§Examples

let set = HashSet::unit(123);
assert!(set.contains(&123));

Source §

impl<A, S, P> GenericHashSet<A, S, P>
where P: SharedPointerKind,

Source

pub fn new() -> GenericHashSet<A, S, P>
where S: Default,

Construct an empty set.

Source

pub fn is_empty(&self) -> bool

Test whether a set is empty.

Time: O(1)

§Examples

assert!(
  !hashset![1, 2, 3].is_empty()
);
assert!(
  HashSet::<i32>::new().is_empty()
);

Source

pub fn len(&self) -> usize

Get the size of a set.

Time: O(1)

§Examples

assert_eq!(3, hashset![1, 2, 3].len());

Source

pub fn ptr_eq(&self, other: &GenericHashSet<A, S, P>) -> bool

Test whether two sets refer to the same content in memory.

This is true if the two sides are references to the same set, or if the two sets refer to the same root node.

This would return true if you’re comparing a set to itself, or if you’re comparing a set to a fresh clone of itself.

Time: O(1)

Source

pub fn with_hasher(hasher: S) -> GenericHashSet<A, S, P>

Construct an empty hash set using the provided hasher.

Source

pub fn hasher(&self) -> &S

Get a reference to the set’s BuildHasher.

Source

pub fn new_from<A2>(&self) -> GenericHashSet<A2, S, P>
where A2: Hash + Eq + Clone, S: Clone,

Construct an empty hash set using the same hasher as the current hash set.

Source

pub fn clear(&mut self)

Discard all elements from the set.

This leaves you with an empty set, and all elements that were previously inside it are dropped.

Time: O(n)

§Examples

let mut set = hashset![1, 2, 3];
set.clear();
assert!(set.is_empty());

Source

pub fn iter(&self) -> Iter<'_, A, P> ⓘ

Get an iterator over the values in a hash set.

Please note that the order is consistent between sets using the same hasher, but no other ordering guarantee is offered. Items will not come out in insertion order or sort order. They will, however, come out in the same order every time for the same set.

Source §

impl<A, S, P> GenericHashSet<A, S, P>
where A: Hash + Eq, S: BuildHasher, P: SharedPointerKind,

Source

pub fn contains<BA>(&self, a: &BA) -> bool
where BA: Hash + Eq + ?Sized, A: Borrow<BA>,

Test if a value is part of a set.

Time: O(log n)

Source

pub fn is_subset<RS>(&self, other: RS) -> bool
where RS: Borrow<GenericHashSet<A, S, P>>,

Test whether a set is a subset of another set, meaning that all values in our set must also be in the other set.

Time: O(n log n)

Source

pub fn is_proper_subset<RS>(&self, other: RS) -> bool
where RS: Borrow<GenericHashSet<A, S, P>>,

Test whether a set is a proper subset of another set, meaning that all values in our set must also be in the other set. A proper subset must also be smaller than the other set.

Time: O(n log n)

Source §

impl<A, S, P> GenericHashSet<A, S, P>
where A: Hash + Eq + Clone, S: BuildHasher + Clone, P: SharedPointerKind,

Source

pub fn insert(&mut self, a: A) -> Option<A>

Insert a value into a set.

Time: O(log n)

Source

pub fn remove<BA>(&mut self, a: &BA) -> Option<A>
where BA: Hash + Eq + ?Sized, A: Borrow<BA>,

Remove a value from a set if it exists.

Time: O(log n)

Source

pub fn update(&self, a: A) -> GenericHashSet<A, S, P>

Construct a new set from the current set with the given value added.

Time: O(log n)

§Examples

let set = hashset![123];
assert_eq!(
  set.update(456),
  hashset![123, 456]
);

Source

pub fn without<BA>(&self, a: &BA) -> GenericHashSet<A, S, P>
where BA: Hash + Eq + ?Sized, A: Borrow<BA>,

Construct a new set with the given value removed if it’s in the set.

Time: O(log n)

Source

pub fn retain<F>(&mut self, f: F)
where F: FnMut(&A) -> bool,

Filter out values from a set which don’t satisfy a predicate.

This is slightly more efficient than filtering using an iterator, in that it doesn’t need to rehash the retained values, but it still needs to reconstruct the entire tree structure of the set.

Time: O(n log n)

§Examples

let mut set = hashset![1, 2, 3];
set.retain(|v| *v > 1);
let expected = hashset![2, 3];
assert_eq!(expected, set);

Source

pub fn union(self, other: GenericHashSet<A, S, P>) -> GenericHashSet<A, S, P>

Construct the union of two sets.

Time: O(n log n)

§Examples

let set1 = hashset!{1, 2};
let set2 = hashset!{2, 3};
let expected = hashset!{1, 2, 3};
assert_eq!(expected, set1.union(set2));

Source

pub fn unions(i: I) -> GenericHashSet<A, S, P>
where I: IntoIterator<Item = GenericHashSet<A, S, P>>, S: Default,

Construct the union of multiple sets.

Time: O(n log n)

Source

pub fn difference( self, other: GenericHashSet<A, S, P>, ) -> GenericHashSet<A, S, P>

👎Deprecated since 2.0.1: to avoid conflicting behaviors between std and imbl, the difference alias for symmetric_difference will be removed.

Construct the symmetric difference between two sets.

This is an alias for the symmetric_difference method.

Time: O(n log n)

§Examples

let set1 = hashset!{1, 2};
let set2 = hashset!{2, 3};
let expected = hashset!{1, 3};
assert_eq!(expected, set1.difference(set2));

Source

pub fn symmetric_difference( self, other: GenericHashSet<A, S, P>, ) -> GenericHashSet<A, S, P>

Construct the symmetric difference between two sets.

Time: O(n log n)

§Examples

let set1 = hashset!{1, 2};
let set2 = hashset!{2, 3};
let expected = hashset!{1, 3};
assert_eq!(expected, set1.symmetric_difference(set2));

Source

pub fn relative_complement( self, other: GenericHashSet<A, S, P>, ) -> GenericHashSet<A, S, P>

Construct the relative complement between two sets, that is the set of values in self that do not occur in other.

Time: O(m log n) where m is the size of the other set

§Examples

let set1 = hashset!{1, 2};
let set2 = hashset!{2, 3};
let expected = hashset!{1};
assert_eq!(expected, set1.relative_complement(set2));

Source

pub fn intersection( self, other: GenericHashSet<A, S, P>, ) -> GenericHashSet<A, S, P>

Construct the intersection of two sets.

Time: O(n log n)

§Examples

let set1 = hashset!{1, 2};
let set2 = hashset!{2, 3};
let expected = hashset!{2};
assert_eq!(expected, set1.intersection(set2));

Trait Implementations§

Source §

impl<'a, A, S, P> Add for &'a GenericHashSet<A, S, P>
where A: Hash + Eq + Clone, S: BuildHasher + Clone, P: SharedPointerKind,

Source §

type Output = GenericHashSet<A, S, P>

The resulting type after applying the + operator.

Source §

fn add( self, other: &'a GenericHashSet<A, S, P>, ) -> <&'a GenericHashSet<A, S, P> as Add>::Output

Performs the + operation. Read more

Source §

impl<A, S, P> Add for GenericHashSet<A, S, P>
where A: Hash + Eq + Clone, S: BuildHasher + Clone, P: SharedPointerKind,

Source §

type Output = GenericHashSet<A, S, P>

The resulting type after applying the + operator.

Source §

fn add( self, other: GenericHashSet<A, S, P>, ) -> <GenericHashSet<A, S, P> as Add>::Output

Performs the + operation. Read more

Source §

impl<A, S, P> Clone for GenericHashSet<A, S, P>
where P: SharedPointerKind, A: Clone, S: Clone,

Source §

fn clone(&self) -> GenericHashSet<A, S, P>

Clone a set.

Time: O(1)

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<A, S, P> Debug for GenericHashSet<A, S, P>
where A: Hash + Eq + Debug, S: BuildHasher, P: SharedPointerKind,

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<A, S, P> Default for GenericHashSet<A, S, P>
where S: Default, P: SharedPointerKind,

Source §

fn default() -> GenericHashSet<A, S, P>

Returns the “default value” for a type. Read more

Source §

impl<'de, A, S, P> Deserialize<'de> for GenericHashSet<A, S, P>
where A: Deserialize<'de> + Hash + Eq + Clone, S: BuildHasher + Default + Clone, P: SharedPointerKind,

Source §

fn deserialize<D>( des: D, ) -> Result<GenericHashSet<A, S, P>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl<A, S, R, P> Extend<R> for GenericHashSet<A, S, P>
where P: SharedPointerKind, A: Hash + Eq + Clone + From<R>, S: BuildHasher + Clone,

Source §

fn extend(&mut self, iter: I)
where I: IntoIterator<Item = R>,

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

Source §

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. Read more

Source §