M.V. Hutz
7cc1657403
All checks were successful
CI / Check PR Title (push) Has been skipped
CI / Makefile Lint (push) Successful in 47s
CI / Go Lint (push) Successful in 51s
CI / Markdown Lint (push) Successful in 46s
CI / Unit Tests (push) Successful in 47s
CI / Fuzz Tests (push) Successful in 1m19s
CI / Mutation Tests (push) Successful in 1m36s
## Description Currently, the name of `bucket` is a bit confusing, because it is considered a 'table' in literature (as well as the whole hash table). A `bucket` is better described as a 'subtable', which is used by the total hash table to perform cuckoo hashing. In addition, the constructors `NewTable`, `NewTableBy`, and `NewCustomTable` were given shorter names, because the package name `cuckoo` already implies that `New*` would create a hash table with cuckoo hashing. This package has one use-case, and so it unambiguous what constructors produce. ## Changes - `NewTable` -> `New` - `NewTableBy` -> `NewBy` - `NewCustomTable` -> `NewCustom` - `bucket` -> `subtable` ### Design Decisions - I would have renamed `Table` and `subtable` to map equivalents, but 'submap' implies that a certain subsection of the map is contained within it, which isn't quite right. - I chose not to go with `Map` and `table`, because of the split naming convention. ## Checklist - [x] Tests pass - [x] Docs updated Reviewed-on: #22 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
18 lines
639 B
Go
18 lines
639 B
Go
package cuckoo
|
|
|
|
// An EqualFunc determines whethers two keys are 'equal'. Keys that are 'equal'
|
|
// are teated as the same by the [Table]. A good EqualFunc is pure,
|
|
// deterministic, and fast. By default, [New] uses [DefaultEqualFunc].
|
|
//
|
|
// This function MUST NOT return true if the [Hash] digest of two keys
|
|
// are different: the [Table] will not work.
|
|
type EqualFunc[K any] = func(a, b K) bool
|
|
|
|
// DefaultEqualFunc compares two keys by strict equality. Returns true if the
|
|
// keys have [equal values].
|
|
//
|
|
// [equal values]: https://go.dev/ref/spec#Comparison_operators
|
|
func DefaultEqualFunc[K comparable](a, b K) bool {
|
|
return a == b
|
|
}
|