Hash sets

This module develops the type Std.HashSet of hash sets.

Lemmas about the operations on Std.HashSet are available in the module Std.Data.HashSet.Lemmas.

See the module Std.Data.HashSet.Raw for a variant of this type which is safe to use in nested inductive types.

structure Std.HashSet (α : Type u) [BEq α] [Hashable α] : Type u

Hash sets.

This is a simple separate-chaining hash table. The data of the hash set consists of a cached size and an array of buckets, where each bucket is a linked list of keys. The number of buckets is always a power of two. The hash set doubles its size upon inserting an element such that the number of elements is more than 75% of the number of buckets.

The hash table is backed by an Array. Users should make sure that the hash set is used linearly to avoid expensive copies.

The hash set uses == (provided by the BEq typeclass) to compare elements and hash (provided by the Hashable typeclass) to hash them. To ensure that the operations behave as expected, == should be an equivalence relation and a == b should imply hash a = hash b (see also the EquivBEq and LawfulHashable typeclasses). Both of these conditions are automatic if the BEq instance is lawful, i.e., if a == b implies a = b.

These hash sets contain a bundled well-formedness invariant, which means that they cannot be used in nested inductive types. For these use cases, Std.Data.HashSet.Raw and Std.Data.HashSet.Raw.WF unbundle the invariant from the hash set. When in doubt, prefer HashSet over HashSet.Raw.

• inner : HashMap α Unit

  Internal implementation detail of the hash set.

@[inline]

def Std.HashSet.emptyWithCapacity {α : Type u} [BEq α] [Hashable α] (capacity : Nat := 8) : HashSet α

Creates a new empty hash set. The optional parameter capacity can be supplied to presize the set so that it can hold the given number of elements without reallocating. It is also possible to use the empty collection notations ∅ and {} to create an empty hash set with the default capacity.

@[implicit_reducible]

instance Std.HashSet.instEmptyCollection {α : Type u} [BEq α] [Hashable α] : EmptyCollection (HashSet α)

@[implicit_reducible]

instance Std.HashSet.instInhabited {α : Type u} [BEq α] [Hashable α] : Inhabited (HashSet α)

structure Std.HashSet.Equiv {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m₁ m₂ : HashSet α) : Prop

Two hash sets are equivalent in the sense of Equiv iff all their values are equal.

• inner : m₁.inner.Equiv m₂.inner

  Internal implementation detail of the hash map

def Std.HashSet.«term_~m_» : Lean.TrailingParserDescr

Two hash sets are equivalent in the sense of Equiv iff all their values are equal.

@[inline]

