Put inserts an entry into the map, overwriting an existing value if an entry with the same key already exists.

Get retrieves the value from the map for the specified key, returning ok=false if the key is not present.

checkInvariants verifies the internal consistency of the map's structure, checking conditions that should always be true for a correctly functioning m

globalDepth returns the number of bits from the top of the hash to use for indexing in the buckets directory.

Len returns the number of entries in the map.

Set sets the i-th control byte.

first assumes that only the MSB of each control byte can be set (e.g. bitset is the result of matchEmpty or similar) and returns the relative index of

Extracts the H2 portion of a hash: the 7 bits not used for h1. These are used as an occupied control byte.

bucketCount returns the number of buckets in the buckets directory.

buckets calls yield sequentially for each bucket in the map. If yield returns false, iteration stops. Offset specifies the bucket to start iteration a

noescape hides a pointer from escape analysis. noescape is the identity function but escape analysis doesn't think the output depends on the input.

All calls yield sequentially for each key and value present in the map. If yield returns false, range stops the iteration. The map can be mutated duri

New constructs a new Map with the specified initial capacity. If initialCapacity is 0 the map will start out with zero capacity and will grow on the f

Extracts the H1 portion of a hash: the 57 upper bits.

matchEmpty returns the set of slots in the group that are empty.

toBuiltinMap returns the elements as a map[K]V. Useful for testing.

Delete deletes the entry corresponding to the specified key from the map. It is a noop to delete a non-existent key.

Slice returns a Go slice akin to slice[start:end] for a Go builtin slice.

removeFirst removes the first set bit (that is, resets the least significant set bit to 0).

resize the capacity of the table by allocating a bigger array and uncheckedPutting each element of the table into the new array (we know that no inser

bucketStep is the number of buckets to step over in the buckets directory to reach the next different bucket. A bucket occupies 1 or more contiguous e

capacity returns the total capacity of all map buckets.

go:linkname fastrand64 runtime.fastrand64

installBucket installs a bucket into the buckets directory, overwriting every index in the range of entries the bucket occupies.

matchEmptyOrDeleted returns the set of slots in the group that are empty or deleted.

matchH2 returns the set of slots which are full and for which the 7-bit hash matches the given value. May return false positives.

TODO(peter): - Add metamorphic tests that cross-check behavior at various bucket sizes. - Add fuzz testing. unsafeCtrlGroup reintreprets the given sli

Init initializes a Map with the specified initial capacity. If initialCapacity is 0 the map will start out with zero capacity and will grow on the fir

TODO(peter): Extracting a random element might be generally useful. Should this be promoted to the public API? Note that the elements are not selected

tombstones returns the number of deleted (tombstone) entries in the bucket. A tombstone is a slot that has been deleted but is still considered occupi

uncheckedPut inserts an entry known not to be in the table. Used by Put after it has failed to find an existing entry to overwrite duration insertion.

Clear deletes all entries from the map resulting in an empty map.

Free can optionally release the memory associated with the supplied slice that is guaranteed to have been allocated by Alloc.

SetEmpty sets all the control bytes to empty.

adjustBucketIndex adjusts the index of a bucket to account for the growth of the directory where index was captured at originalGlobalDepth and we're c

convertNonFullToEmptyAndFullToDeleted converts deleted control bytes in a group to empty control bytes, and control bytes indicating full slots to del

growDirectory grows the directory slice to 1<<newGlobalDepth buckets. Grow directory returns the new index location for the bucket specified by index.

normalizeCapacity rounds capacity to the next power of 2.

split divides the entries in a bucket between the receiver and a new bucket of the same size, and then installs the new bucket into the buckets direct

Alloc should return a slice equivalent to make([]Group, n).

Close closes the map, releasing any memory back to its configured allocator. It is unnecessary to close a map using the default allocator. It is inval

Get returns the i-th control byte.

bucket returns the bucket corresponding to hash value h.

TODO(peter): Should this be removed? It was useful for debugging a performance problem with BenchmarkGetMiss.

At returns a pointer to the element at index i. The go:nocheckptr declaration is need to silence the runtime check in race builds that the memory for

Get returns the i-th control byte.

GoString implements the fmt.GoStringer interface which is used when formatting using the "%#v" format specifier.

Lock is a no-op used by -copylocks checker from `go vet`.

Set sets the i-th control byte.

WithAllocator is an option for specifying the Allocator to use for a Map[K,V].

WithHash is an option to specify the hash function to use for a Map[K,V].

WithMaxBucketCapacity is an option to specify the max bucket size to use for a Map[K,V]. Specifying a very large bucket size results in slower resize