[][src]Struct im::hashset::HashSet

pub struct HashSet<A, S = RandomState> { /* fields omitted */ }

An unordered set.

An immutable hash set using hash array mapped tries.

Most operations on this set are O(logx 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.

Methods

impl<A> HashSet<A, RandomState>[src]

#[must_use]
pub fn new() -> Self
[src]

Construct an empty set.

impl<A> HashSet<A, RandomState> where
    A: Hash + Eq + Clone
[src]

#[must_use]
pub fn singleton(a: A) -> Self
[src]

Deprecated since 12.3.0:

renamed to unit for consistency

Construct a set with a single value.

This method has been deprecated; use unit instead.

#[must_use]
pub fn unit(a: A) -> Self
[src]

Construct a set with a single value.

Examples

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

impl<A, S> HashSet<A, S>[src]

#[must_use]
pub fn is_empty(&self) -> bool
[src]

Test whether a set is empty.

Time: O(1)

Examples

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

#[must_use]
pub fn len(&self) -> usize
[src]

Get the size of a set.

Time: O(1)

Examples

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

#[must_use]
pub fn with_hasher<RS>(hasher: RS) -> Self where
    Arc<S>: From<RS>, 
[src]

Construct an empty hash set using the provided hasher.

#[must_use]
pub fn hasher(&self) -> &Arc<S>
[src]

Get a reference to the set's BuildHasher.

#[must_use]
pub fn new_from<A1>(&self) -> HashSet<A1, S> where
    A1: Hash + Eq + Clone
[src]

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

pub fn clear(&mut self)[src]

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());

Important traits for Iter<'a, A>
#[must_use]
pub fn iter(&self) -> Iter<A>
[src]

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.

impl<A, S> HashSet<A, S> where
    A: Hash + Eq,
    S: BuildHasher
[src]

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

Test if a value is part of a set.

Time: O(log n)

#[must_use]
pub fn is_subset<RS>(&self, other: RS) -> bool where
    RS: Borrow<Self>, 
[src]

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)

#[must_use]
pub fn is_proper_subset<RS>(&self, other: RS) -> bool where
    RS: Borrow<Self>, 
[src]

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)

impl<A, S> HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

Important traits for IterMut<'a, A>
#[must_use]
pub fn iter_mut(&mut self) -> IterMut<A>
[src]

Get a mutable 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.

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

Insert a value into a set.

Time: O(log n)

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

Remove a value from a set if it exists.

Time: O(log n)

#[must_use]
pub fn update(&self, a: A) -> Self
[src]

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]
);

#[must_use]
pub fn without<BA: ?Sized>(&self, a: &BA) -> Self where
    BA: Hash + Eq,
    A: Borrow<BA>, 
[src]

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

Time: O(log n)

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

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)

#[must_use]
pub fn union(self, other: Self) -> Self
[src]

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));

#[must_use]
pub fn unions<I>(i: I) -> Self where
    I: IntoIterator<Item = Self>,
    S: Default
[src]

Construct the union of multiple sets.

Time: O(n log n)

#[must_use]
pub fn difference(self, other: Self) -> Self
[src]

Construct the 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.difference(set2));

#[must_use]
pub fn intersection(self, other: Self) -> Self
[src]

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

impl<A, S> PartialOrd<HashSet<A, S>> for HashSet<A, S> where
    A: Hash + Eq + Clone + PartialOrd,
    S: BuildHasher + Default
[src]