def Std.HashSet.insert {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (a : α) : HashSet α

Inserts the given element into the set. If the hash set already contains an element that is equal (with regard to ==) to the given element, then the hash set is returned unchanged.

Note: this non-replacement behavior is true for HashSet and HashSet.Raw. The insert function on HashMap, DHashMap, HashMap.Raw and DHashMap.Raw behaves differently: it will overwrite an existing mapping.

@[implicit_reducible]

instance Std.HashSet.instSingleton {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} : Singleton α (HashSet α)

@[implicit_reducible]

instance Std.HashSet.instInsert {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} : Insert α (HashSet α)

@[inline]

def Std.HashSet.containsThenInsert {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (a : α) : Bool × HashSet α

Checks whether an element is present in a set and inserts the element if it was not found. If the hash set already contains an element that is equal (with regard to ==) to the given element, then the hash set is returned unchanged.

Equivalent to (but potentially faster than) calling contains followed by insert.

@[inline]

def Std.HashSet.contains {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (a : α) : Bool

Returns true if the given key is present in the set. There is also a Prop-valued version of this: a ∈ m is equivalent to m.contains a = true.

Observe that this is different behavior than for lists: for lists, ∈ uses = and contains use == for comparisons, while for hash sets, both use ==.

@[implicit_reducible]

instance Std.HashSet.instMembership {α : Type u} [BEq α] [Hashable α] : Membership α (HashSet α)

@[implicit_reducible]

instance Std.HashSet.instDecidableMem {α : Type u} [BEq α] [Hashable α] {m : HashSet α} {a : α} : Decidable (a ∈ m)

@[inline]

def Std.HashSet.erase {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (a : α) : HashSet α

Removes the element if it exists.

@[inline]

def Std.HashSet.size {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) : Nat

The number of elements present in the set

@[inline]

def Std.HashSet.get? {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (a : α) : Option α

Checks if given key is contained and returns the key if it is, otherwise none. The result in the some case is guaranteed to be pointer equal to the key in the set.

@[inline]

def Std.HashSet.get {α : Type u} [BEq α] [Hashable α] (m : HashSet α) (a : α) (h : a ∈ m) : α

Retrieves the key from the set that matches a. Ensures that such a key exists by requiring a proof of a ∈ m. The result is guaranteed to be pointer equal to the key in the set.

@[inline]

def Std.HashSet.getD {α : Type u} [BEq α] [Hashable α] (m : HashSet α) (a fallback : α) : α

Checks if given key is contained and returns the key if it is, otherwise fallback. If they key is contained the result is guaranteed to be pointer equal to the key in the set.

@[inline]

def Std.HashSet.get! {α : Type u} [BEq α] [Hashable α] [Inhabited α] (m : HashSet α) (a : α) : α

Checks if given key is contained and returns the key if it is, otherwise panics. If no panic occurs the result is guaranteed to be pointer equal to the key in the set.

@[inline]

def Std.HashSet.isEmpty {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) : Bool

Returns true if the hash set contains no elements.

Note that if your BEq instance is not reflexive or your Hashable instance is not lawful, then it is possible that this function returns false even though m.contains a = false for all a.

@[inline]

def Std.HashSet.toList {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) : List α

Transforms the hash set into a list of elements in some order.

@[inline]

def Std.HashSet.ofList {α : Type u} [BEq α] [Hashable α] (l : List α) : HashSet α

Creates a hash set from a list of elements. Note that unlike repeatedly calling insert, if the collection contains multiple elements that are equal (with regard to ==), then the last element in the collection will be present in the returned hash set.

@[inline]

def Std.HashSet.foldM {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} {m : Type v → Type w} [Monad m] {β : Type v} (f : β → α → m β) (init : β) (b : HashSet α) : m β

Monadically computes a value by folding the given function over the elements in the hash set in some order.

@[inline]

def Std.HashSet.fold {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} {β : Type v} (f : β → α → β) (init : β) (m : HashSet α) : β

Folds the given function over the elements of the hash set in some order.

@[inline]

def Std.HashSet.forM {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} {m : Type v → Type w} [Monad m] (f : α → m PUnit) (b : HashSet α) : m PUnit

Carries out a monadic action on each element in the hash set in some order.

@[inline]

def Std.HashSet.forIn {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} {m : Type v → Type w} [Monad m] {β : Type v} (f : α → β → m (ForInStep β)) (init : β) (b : HashSet α) : m β

Support for the for loop construct in do blocks.

@[implicit_reducible]

instance Std.HashSet.instForMOfMonad {α : Type u} [BEq α] [Hashable α] {m : Type v → Type w} [Monad m] : ForM m (HashSet α) α

@[implicit_reducible]

instance Std.HashSet.instForInOfMonad {α : Type u} [BEq α] [Hashable α] {m : Type v → Type w} [Monad m] : ForIn m (HashSet α) α

@[inline]

def Std.HashSet.filter {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (f : α → Bool) (m : HashSet α) : HashSet α

Removes all elements from the hash set for which the given function returns false.

@[inline]

def Std.HashSet.insertMany {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} {ρ : Type v} [ForIn Id ρ α] (m : HashSet α) (l : ρ) : HashSet α

Inserts multiple mappings into the hash set by iterating over the given collection and calling insert. If the same key appears multiple times, the first occurrence takes precedence.

Note: this precedence behavior is true for HashSet and HashSet.Raw. The insertMany function on HashMap, DHashMap, HashMap.Raw and DHashMap.Raw behaves differently: it will prefer the last appearance.

@[inline]

def Std.HashSet.toArray {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) : Array α

Transforms the hash set into an array of elements in some order.

@[inline]

def Std.HashSet.all {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (p : α → Bool) : Bool

Check if all elements satisfy the predicate, short-circuiting if a predicate fails.

@[inline]

def Std.HashSet.any {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) (p : α → Bool) : Bool

Check if any element satisfies the predicate, short-circuiting if a predicate succeeds.

@[inline]

def Std.HashSet.union {α : Type u} [BEq α] [Hashable α] (m₁ m₂ : HashSet α) : HashSet α

Computes the union of the given hash sets.

This function always merges the smaller set into the larger set, so the expected runtime is O(min(m₁.size, m₂.size)).

@[implicit_reducible]

instance Std.HashSet.instUnion {α : Type u} [BEq α] [Hashable α] : Union (HashSet α)

@[inline]

def Std.HashSet.inter {α : Type u} [BEq α] [Hashable α] (m₁ m₂ : HashSet α) : HashSet α

Computes the intersection of the given hash sets. The result will only contain entries from the first map.

This function always iterates through the smaller set, so the expected runtime is O(min(m₁.size, m₂.size)).

@[implicit_reducible]

instance Std.HashSet.instInter {α : Type u} [BEq α] [Hashable α] : Inter (HashSet α)

def Std.HashSet.beq {α : Type u} {x✝ : Hashable α} [BEq α] (m₁ m₂ : HashSet α) : Bool

Compares two hash sets using Boolean equality on keys.

Returns true if the sets contain the same keys, false otherwise.

@[implicit_reducible]

instance Std.HashSet.instBEq {α : Type u} {x✝ : Hashable α} [BEq α] : BEq (HashSet α)

@[inline]

def Std.HashSet.diff {α : Type u} [BEq α] [Hashable α] (m₁ m₂ : HashSet α) : HashSet α

Computes the difference of the given hash sets.

This function always iterates through the smaller set, so the expected runtime is O(min(m₁.size, m₂.size)).

@[implicit_reducible]

instance Std.HashSet.instSDiff {α : Type u} [BEq α] [Hashable α] : SDiff (HashSet α)

We currently do not provide lemmas for the functions below.

@[inline]

def Std.HashSet.partition {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (f : α → Bool) (m : HashSet α) : HashSet α × HashSet α

Partition a hashset into two hashsets based on a predicate.

@[inline]

def Std.HashSet.ofArray {α : Type u} [BEq α] [Hashable α] (l : Array α) : HashSet α

Creates a hash set from an array of elements. Note that unlike repeatedly calling insert, if the collection contains multiple elements that are equal (with regard to ==), then the last element in the collection will be present in the returned hash set.

def Std.HashSet.Internal.numBuckets {α : Type u} {x✝ : BEq α} {x✝¹ : Hashable α} (m : HashSet α) : Nat

Returns the number of buckets in the internal representation of the hash set. This function may be useful for things like monitoring system health, but it should be considered an internal implementation detail.

@[implicit_reducible]

instance Std.HashSet.instRepr {α : Type u} [BEq α] [Hashable α] [Repr α] : Repr (HashSet α)