refactor: constructors, update docs

- NewCustomTable -> NewCustom
- NewTableBy -> NewBy
- NewTable -> New
This commit is contained in:
2026-04-04 12:27:53 +02:00
parent 2fd9da973b
commit 395a3560c7
10 changed files with 48 additions and 50 deletions

View File

@@ -1,11 +1,11 @@
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, [NewTable] uses [DefaultEqualFunc].
// are teated as the same by the [HashTable]. 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.
// are different: the [HashTable] will not work.
type EqualFunc[K any] = func(a, b K) bool
// DefaultEqualFunc compares two keys by strict equality. Returns true if the