Merge remote-tracking branch 'origin' into refactor/name-bucket-slot-table

- Removed instances of `growthFactor`, as it is unexported.
- Typo in `HashTable.String()`.

.gitea/workflows/ci.yml

@@ -32,8 +32,9 @@ jobs:
       - name: Check go mod tidy
         run: go mod tidy && git diff --exit-code go.mod go.sum
 
-      - name: Run linter
+      - uses: golangci/golangci-lint-action@v7
-        run: make lint-go
+        with:
+          version: latest
 
   lint-makefile:
     name: Makefile Lint
@@ -45,6 +46,9 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - name: Install gremlins
+        run: go install github.com/checkmake/checkmake/cmd/checkmake@latest
+
       - name: Run mutation tests
         run: make lint-makefile
 
@@ -92,5 +96,8 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - name: Install gremlins
+        run: go install github.com/go-gremlins/gremlins/cmd/gremlins@latest
+
       - name: Run mutation tests
         run: make test-mutation

.golangci.yml

@@ -114,9 +114,6 @@ linters:
     # Reports uses of functions with replacement inside the testing package.
     - usetesting
 
-    # Reports mixed receiver types in structs/interfaces.
-    - recvcheck
-
   settings:
     revive:
       rules:
@@ -201,7 +198,7 @@ linters:
 
         # warns when initialism, variable or package naming conventions are not followed.
         - name: var-naming
-    
+
     misspell:
       # Correct spellings using locale preferences for US or UK.
       # Setting locale to US will correct the British spelling of 'colour' to 'color'.

Makefile

@@ -4,13 +4,17 @@ help: ## Show this help
 	@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf "  %-15s %s\n", $$1, $$2}'
 
 install: ## Install dev tools
-	go mod download
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+	go install github.com/checkmake/checkmake/cmd/checkmake@latest
+	go install github.com/go-gremlins/gremlins/cmd/gremlins@latest
+	go install golang.org/x/tools/cmd/godoc@latest
+	go install golang.org/x/vuln/cmd/govulncheck@latest
 
 test-unit: ## Run unit tests with coverage
 	go test ./... -cover -v
 
 test-mutation: ## Run mutation tests with gremlins
-	go tool gremlins unleash
+	gremlins unleash
 
 FUZZ_TIME ?= 30
 
@@ -23,10 +27,10 @@ test-fuzz: ## Run all fuzz tests for 30s each
 test: test-unit test-mutation test-fuzz ## Run all tests
 
 lint-go: ## Lint Go code
-	go tool golangci-lint run ./...
+	golangci-lint run ./...
 
 lint-makefile: ## Lint the Makefile
-	go tool checkmake Makefile
+	checkmake Makefile
 
 lint-markdown: ## Lint Markdown files
 	docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md"
@@ -35,7 +39,7 @@ lint: lint-go lint-makefile lint-markdown ## Lint all code
 
 docs: ## Serve godoc locally
 	@echo ">>> Visit: http://localhost:6060/pkg/$$(go list -m)"
-	go tool godoc -http=:6060
+	godoc -http=:6060
 
 clean: ## Clean build and test caches
 	go clean -cache -testcache

compare.go

@@ -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,
+// 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

cuckoo_fuzz_test.go