#[must_use]
default fn lt(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

#[must_use]
default fn le(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
default fn gt(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
default fn ge(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<A, S> Eq for HashSet<A, S> where
    A: Hash + Eq,
    S: BuildHasher + Default
[src]

impl<A, S> Ord for HashSet<A, S> where
    A: Hash + Eq + Clone + Ord,
    S: BuildHasher + Default
[src]

default fn max(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the maximum of two values. Read more

default fn min(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the minimum of two values. Read more

default fn clamp(self, min: Self, max: Self) -> Self[src]

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

Restrict a value to a certain interval. Read more

impl<A, S, R> Extend<R> for HashSet<A, S> where
    A: Hash + Eq + Clone + From<R>,
    S: BuildHasher
[src]

impl<A, S> Clone for HashSet<A, S> where
    A: Clone
[src]

default fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl<A, S> PartialEq<HashSet<A, S>> for HashSet<A, S> where
    A: Hash + Eq,
    S: BuildHasher + Default
[src]

#[must_use]
default fn ne(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests for !=.

impl<A, S> Default for HashSet<A, S> where
    S: BuildHasher + Default
[src]

impl<'a, A, S> IntoIterator for &'a HashSet<A, S> where
    A: Hash + Eq,
    S: BuildHasher
[src]

type Item = &'a A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

impl<A, S> IntoIterator for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

type Item = A

The type of the elements being iterated over.

type IntoIter = ConsumingIter<Self::Item>

Which kind of iterator are we turning this into?

impl<A: Hash + Eq + Ord + Clone, S: BuildHasher> From<HashSet<A, S>> for OrdSet<A>[src]

impl<'a, A: Hash + Eq + Ord + Clone, S: BuildHasher> From<&'a HashSet<A, S>> for OrdSet<A>[src]

impl<'s, 'a, A: ?Sized, OA, SA, SB> From<&'s HashSet<&'a A, SA>> for HashSet<OA, SB> where
    A: ToOwned<Owned = OA> + Hash + Eq,
    OA: Borrow<A> + Hash + Eq + Clone,
    SA: BuildHasher,
    SB: BuildHasher + Default
[src]

impl<'a, A, S> From<&'a [A]> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<A, S> From<Vec<A>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<'a, A, S> From<&'a Vec<A>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<A, S> From<HashSet<A, RandomState>> for HashSet<A, S> where
    A: Eq + Hash + Clone,
    S: BuildHasher + Default
[src]

impl<'a, A, S> From<&'a HashSet<A, RandomState>> for HashSet<A, S> where
    A: Eq + Hash + Clone,
    S: BuildHasher + Default
[src]

impl<'a, A, S> From<&'a BTreeSet<A>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<A, S> From<OrdSet<A>> for HashSet<A, S> where
    A: Ord + Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<'a, A, S> From<&'a OrdSet<A>> for HashSet<A, S> where
    A: Ord + Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<A, S> Hash for HashSet<A, S> where
    A: Hash + Eq,
    S: BuildHasher + Default
[src]

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl<A, S> Add<HashSet<A, S>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

type Output = HashSet<A, S>

The resulting type after applying the + operator.

impl<'a, A, S> Add<&'a HashSet<A, S>> for &'a HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

type Output = HashSet<A, S>

The resulting type after applying the + operator.

impl<A, S> Mul<HashSet<A, S>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

type Output = HashSet<A, S>

The resulting type after applying the * operator.

impl<'a, A, S> Mul<&'a HashSet<A, S>> for &'a HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher
[src]

type Output = HashSet<A, S>

The resulting type after applying the * operator.

impl<A, RA, S> FromIterator<RA> for HashSet<A, S> where
    A: Hash + Eq + Clone + From<RA>,
    S: BuildHasher + Default
[src]

impl<A, S> Sum<HashSet<A, S>> for HashSet<A, S> where
    A: Hash + Eq + Clone,
    S: BuildHasher + Default
[src]

impl<A, S> Debug for HashSet<A, S> where
    A: Hash + Eq + Debug,
    S: BuildHasher
[src]

impl<A, S> Debug for HashSet<A, S> where
    A: Hash + Eq + Debug + Ord,
    S: BuildHasher
[src]

Auto Trait Implementations

impl<A, S> Send for HashSet<A, S> where
    A: Send + Sync,
    S: Send + Sync

impl<A, S> Sync for HashSet<A, S> where
    A: Send + Sync,
    S: Send + Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T> From for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same for T[src]

type Output = T

Should always be Self