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

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, all sets will use the default RandomState hasher, which will produce consistent hashes for the duration of its lifetime, but not between restarts of your program.

Methods

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

Construct an empty set.

Construct a set with a single value.

Examples

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

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

Test whether a set is empty.

Time: O(1)

Examples

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

Get the size of a set.

Time: O(1)

Examples

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

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

Construct an empty hash set using the provided hasher.

Get a reference to the set's BuildHasher.

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

Important traits for Iter<'a, A>

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.

Test if a value is part of a set.

Time: O(log n)

Insert a value into a set.

Time: O(log n)

Remove a value from a set if it exists.

Time: O(log n)

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

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

Time: O(log n)

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)

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

Construct the union of multiple sets.

Time: O(n log n)

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

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

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)

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)

Trait Implementations

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

Performs the conversion.

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

Performs the conversion.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

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

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

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

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

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

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

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

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

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

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

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

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

Feeds this value into the given [Hasher]. Read more

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

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

Returns the "default value" for a type. Read more

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

The resulting type after applying the + operator.

Performs the + operation.

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

The resulting type after applying the * operator.

Performs the * operation.

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

The resulting type after applying the + operator.

Performs the + operation.

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

The resulting type after applying the * operator.

Performs the * operation.

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

Method which takes an iterator and generates Self from the elements by "summing up" the items. Read more

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

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

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

Formats the value using the given formatter. Read more

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

Creates a value from an iterator. Read more

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

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

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

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

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]

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

Auto Trait Implementations

impl<A, S = RandomState> !Send for HashSet<A, S>

impl<A, S = RandomState> !Sync for HashSet<A, S>