@@ -68,22 +68,21 @@ func FuzzInsertLookup(f *testing.F) {
 
 		for _, step := range scenario.steps {
 			if step.drop {
-				ok := actual.Drop(step.key)
+				err := actual.Drop(step.key)
-				_, has := expected[step.key]
+				assert.NoError(err)
-				assert.Equal(ok, has)
 
 				delete(expected, step.key)
 
-				_, ok = actual.Get(step.key)
+				_, err = actual.Get(step.key)
-				assert.False(ok)
+				assert.Error(err)
 			} else {
 				err := actual.Put(step.key, step.value)
 				assert.NoError(err)
 
 				expected[step.key] = step.value
 
-				found, ok := actual.Get(step.key)
+				found, err := actual.Get(step.key)
-				assert.True(ok)
+				assert.NoError(err)
 				assert.Equal(step.value, found)
 			}
 

cuckoo_test.go

@@ -108,12 +108,12 @@ func TestGetMany(t *testing.T) {
 	}
 
 	for i := range 2_000 {
-		value, ok := table.Get(i)
+		value, err := table.Get(i)
 		if i < 1_000 {
-			assert.True(ok)
+			assert.NoError(err)
 			assert.Equal(value, true)
 		} else {
-			assert.False(ok)
+			assert.Error(err)
 		}
 	}
 }
@@ -124,9 +124,9 @@ func TestDropExistingItem(t *testing.T) {
 	table := cuckoo.New[int, bool]()
 	(table.Put(key, value))
 
-	had := table.Drop(key)
+	err := table.Drop(key)
 
-	assert.True(had)
+	assert.NoError(err)
 	assert.Equal(0, table.Size())
 	assert.False(table.Has(key))
 }
@@ -136,9 +136,9 @@ func TestDropNoItem(t *testing.T) {
 	key := 0
 	table := cuckoo.New[int, bool]()
 
-	had := table.Drop(key)
+	err := table.Drop(key)
 
-	assert.False(had)
+	assert.NoError(err)
 	assert.Equal(0, table.Size())
 	assert.False(table.Has(key))
 }
@@ -152,9 +152,10 @@ func TestDropItemCapacity(t *testing.T) {
 	)
 
 	startingCapacity := table.TotalCapacity()
-	table.Drop(key)
+	err := table.Drop(key)
 	endingCapacity := table.TotalCapacity()
 
+	assert.NoError(err)
 	assert.Equal(0, table.Size())
 	assert.Equal(uint64(128), startingCapacity)
 	assert.Equal(uint64(64), endingCapacity)
@@ -202,9 +203,9 @@ func TestDropResizeCapacity(t *testing.T) {
 
 	err1 := table.Put(0, true)
 	err2 := table.Put(1, true)
-	table.Drop(1)
+	err3 := table.Drop(1)
 
-	assert.NoError(errors.Join(err1, err2))
+	assert.NoError(errors.Join(err1, err2, err3))
 	assert.Equal(uint64(20), table.TotalCapacity())
 }
 

doc.go

@@ -5,8 +5,5 @@
 // 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

doc_example_test.go

@@ -14,19 +14,19 @@ func Example_basic() {
 		fmt.Println("Put error:", err)
 	}
 
-	if item, ok := table.Get(1); !ok {
+	if item, err := table.Get(1); err != nil {
-		fmt.Println("Not Found 1!")
+		fmt.Println("Error:", err)
 	} else {
 		fmt.Println("Found 1:", item)
 	}
 
-	if item, ok := table.Get(0); !ok {
+	if item, err := table.Get(0); err != nil {
-		fmt.Println("Not Found 0!")
+		fmt.Println("Error:", err)
 	} else {
 		fmt.Println("Found 0:", item)
 	}
 
 	// Output:
 	// Found 1: Hello, World!
-	// Not Found 0!
+	// Error: key '0' not found
 }

docs/adr/000_template.md

@@ -1,15 +0,0 @@
-# Title
-
-**Status**: <!-- Proposed, accepted, rejected, etc... -->
-
-## Context
-
-<!-- What is the issue that we're seeing that is motivating this decision or change? -->
-
-## Decision
-
-<!-- What is the change that we're proposing and/or doing? -->
-
-## Consequences
-
-<!-- What becomes easier or more difficult to do because of this change? -->

docs/adr/001_design_principles.md

@@ -1,46 +0,0 @@
-# Adopt Parity and Consistency as Principles For `go-cuckoo`
-
-**Status**: Accepted
-
-## Context
-
-I built `go-cuckoo`'s API interface without design intent.
-Up until now, I paid more attention implementing the underlying functionality of the cuckoo hashing.
-With the fundamentals of the algorithm built, I should revisit the interface.
-
-The goal of this project was to create an implementation of cuckoo hashing, while adhering to Go's idioms, and being as usable as possible.
-While the implementation does work, it lacks direction.
-
-## Decision
-
-To resolve this, I'm enforcing two new principles onto the contract of `go-cuckoo`:
-
-- **Parity (with `map`)**:
-  A `go-cuckoo` table should have the same core functionality as `map`.
-  By 'core', I mean `map`'s built-in syntax and functions (e.g. `range`, `m[k]`), and the `maps` package.
-  Higher parity means users can trust that `go-cuckoo` can do what `map` can do.
-
-- **Consistency (with `map`)**:
-  A `go-cuckoo` table should behave similarly to `map`, so users will intuitively know how to use it.
-  Higher consistency lowers the cognitive load users must carry.
-
-While these principles should guide the interface of `go-cuckoo`, they should not be absolute.
-The behavior of `go-cuckoo` is distinct from `map` (e.g. `Put` can fail; see `ErrBadHash`), so do not equate them.
-
-## Consequences
-
-1. The repository should contain a living document, describing the interface differences between `go-cuckoo` and `map`.
-   I should prioritize limiting any disparity.
-   (I already started work on branch `docs/interface-congruency-analysis`.)
-   - [ ] Produce the first draft to uncover any current disparity.
-   - [ ] Link the document to the `README.md`.
-2. Analyze the consistency of `go-cuckoo`'s current interface.
-   Unlike the analysis of parity, this should be a one time document.
-   Consistency is implicit to users, and does not need to be referenced.
-   But, any rationale should be documented in commit messages, or future ADRs.
-   - [ ] Produce the analysis document.
-   - [ ] Resolve any issues found.
-3. The repository should support both design principles.
-   As I resolve gaps in parity and consistency, I should feed any reusable heuristics back into the contributing guide.
-   - [ ] State these principles in the `README.md` and `doc.go`.
-   - [ ] Ground the contributing guide and pull request template in these new principles.

go.mod

@@ -4,225 +4,7 @@ go 1.25.6
 
 require github.com/stretchr/testify v1.11.1
 
-require (
+require github.com/kr/pretty v0.3.1 // indirect
-	4d63.com/gocheckcompilerdirectives v1.3.0 // indirect
-	4d63.com/gochecknoglobals v0.2.2 // indirect
-	charm.land/lipgloss/v2 v2.0.3 // indirect
-	codeberg.org/chavacava/garif v0.2.0 // indirect
-	codeberg.org/polyfloyd/go-errorlint v1.9.0 // indirect
-	dev.gaijin.team/go/exhaustruct/v4 v4.0.0 // indirect
-	dev.gaijin.team/go/golib v0.6.0 // indirect
-	github.com/4meepo/tagalign v1.4.3 // indirect
-	github.com/Abirdcfly/dupword v0.1.7 // indirect
-	github.com/AdminBenni/iota-mixing v1.0.0 // indirect
-	github.com/AlwxSin/noinlineerr v1.0.5 // indirect
-	github.com/Antonboom/errname v1.1.1 // indirect
-	github.com/Antonboom/nilnil v1.1.1 // indirect
-	github.com/Antonboom/testifylint v1.6.4 // indirect
-	github.com/BurntSushi/toml v1.6.0 // indirect
-	github.com/ClickHouse/clickhouse-go-linter v1.2.0 // indirect
-	github.com/Djarvur/go-err113 v0.1.1 // indirect
-	github.com/MakeNowJust/heredoc v1.0.0 // indirect
-	github.com/Masterminds/semver/v3 v3.5.0 // indirect
-	github.com/MirrexOne/unqueryvet v1.5.4 // indirect
-	github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect
-	github.com/alecthomas/chroma/v2 v2.24.1 // indirect
-	github.com/alecthomas/go-check-sumtype v0.3.1 // indirect
-	github.com/alexkohler/nakedret/v2 v2.0.6 // indirect
-	github.com/alexkohler/prealloc v1.1.0 // indirect
-	github.com/alfatraining/structtag v1.0.0 // indirect
-	github.com/alingse/asasalint v0.0.11 // indirect
-	github.com/alingse/nilnesserr v0.2.0 // indirect
-	github.com/ashanbrown/forbidigo/v2 v2.3.1 // indirect
-	github.com/ashanbrown/makezero/v2 v2.2.1 // indirect
-	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/bkielbasa/cyclop v1.2.3 // indirect
-	github.com/blizzy78/varnamelen v0.8.0 // indirect
-	github.com/bluekeyes/go-gitdiff v0.8.1 // indirect
-	github.com/bombsimon/wsl/v4 v4.7.0 // indirect
-	github.com/bombsimon/wsl/v5 v5.8.0 // indirect
-	github.com/breml/bidichk v0.3.3 // indirect
-	github.com/breml/errchkjson v0.4.1 // indirect
-	github.com/butuzov/ireturn v0.4.1 // indirect
-	github.com/butuzov/mirror v1.3.0 // indirect
-	github.com/catenacyber/perfsprint v0.10.1 // indirect
-	github.com/ccojocar/zxcvbn-go v1.0.4 // indirect
-	github.com/cespare/xxhash/v2 v2.3.0 // indirect
-	github.com/charithe/durationcheck v0.0.11 // indirect
-	github.com/charmbracelet/colorprofile v0.4.3 // indirect
-	github.com/charmbracelet/ultraviolet v0.0.0-20251205161215-1948445e3318 // indirect
-	github.com/charmbracelet/x/ansi v0.11.7 // indirect
-	github.com/charmbracelet/x/term v0.2.2 // indirect
-	github.com/charmbracelet/x/termios v0.1.1 // indirect
-	github.com/charmbracelet/x/windows v0.2.2 // indirect
-	github.com/checkmake/checkmake v0.3.2 // indirect
-	github.com/ckaznocha/intrange v0.3.1 // indirect
-	github.com/clipperhouse/displaywidth v0.11.0 // indirect
-	github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
-	github.com/curioswitch/go-reassign v0.3.0 // indirect
-	github.com/daixiang0/gci v0.13.7 // indirect
-	github.com/dave/dst v0.27.3 // indirect
-	github.com/denis-tingaikin/go-header v0.5.0 // indirect
-	github.com/dlclark/regexp2 v1.12.0 // indirect
-	github.com/ettle/strcase v0.2.0 // indirect
-	github.com/fatih/color v1.19.0 // indirect
-	github.com/fatih/structtag v1.2.0 // indirect
-	github.com/firefart/nonamedreturns v1.0.6 // indirect
-	github.com/fsnotify/fsnotify v1.9.0 // indirect
-	github.com/fzipp/gocyclo v0.6.0 // indirect
-	github.com/ghostiam/protogetter v0.3.20 // indirect
-	github.com/go-critic/go-critic v0.14.3 // indirect
-	github.com/go-gremlins/gremlins v0.6.0 // indirect
-	github.com/go-ini/ini v1.67.0 // indirect
-	github.com/go-toolsmith/astcast v1.1.0 // indirect
-	github.com/go-toolsmith/astcopy v1.1.0 // indirect
-	github.com/go-toolsmith/astequal v1.2.0 // indirect
-	github.com/go-toolsmith/astfmt v1.1.0 // indirect
-	github.com/go-toolsmith/astp v1.1.0 // indirect
-	github.com/go-toolsmith/strparse v1.1.0 // indirect
-	github.com/go-toolsmith/typep v1.1.0 // indirect
-	github.com/go-viper/mapstructure/v2 v2.5.0 // indirect
-	github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect
-	github.com/gobwas/glob v0.2.3 // indirect
-	github.com/godoc-lint/godoc-lint v0.11.2 // indirect
-	github.com/gofrs/flock v0.13.0 // indirect
-	github.com/golang/protobuf v1.5.3 // indirect
-	github.com/golangci/asciicheck v0.5.0 // indirect
-	github.com/golangci/dupl v0.0.0-20260401084720-c99c5cf5c202 // indirect
-	github.com/golangci/go-printf-func-name v0.1.1 // indirect
-	github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d // indirect
-	github.com/golangci/golangci-lint/v2 v2.12.2 // indirect
-	github.com/golangci/golines v0.15.0 // indirect
-	github.com/golangci/misspell v0.8.0 // indirect
-	github.com/golangci/plugin-module-register v0.1.2 // indirect
-	github.com/golangci/revgrep v0.8.0 // indirect
-	github.com/golangci/rowserrcheck v0.0.0-20260419091836-c5f79b8a11ba // indirect
-	github.com/golangci/swaggoswag v0.0.0-20250504205917-77f2aca3143e // indirect
-	github.com/golangci/unconvert v0.0.0-20250410112200-a129a6e6413e // indirect
-	github.com/google/go-cmp v0.7.0 // indirect
-	github.com/gordonklaus/ineffassign v0.2.0 // indirect
-	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
-	github.com/gostaticanalysis/comment v1.5.0 // indirect
-	github.com/gostaticanalysis/forcetypeassert v0.2.0 // indirect
-	github.com/gostaticanalysis/nilerr v0.1.2 // indirect
-	github.com/hako/durafmt v0.0.0-20210608085754-5c1018a4e16b // indirect
-	github.com/hashicorp/go-immutable-radix/v2 v2.1.0 // indirect
-	github.com/hashicorp/go-version v1.9.0 // indirect
-	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
-	github.com/hexops/gotextdiff v1.0.3 // indirect
-	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/jgautheron/goconst v1.10.0 // indirect
-	github.com/jjti/go-spancheck v0.6.5 // indirect
-	github.com/julz/importas v0.2.0 // indirect
-	github.com/karamaru-alpha/copyloopvar v1.2.2 // indirect
-	github.com/kisielk/errcheck v1.10.0 // indirect
-	github.com/kkHAIKE/contextcheck v1.1.6 // indirect
-	github.com/kulti/thelper v0.7.1 // indirect
-	github.com/kunwardeep/paralleltest v1.0.15 // indirect
-	github.com/lasiar/canonicalheader v1.1.2 // indirect
-	github.com/ldez/exptostd v0.4.5 // indirect
-	github.com/ldez/gomoddirectives v0.8.0 // indirect
-	github.com/ldez/grignotin v0.10.1 // indirect
-	github.com/ldez/structtags v0.6.1 // indirect
-	github.com/ldez/tagliatelle v0.7.2 // indirect
-	github.com/ldez/usetesting v0.5.0 // indirect
-	github.com/leonklingele/grouper v1.1.2 // indirect
-	github.com/lucasb-eyer/go-colorful v1.4.0 // indirect
-	github.com/macabu/inamedparam v0.2.0 // indirect
-	github.com/manuelarte/embeddedstructfieldcheck v0.4.0 // indirect
-	github.com/manuelarte/funcorder v0.6.0 // indirect
-	github.com/maratori/testableexamples v1.0.1 // indirect
-	github.com/maratori/testpackage v1.1.2 // indirect
-	github.com/matoous/godox v1.1.0 // indirect
-	github.com/mattn/go-colorable v0.1.14 // indirect
-	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mattn/go-runewidth v0.0.23 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
-	github.com/mgechev/revive v1.15.0 // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/moricho/tparallel v0.3.2 // indirect
-	github.com/muesli/cancelreader v0.2.2 // indirect
-	github.com/nakabonne/nestif v0.3.1 // indirect
-	github.com/nishanths/exhaustive v0.12.0 // indirect
-	github.com/nishanths/predeclared v0.2.2 // indirect
-	github.com/nunnatsa/ginkgolinter v0.23.0 // indirect
-	github.com/olekukonko/cat v0.0.0-20250911104152-50322a0618f6 // indirect
-	github.com/olekukonko/errors v1.1.0 // indirect
-	github.com/olekukonko/ll v0.1.3 // indirect
-	github.com/olekukonko/tablewriter v1.1.2 // indirect
-	github.com/pelletier/go-toml/v2 v2.3.1 // indirect
-	github.com/prometheus/client_golang v1.12.1 // indirect
-	github.com/prometheus/client_model v0.2.0 // indirect
-	github.com/prometheus/common v0.32.1 // indirect
-	github.com/prometheus/procfs v0.7.3 // indirect
-	github.com/quasilyte/go-ruleguard v0.4.5 // indirect
-	github.com/quasilyte/go-ruleguard/dsl v0.3.23 // indirect
-	github.com/quasilyte/gogrep v0.5.0 // indirect
-	github.com/quasilyte/regex/syntax v0.0.0-20210819130434-b3f0c404a727 // indirect
-	github.com/quasilyte/stdinfo v0.0.0-20220114132959-f7386bf02567 // indirect
-	github.com/raeperd/recvcheck v0.2.0 // indirect
-	github.com/rivo/uniseg v0.4.7 // indirect
-	github.com/rogpeppe/go-internal v1.14.1 // indirect
-	github.com/ryancurrah/gomodguard v1.4.1 // indirect
-	github.com/ryancurrah/gomodguard/v2 v2.1.3 // indirect
-	github.com/ryanrolds/sqlclosecheck v0.6.0 // indirect
-	github.com/sagikazarmark/locafero v0.12.0 // indirect
-	github.com/sanposhiho/wastedassign/v2 v2.1.0 // indirect
-	github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 // indirect
-	github.com/sashamelentyev/interfacebloat v1.1.0 // indirect
-	github.com/sashamelentyev/usestdlibvars v1.29.0 // indirect
-	github.com/securego/gosec/v2 v2.26.1 // indirect
-	github.com/sirupsen/logrus v1.9.4 // indirect
-	github.com/sivchari/containedctx v1.0.3 // indirect
-	github.com/sonatard/noctx v0.5.1 // indirect
-	github.com/sourcegraph/go-diff v0.8.0 // indirect
-	github.com/spf13/afero v1.15.0 // indirect
-	github.com/spf13/cast v1.10.0 // indirect
-	github.com/spf13/cobra v1.10.2 // indirect
-	github.com/spf13/pflag v1.0.10 // indirect
-	github.com/spf13/viper v1.21.0 // indirect
-	github.com/ssgreg/nlreturn/v2 v2.2.1 // indirect
-	github.com/stbenjam/no-sprintf-host-port v0.3.1 // indirect
-	github.com/stretchr/objx v0.5.2 // indirect
-	github.com/subosito/gotenv v1.6.0 // indirect
-	github.com/tetafro/godot v1.5.6 // indirect
-	github.com/timakin/bodyclose v0.0.0-20260129054331-73d1f95b84b4 // indirect
-	github.com/timonwong/loggercheck v0.11.0 // indirect
-	github.com/tomarrell/wrapcheck/v2 v2.12.0 // indirect
-	github.com/tommy-muehle/go-mnd/v2 v2.5.1 // indirect
-	github.com/ultraware/funlen v0.2.0 // indirect
-	github.com/ultraware/whitespace v0.2.0 // indirect
-	github.com/uudashr/gocognit v1.2.1 // indirect
-	github.com/uudashr/iface v1.4.2 // indirect
-	github.com/xen0n/gosmopolitan v1.3.0 // indirect
-	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
-	github.com/yagipy/maintidx v1.0.0 // indirect
-	github.com/yeya24/promlinter v0.3.0 // indirect
-	github.com/ykadowak/zerologlint v0.1.5 // indirect
-	github.com/yuin/goldmark v1.7.13 // indirect
-	gitlab.com/bosi/decorder v0.4.2 // indirect
-	go-simpler.org/musttag v0.14.0 // indirect
-	go-simpler.org/sloglint v0.12.0 // indirect
-	go.augendre.info/arangolint v0.4.0 // indirect
-	go.augendre.info/fatcontext v0.9.0 // indirect
-	go.uber.org/multierr v1.10.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
-	go.yaml.in/yaml/v3 v3.0.4 // indirect
-	golang.org/x/exp/typeparams v0.0.0-20260209203927-2842357ff358 // indirect
-	golang.org/x/mod v0.35.0 // indirect
-	golang.org/x/sync v0.20.0 // indirect
-	golang.org/x/sys v0.43.0 // indirect
-	golang.org/x/telemetry v0.0.0-20260421165255-392afab6f40e // indirect
-	golang.org/x/text v0.36.0 // indirect
-	golang.org/x/tools v0.44.0 // indirect
-	golang.org/x/tools/cmd/godoc v0.1.0-deprecated // indirect
-	golang.org/x/tools/godoc v0.1.0-deprecated // indirect
-	golang.org/x/vuln v1.3.0 // indirect
-	google.golang.org/protobuf v1.36.10 // indirect
-	honnef.co/go/tools v0.7.0 // indirect
-	mvdan.cc/gofumpt v0.9.2 // indirect
-	mvdan.cc/unparam v0.0.0-20251027182757-5beb8c8f8f15 // indirect
-)
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
@@ -230,11 +12,3 @@ require (
 	github.com/trailofbits/go-fuzz-utils v0.0.0-20260318143407-0907cafe7589
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
-
-tool (
-	github.com/checkmake/checkmake/cmd/checkmake
-	github.com/go-gremlins/gremlins/cmd/gremlins
-	github.com/golangci/golangci-lint/v2/cmd/golangci-lint
-	golang.org/x/tools/cmd/godoc
-	golang.org/x/vuln/cmd/govulncheck
-)

hash.go

@@ -7,9 +7,9 @@ import (
 // A Hash function maps any data to a fixed-length value (in this case, a
 // [uint64]).
 //
-// It is used by the [Table] to evenly distribute values
+// It is used by the [HashTable] to evenly distribute values
 // amongst its slots. A good hash function is uniform, [chaotic], and
-// deterministic. [Table] uses [NewDefaultHash] by default, which is built on
+// deterministic. [HashTable] uses [NewDefaultHash] by default, which is built on
 // [maphash.Comparable].
 //
 // [chaotic]: https://en.wikipedia.org/wiki/Avalanche_effect

hash_table.go

@@ -0,0 +1,246 @@
+package cuckoo
+
+import (
+	"errors"
+	"fmt"
+	"iter"
+	"math/bits"
+	"strings"
+)
+
+// ErrBadHash occurs when the hashes given to a [Table] cause too many key
+// collisions. Try rebuilding the table using:
+//
+//  1. Different hash seeds. Equal seeds produce equal hash functions, which
+//     always cycle.
+//  2. A different [Hash] algorithm.
+var ErrBadHash = errors.New("bad hash")
+
+// A HashTable which uses cuckoo hashing to resolve collision. Create
+// one with [New]. Or if you want more granularity, use [NewBy] or
+// [NewCustom].
+type HashTable[K, V any] struct {
+	tableA, tableB table[K, V]
+	growthFactor   uint64
+	minLoadFactor  float64
+}
+
+// TotalCapacity returns the number of slots allocated for the [HashTable]. To get the
+// number of slots filled, look at [HashTable.Size].
+func (t *HashTable[K, V]) TotalCapacity() uint64 {
+	return t.tableA.capacity + t.tableB.capacity
+}
+
+// Size returns how many slots are filled in the [HashTable].
+func (t *HashTable[K, V]) Size() int {
+	return int(t.tableA.size + t.tableB.size)
+}
+
+func log2(n uint64) (m int) {
+	return max(0, bits.Len64(n)-1)
+}
+
+func (t *HashTable[K, V]) maxEvictions() int {
+	return 3 * log2(t.TotalCapacity())
+}
+
+func (t *HashTable[K, V]) load() float64 {
+	// When there are no slots in the table, we still treat the load as 100%.
+	// Every slot in the table is full.
+	if t.TotalCapacity() == 0 {
+		return 1.0
+	}
+
+	return float64(t.Size()) / float64(t.TotalCapacity())
+}
+
+// resize clears all tables, changes the sizes of them to a specific capacity,
+// and fills them back up again. It is a helper function for [HashTable.grow] and
+// [HashTable.shrink]; use them instead.
+func (t *HashTable[K, V]) resize(capacity uint64) error {
+	entries := make([]entry[K, V], 0, t.Size())
+	for k, v := range t.Entries() {
+		entries = append(entries, entry[K, V]{k, v})
+	}
+
+	t.tableA.resize(capacity)
+	t.tableB.resize(capacity)
+
+	for _, entry := range entries {
+		if err := t.Put(entry.key, entry.value); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// grow increases the table's capacity by the growth factor. If the
+// capacity is 0, it increases it to 1.
+func (t *HashTable[K, V]) grow() error {
+	var newCapacity uint64
+
+	if t.TotalCapacity() == 0 {
+		newCapacity = 1
+	} else {
+		newCapacity = t.tableA.capacity * t.growthFactor
+	}
+
+	return t.resize(newCapacity)
+}
+
+// shrink reduces the table's capacity by the growth factor. It may
+// reduce it down to 0.
+func (t *HashTable[K, V]) shrink() error {
+	return t.resize(t.tableA.capacity / t.growthFactor)
+}
+
+// Get fetches the value for a key in the [HashTable]. Returns an error if no value
+// is found.
+func (t *HashTable[K, V]) Get(key K) (value V, err error) {
+	if item, ok := t.tableA.get(key); ok {
+		return item, nil
+	}
+
+	if item, ok := t.tableB.get(key); ok {
+		return item, nil
+	}
+
+	return value, fmt.Errorf("key '%v' not found", key)
+}
+
+// Has returns true if a key has a value in the table.
+func (t *HashTable[K, V]) Has(key K) (exists bool) {
+	_, err := t.Get(key)
+	return err == nil
+}
+
+// Put sets the value for a key. Returns error if its value cannot be set.
+func (t *HashTable[K, V]) Put(key K, value V) (err error) {
+	if t.tableA.update(key, value) {
+		return nil
+	}
+
+	if t.tableB.update(key, value) {
+		return nil
+	}
+
+	entry, eviction := entry[K, V]{key, value}, false
+	for range t.maxEvictions() {
+		if entry, eviction = t.tableA.evict(entry); !eviction {
+			return nil
+		}
+
+		if entry, eviction = t.tableB.evict(entry); !eviction {
+			return nil
+		}
+	}
+
+	if t.load() < t.minLoadFactor {
+		return fmt.Errorf("hash functions produced a cycle at load %d/%d: %w", t.Size(), t.TotalCapacity(), ErrBadHash)
+	}
+
+	if err := t.grow(); err != nil {
+		return err
+	}
+
+	return t.Put(entry.key, entry.value)
+}
+
+// Drop removes a value for a key in the table. Returns an error if its value
+// cannot be removed.
+func (t *HashTable[K, V]) Drop(key K) (err error) {
+	t.tableA.drop(key)
+	t.tableB.drop(key)
+
+	if t.load() < t.minLoadFactor {
+		return t.shrink()
+	}
+
+	return nil
+}
+
+// Entries returns an unordered sequence of all key-value pairs in the table.
+func (t *HashTable[K, V]) Entries() iter.Seq2[K, V] {
+	return func(yield func(K, V) bool) {
+		for _, slot := range t.tableA.slots {
+			if slot.occupied {
+				if !yield(slot.key, slot.value) {
+					return
+				}
+			}
+		}
+
+		for _, slot := range t.tableB.slots {
+			if slot.occupied {
+				if !yield(slot.key, slot.value) {
+					return
+				}
+			}
+		}
+	}
+}
+
+// String returns the entries of the table as a string in the format:
+// "table[k1:v1 k2:v2 ...]".
+func (t *HashTable[K, V]) String() string {
+	var sb strings.Builder
+	sb.WriteString("table[")
+
+	first := true
+	for k, v := range t.Entries() {
+		if !first {
+			sb.WriteString(" ")
+		}
+
+		fmt.Fprintf(&sb, "%v:%v", k, v)
+		first = false
+	}
+
+	sb.WriteString("]")
+	return sb.String()
+}
+
+// NewCustom creates a [HashTable] with custom [Hash] and [EqualFunc]
+// functions, along with any [Option] the user provides.
+func NewCustom[K, V any](hashA, hashB Hash[K], compare EqualFunc[K], options ...Option) *HashTable[K, V] {
+	settings := &settings{
+		growthFactor:  DefaultGrowthFactor,
+		bucketSize:    DefaultCapacity,
+		minLoadFactor: defaultMinimumLoad,
+	}
+
+	for _, option := range options {
+		option(settings)
+	}
+
+	return &HashTable[K, V]{
+		growthFactor:  settings.growthFactor,
+		minLoadFactor: settings.minLoadFactor,
+		tableA:        newTable[K, V](settings.bucketSize, hashA, compare),
+		tableB:        newTable[K, V](settings.bucketSize, hashB, compare),
+	}
+}
+
+func pipe[X, Y, Z any](a func(X) Y, b func(Y) Z) func(X) Z {
+	return func(x X) Z { return b(a(x)) }
+}
+
+// NewBy creates a [HashTable] for any key type by using keyFunc to derive a
+// comparable key. Two keys with the same derived key are treated as equal.
+func NewBy[K, V any, C comparable](keyFunc func(K) C, options ...Option) *HashTable[K, V] {
+	return NewCustom[K, V](
+		pipe(keyFunc, NewDefaultHash[C]()),
+		pipe(keyFunc, NewDefaultHash[C]()),
+		func(a, b K) bool { return keyFunc(a) == keyFunc(b) },
+		options...,
+	)
+}
+
+// New creates a [HashTable] using the default [Hash] and [EqualFunc]. Use
+// the [Option] functions to configure its behavior. Note that this constructor
+// is only provided for comparable keys. For arbitrary keys, consider
+// [NewBy] or [NewCustom].
+func New[K comparable, V any](options ...Option) *HashTable[K, V] {
+	return NewCustom[K, V](NewDefaultHash[K](), NewDefaultHash[K](), DefaultEqualFunc[K], options...)
+}

settings.go

@@ -2,39 +2,34 @@ package cuckoo
 
 import "fmt"
 
-// DefaultCapacity is the initial capacity of a [Table]. It is inspired from
+// DefaultCapacity is the initial capacity of a [HashTable]. It is inspired from
 // Java's [HashMap] implementation, which also uses 16.
 //
 // [HashMap]: https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#HashMap--
 const DefaultCapacity uint64 = 16
 
-// DefaultGrowthFactor is the standard resize multiplier for a [Table]. Most
+// DefaultGrowthFactor is the standard resize multiplier for a [HashTable]. Most
 // implementations use 2.
 const DefaultGrowthFactor uint64 = 2
 
-// defaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
+// defaultMinimumLoad is the default lowest acceptable occupancy of a [HashTable].
-// The higher the minimum load, the more likely that a [Table.Put] will not
+// The higher the minimum load, the more likely that a [HashTable.Put] will not
 // succeed. The value of 5% is taken from [libcuckoo].
 //
 // [libcuckoo]: https://github.com/efficient/libcuckoo/blob/656714705a055df2b7a605eb3c71586d9da1e119/libcuckoo/cuckoohash_config.hh#L21
 const defaultMinimumLoad float64 = 0.05
 
-// defaultGrowthLimit is the maximum number of times a [Table] can grow in a
-// single [Table.Put], before the library infers it will lead to a stack
-// overflow. The value of '64' was chosen arbirarily.
-const defaultGrowthLimit uint64 = 64
-
 type settings struct {
 	growthFactor  uint64
 	minLoadFactor float64
 	bucketSize    uint64
 }
 
-// An Option modifies the settings of a [Table]. It is used in its constructors
+// An Option modifies the settings of a [HashTable]. It is used in its constructors
 // like [New], for example.
 type Option func(*settings)
 
-// Capacity modifies the starting capacity of each subtable of the [Table]. The
+// Capacity modifies the starting capacity of each table of the [HashTable]. The
 // value must be non-negative.
 func Capacity(value int) Option {
 	if value < 0 {
@@ -44,7 +39,7 @@ func Capacity(value int) Option {
 	return func(s *settings) { s.bucketSize = uint64(value) }
 }
 
-// GrowthFactor controls how much the capacity of the [Table] multiplies when
+// GrowthFactor controls how much the capacity of the [HashTable] multiplies when
 // it must resize. The value must be greater than 1.
 func GrowthFactor(value int) Option {
 	if value < 2 {

subtable.go

@@ -1,107 +0,0 @@
-package cuckoo
-
-// An entry is a key-value pair.
-type entry[K, V any] struct {
-	key   K
-	value V
-}
-
-type slot[K, V any] struct {
-	entry[K, V]
-	occupied bool
-}
-
-type subtable[K, V any] struct {
-	hash           Hash[K]
-	slots          []slot[K, V]
-	capacity, size uint64
-	compare        EqualFunc[K]
-}
-
-// location determines where in the subtable a certain key would be placed. If
-// the capacity is 0, this will panic.
-func (t *subtable[K, V]) location(key K) uint64 {
-	return t.hash(key) % t.capacity
-}
-
-func (t *subtable[K, V]) get(key K) (value V, found bool) {
-	if t.capacity == 0 {
-		return
-	}
-
-	slot := t.slots[t.location(key)]
-	return slot.value, slot.occupied && t.compare(slot.key, key)
-}
-
-func (t *subtable[K, V]) drop(key K) (occupied bool) {
-	if t.capacity == 0 {
-		return
-	}
-
-	slot := &t.slots[t.location(key)]
-
-	if slot.occupied && t.compare(slot.key, key) {
-		slot.occupied = false
-		t.size--
-		return true
-	}
-
-	return false
-}
-
-func (t *subtable[K, V]) resized(capacity uint64) *subtable[K, V] {
-	return &subtable[K, V]{
-		slots:    make([]slot[K, V], capacity),
-		capacity: capacity,
-		hash:     t.hash,
-		compare:  t.compare,
-	}
-}
-
-func (t *subtable[K, V]) update(key K, value V) (updated bool) {
-	if t.capacity == 0 {
-		return
-	}
-
-	slot := &t.slots[t.location(key)]
-
-	if slot.occupied && t.compare(slot.key, key) {
-		slot.value = value
-		return true
-	}
-
-	return false
-}
-
-func (t *subtable[K, V]) insert(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
-	if t.capacity == 0 {
-		return insertion, true
-	}
-
-	slot := &t.slots[t.location(insertion.key)]
-
-	if !slot.occupied {
-		slot.entry = insertion
-		slot.occupied = true
-		t.size++
-		return
-	}
-
-	if t.compare(slot.key, insertion.key) {
-		slot.value = insertion.value
-		return
-	}
-
-	insertion, slot.entry = slot.entry, insertion
-	return insertion, true
-}
-
-func newSubtable[K, V any](capacity uint64, hash Hash[K], compare EqualFunc[K]) *subtable[K, V] {
-	return &subtable[K, V]{
-		hash:     hash,
-		capacity: capacity,
-		compare:  compare,
-		size:     0,
-		slots:    make([]slot[K, V], capacity),
-	}
-}

table.go

@@ -1,283 +1,103 @@
 package cuckoo
 
-import (
+type entry[K, V any] struct {
-	"errors"
+	key   K
-	"fmt"
+	value V
-	"iter"
-	"math/bits"
-	"strings"
-)
-
-// ErrBadHash occurs when the hashes given to a [Table] cause too many key
-// collisions. Discard the old table, rebuild it from your source data, and try:
-//
-//  1. Different hash seeds. Equal seeds produce equal hash functions, which
-//     always cycle.
-//  2. A different [Hash] algorithm.
-var ErrBadHash = errors.New("bad hash")
-
-// A Table which uses cuckoo hashing to resolve collision. Create
-// one with [New]. Or if you want more granularity, use [NewBy] or
-// [NewCustom].
-type Table[K, V any] struct {
-	tableA, tableB *subtable[K, V]
-	growthFactor   uint64
-	minLoadFactor  float64
 }
 
-// TotalCapacity returns the number of slots allocated for the [Table]. To get the
+type slot[K, V any] struct {
-// number of slots filled, look at [Table.Size].
+	entry[K, V]
-func (t *Table[K, V]) TotalCapacity() uint64 {
+	occupied bool
-	return t.tableA.capacity + t.tableB.capacity
 }
 
-// Size returns how many slots are filled in the [Table].
+type table[K, V any] struct {
-func (t *Table[K, V]) Size() int {
+	hash           Hash[K]
-	return int(t.tableA.size + t.tableB.size)
+	slots          []slot[K, V]
+	capacity, size uint64
+	compare        EqualFunc[K]
 }
 
-func log2(n uint64) (m int) {
+// location determines where in the table a certain key would be placed. If the
-	return max(0, bits.Len64(n)-1)
+// capacity is 0, this will panic.
+func (t table[K, V]) location(key K) uint64 {
+	return t.hash(key) % t.capacity
 }
 
-func (t *Table[K, V]) maxEvictions() int {
+func (t table[K, V]) get(key K) (value V, found bool) {
-	return 3 * log2(t.TotalCapacity())
+	if t.capacity == 0 {
-}
-
-func (t *Table[K, V]) load() float64 {
-	// When there are no slots in the table, we still treat the load as 100%.
-	// Every slot in the table is full.
-	if t.TotalCapacity() == 0 {
-		return 1.0
-	}
-
-	return float64(t.Size()) / float64(t.TotalCapacity())
-}
-
-// insert attempts to put/update an entry in the table, without modifying the
-// size of the table. Returns a displaced entry and 'homeless = true' if an
-// entry could not be placed after exhausting evictions.
-func (t *Table[K, V]) insert(entry entry[K, V]) (displaced entry[K, V], homeless bool) {
-	if t.tableA.update(entry.key, entry.value) {
 		return
 	}
 
-	if t.tableB.update(entry.key, entry.value) {
+	slot := t.slots[t.location(key)]
+	return slot.value, slot.occupied && t.compare(slot.key, key)
+}
+
+func (t *table[K, V]) drop(key K) (occupied bool) {
+	if t.capacity == 0 {
 		return
 	}
 
-	for range t.maxEvictions() {
+	slot := &t.slots[t.location(key)]
-		if entry, homeless = t.tableA.insert(entry); !homeless {
-			return
-		}
 
-		if entry, homeless = t.tableB.insert(entry); !homeless {
+	if slot.occupied && t.compare(slot.key, key) {
-			return
+		slot.occupied = false
-		}
+		t.size--
+		return true
 	}
 
-	return entry, true
+	return false
 }
 
-// resized creates an empty copy of the table, with a new capacity for each
+func (t *table[K, V]) resize(capacity uint64) {
-// bucket.
+	t.slots = make([]slot[K, V], capacity)
-func (t *Table[K, V]) resized(capacity uint64) *Table[K, V] {
+	t.capacity = capacity
-	return &Table[K, V]{
+	t.size = 0
-		growthFactor:  t.growthFactor,
-		minLoadFactor: t.minLoadFactor,
-		tableA:        t.tableA.resized(capacity),
-		tableB:        t.tableB.resized(capacity),
-	}
 }
 
-// resize creates a new [Table.resized] with 'capacity', inserts all items into
+func (t table[K, V]) update(key K, value V) (updated bool) {
-// the array, and replaces the current table. It is a helper function for
+	if t.capacity == 0 {
-// [Table.grow] and [Table.shrink]; use them instead.
+		return
-func (t *Table[K, V]) resize(capacity uint64) bool {
-	updated := t.resized(capacity)
-
-	for k, v := range t.Entries() {
-		if _, failed := updated.insert(entry[K, V]{k, v}); failed {
-			return false
-		}
 	}
 
-	*t = *updated
+	slot := &t.slots[t.location(key)]
-	return true
-}
 
-// grow increases the table's capacity by the growth factor. If the
+	if slot.occupied && t.compare(slot.key, key) {
-// capacity is 0, it increases it to 1.
+		slot.value = value
-func (t *Table[K, V]) grow() bool {
+		return true
-	var newCapacity uint64
-
-	if t.TotalCapacity() == 0 {
-		newCapacity = 1
-	} else {
-		newCapacity = t.tableA.capacity * t.growthFactor
 	}
 
-	return t.resize(newCapacity)
+	return false
 }
 
-// shrink reduces the table's capacity by the growth factor. It may
+func (t *table[K, V]) evict(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
-// reduce it down to 0.
+	if t.capacity == 0 {
-func (t *Table[K, V]) shrink() bool {
+		return insertion, true
-	return t.resize(t.tableA.capacity / t.growthFactor)
-}
-
-// Get fetches the value for a key in the [Table]. Matches the comma-ok pattern
-// of a builtin map; see [Table.Find] for plain indexing.
-func (t *Table[K, V]) Get(key K) (value V, ok bool) {
-	if item, ok := t.tableA.get(key); ok {
-		return item, true
 	}
 
-	if item, ok := t.tableB.get(key); ok {
+	slot := &t.slots[t.location(insertion.key)]
-		return item, true
+
+	if !slot.occupied {
+		slot.entry = insertion
+		slot.occupied = true
+		t.size++
+		return
 	}
 
-	return
+	if t.compare(slot.key, insertion.key) {
-}
+		slot.value = insertion.value
-
+		return
-// Find fetches the value of a key. Matches direct indexing of a builtin map;
-// see [Table.Get] for a comma-ok pattern.
-func (t *Table[K, V]) Find(key K) (value V) {
-	value, _ = t.Get(key)
-	return
-}
-
-// Has returns true if a key has a value in the table.
-func (t *Table[K, V]) Has(key K) (exists bool) {
-	_, exists = t.Get(key)
-	return
-}
-
-// Put sets the value for a key. If it cannot be set, an error is returned.
-func (t *Table[K, V]) Put(key K, value V) (err error) {
-	var (
-		entry    = entry[K, V]{key, value}
-		homeless bool
-	)
-
-	for range defaultGrowthLimit {
-		if entry, homeless = t.insert(entry); !homeless {
-			return
-		}
-
-		// Both this and the growth limit are necessary: this catches bad hashes
-		// early when the table is sparse, while the latter catches cases where
-		// growing never helps.
-		if t.load() < t.minLoadFactor {
-			return fmt.Errorf("hash functions produced a cycle at load %d/%d: %w", t.Size(), t.TotalCapacity(), ErrBadHash)
-		}
-
-		// It is theoretically possible to have a table with a larger capacity
-		// that is valid. But this chance is astronomically small, so we ignore
-		// it in this implementation.
-		if grew := t.grow(); !grew {
-			return fmt.Errorf("could not redistribute entries into larger table: %w", ErrBadHash)
-		}
 	}
 
-	return fmt.Errorf("could not place entry after %d resizes: %w", defaultGrowthLimit, ErrBadHash)
+	insertion, slot.entry = slot.entry, insertion
+	return insertion, true
 }
 
-// Drop removes a value for a key in the table. Returns whether the key had
+func newTable[K, V any](capacity uint64, hash Hash[K], compare EqualFunc[K]) table[K, V] {
-// existed.
+	return table[K, V]{
-func (t *Table[K, V]) Drop(key K) bool {
+		hash:     hash,
-	occupied := t.tableA.drop(key) || t.tableB.drop(key)
+		capacity: capacity,
-
+		compare:  compare,
-	if t.load() < t.minLoadFactor {
+		size:     0,
-		// The error is not handled here, because table-shrinking is an internal
+		slots:    make([]slot[K, V], capacity),
-		// optimization.
-		t.shrink()
-	}
-
-	return occupied
-}
-
-// Entries returns an unordered sequence of all key-value pairs in the table.
-func (t *Table[K, V]) Entries() iter.Seq2[K, V] {
-	return func(yield func(K, V) bool) {
-		for _, slot := range t.tableA.slots {
-			if slot.occupied {
-				if !yield(slot.key, slot.value) {
-					return
-				}
-			}
-		}
-
-		for _, slot := range t.tableB.slots {
-			if slot.occupied {
-				if !yield(slot.key, slot.value) {
-					return
-				}
-			}
-		}
 	}
 }
-
-// String returns the entries of the table as a string in the format:
-// "table[k1:v1 k2:v2 ...]".
-func (t *Table[K, V]) String() string {
-	var sb strings.Builder
-	sb.WriteString("table[")
-
-	first := true
-	for k, v := range t.Entries() {
-		if !first {
-			sb.WriteString(" ")
-		}
-
-		fmt.Fprintf(&sb, "%v:%v", k, v)
-		first = false
-	}
-
-	sb.WriteString("]")
-	return sb.String()
-}
-
-// NewCustom creates a [Table] with custom [Hash] and [EqualFunc]
-// functions, along with any [Option] the user provides.
-func NewCustom[K, V any](hashA, hashB Hash[K], compare EqualFunc[K], options ...Option) *Table[K, V] {
-	settings := &settings{
-		growthFactor:  DefaultGrowthFactor,
-		bucketSize:    DefaultCapacity,
-		minLoadFactor: defaultMinimumLoad,
-	}
-
-	for _, option := range options {
-		option(settings)
-	}
-
-	return &Table[K, V]{
-		growthFactor:  settings.growthFactor,
-		minLoadFactor: settings.minLoadFactor,
-		tableA:        newSubtable[K, V](settings.bucketSize, hashA, compare),
-		tableB:        newSubtable[K, V](settings.bucketSize, hashB, compare),
-	}
-}
-
-func pipe[X, Y, Z any](a func(X) Y, b func(Y) Z) func(X) Z {
-	return func(x X) Z { return b(a(x)) }
-}
-
-// NewBy creates a [Table] for any key type by using keyFunc to derive a
-// comparable key. Two keys with the same derived key are treated as equal.
-func NewBy[K, V any, C comparable](keyFunc func(K) C, options ...Option) *Table[K, V] {
-	return NewCustom[K, V](
-		pipe(keyFunc, NewDefaultHash[C]()),
-		pipe(keyFunc, NewDefaultHash[C]()),
-		func(a, b K) bool { return keyFunc(a) == keyFunc(b) },
-		options...,
-	)
-}
-
-// New creates a [Table] using the default [Hash] and [EqualFunc]. Use
-// the [Option] functions to configure its behavior. Note that this constructor
-// is only provided for comparable keys. For arbitrary keys, consider
-// [NewBy] or [NewCustom].
-func New[K comparable, V any](options ...Option) *Table[K, V] {
-	return NewCustom[K, V](NewDefaultHash[K](), NewDefaultHash[K](), DefaultEqualFunc[K], options...)
-}