M.V. Hutz
39548b4332
All checks were successful
CI / Check PR Title (push) Has been skipped
CI / Go Lint (push) Successful in 58s
CI / Makefile Lint (push) Successful in 55s
CI / Markdown Lint (push) Successful in 34s
CI / Unit Tests (push) Successful in 54s
CI / Fuzz Tests (push) Successful in 1m26s
CI / Mutation Tests (push) Successful in 1m11s
## Description Closes #11. ## Changes ### Design Decisions ## Checklist - [ ] Tests pass - [ ] Docs updated Reviewed-on: #21 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
13 lines
508 B
Go
13 lines
508 B
Go
// Package cuckoo provides a hash table that uses cuckoo hashing to achieve
|
|
// a worst-case O(1) lookup time.
|
|
//
|
|
// While a [New] only supports comparable keys by default, you can create
|
|
// a table with any key type using [NewCustom]. Custom [Hash] functions and
|
|
// key comparison are also supported.
|
|
//
|
|
// NOTE: The [Table] is a look-up structure, and not a source of truth. If
|
|
// [ErrBadHash] occurs, the data cannot be restored.
|
|
//
|
|
// See more: https://en.wikipedia.org/wiki/Cuckoo_hashing
|
|
package cuckoo
|