Compare commits
3 Commits
v0.3.0
..
4d808a2ac5
| Author | SHA1 | Date | |
|---|---|---|---|
|
4d808a2ac5
|
|||
|
4d0cab1fe0
|
|||
| 39548b4332 |
@@ -4,17 +4,13 @@ help: ## Show this help
|
||||
@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf " %-15s %s\n", $$1, $$2}'
|
||||
|
||||
install: ## Install dev tools
|
||||
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
|
||||
go mod download
|
||||
|
||||
test-unit: ## Run unit tests with coverage
|
||||
go test ./... -cover -v
|
||||
|
||||
test-mutation: ## Run mutation tests with gremlins
|
||||
gremlins unleash
|
||||
go tool gremlins unleash
|
||||
|
||||
FUZZ_TIME ?= 30
|
||||
|
||||
@@ -27,10 +23,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
|
||||
golangci-lint run ./...
|
||||
go tool golangci-lint run ./...
|
||||
|
||||
lint-makefile: ## Lint the Makefile
|
||||
checkmake Makefile
|
||||
go tool checkmake Makefile
|
||||
|
||||
lint-markdown: ## Lint Markdown files
|
||||
docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md"
|
||||
@@ -39,7 +35,7 @@ lint: lint-go lint-makefile lint-markdown ## Lint all code
|
||||
|
||||
docs: ## Serve godoc locally
|
||||
@echo ">>> Visit: http://localhost:6060/pkg/$$(go list -m)"
|
||||
godoc -http=:6060
|
||||
go tool godoc -http=:6060
|
||||
|
||||
clean: ## Clean build and test caches
|
||||
go clean -cache -testcache
|
||||
|
||||
+4
-3
@@ -68,12 +68,13 @@ func FuzzInsertLookup(f *testing.F) {
|
||||
|
||||
for _, step := range scenario.steps {
|
||||
if step.drop {
|
||||
err := actual.Drop(step.key)
|
||||
assert.NoError(err)
|
||||
ok := actual.Drop(step.key)
|
||||
_, has := expected[step.key]
|
||||
assert.Equal(ok, has)
|
||||
|
||||
delete(expected, step.key)
|
||||
|
||||
_, ok := actual.Get(step.key)
|
||||
_, ok = actual.Get(step.key)
|
||||
assert.False(ok)
|
||||
} else {
|
||||
err := actual.Put(step.key, step.value)
|
||||
|
||||
+7
-8
@@ -124,9 +124,9 @@ func TestDropExistingItem(t *testing.T) {
|
||||
table := cuckoo.New[int, bool]()
|
||||
(table.Put(key, value))
|
||||
|
||||
err := table.Drop(key)
|
||||
had := table.Drop(key)
|
||||
|
||||
assert.NoError(err)
|
||||
assert.True(had)
|
||||
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]()
|
||||
|
||||
err := table.Drop(key)
|
||||
had := table.Drop(key)
|
||||
|
||||
assert.NoError(err)
|
||||
assert.False(had)
|
||||
assert.Equal(0, table.Size())
|
||||
assert.False(table.Has(key))
|
||||
}
|
||||
@@ -152,10 +152,9 @@ func TestDropItemCapacity(t *testing.T) {
|
||||
)
|
||||
|
||||
startingCapacity := table.TotalCapacity()
|
||||
err := table.Drop(key)
|
||||
table.Drop(key)
|
||||
endingCapacity := table.TotalCapacity()
|
||||
|
||||
assert.NoError(err)
|
||||
assert.Equal(0, table.Size())
|
||||
assert.Equal(uint64(128), startingCapacity)
|
||||
assert.Equal(uint64(64), endingCapacity)
|
||||
@@ -203,9 +202,9 @@ func TestDropResizeCapacity(t *testing.T) {
|
||||
|
||||
err1 := table.Put(0, true)
|
||||
err2 := table.Put(1, true)
|
||||
err3 := table.Drop(1)
|
||||
table.Drop(1)
|
||||
|
||||
assert.NoError(errors.Join(err1, err2, err3))
|
||||
assert.NoError(errors.Join(err1, err2))
|
||||
assert.Equal(uint64(20), table.TotalCapacity())
|
||||
}
|
||||
|
||||
|
||||
@@ -5,5 +5,8 @@
|
||||
// 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
|
||||
|
||||
@@ -4,7 +4,201 @@ go 1.25.6
|
||||
|
||||
require github.com/stretchr/testify v1.11.1
|
||||
|
||||
require github.com/kr/pretty v0.3.1 // indirect
|
||||
require (
|
||||
4d63.com/gocheckcompilerdirectives v1.3.0 // indirect
|
||||
4d63.com/gochecknoglobals v0.2.2 // indirect
|
||||
github.com/4meepo/tagalign v1.4.2 // indirect
|
||||
github.com/Abirdcfly/dupword v0.1.3 // indirect
|
||||
github.com/Antonboom/errname v1.0.0 // indirect
|
||||
github.com/Antonboom/nilnil v1.0.1 // indirect
|
||||
github.com/Antonboom/testifylint v1.5.2 // indirect
|
||||
github.com/BurntSushi/toml v1.4.1-0.20240526193622-a339e1f7089c // indirect
|
||||
github.com/Crocmagnon/fatcontext v0.7.1 // indirect
|
||||
github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24 // indirect
|
||||
github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1 // indirect
|
||||
github.com/MakeNowJust/heredoc v1.0.0 // indirect
|
||||
github.com/Masterminds/semver/v3 v3.3.0 // indirect
|
||||
github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect
|
||||
github.com/alecthomas/go-check-sumtype v0.3.1 // indirect
|
||||
github.com/alexkohler/nakedret/v2 v2.0.5 // indirect
|
||||
github.com/alexkohler/prealloc v1.0.0 // indirect
|
||||
github.com/alingse/asasalint v0.0.11 // indirect
|
||||
github.com/alingse/nilnesserr v0.1.2 // indirect
|
||||
github.com/ashanbrown/forbidigo v1.6.0 // indirect
|
||||
github.com/ashanbrown/makezero v1.2.0 // 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.5.0 // indirect
|
||||
github.com/breml/bidichk v0.3.2 // indirect
|
||||
github.com/breml/errchkjson v0.4.0 // indirect
|
||||
github.com/butuzov/ireturn v0.3.1 // indirect
|
||||
github.com/butuzov/mirror v1.3.0 // indirect
|
||||
github.com/catenacyber/perfsprint v0.8.2 // indirect
|
||||
github.com/ccojocar/zxcvbn-go v1.0.2 // indirect
|
||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
||||
github.com/charithe/durationcheck v0.0.10 // indirect
|
||||
github.com/chavacava/garif v0.1.0 // indirect
|
||||
github.com/checkmake/checkmake v0.3.2 // indirect
|
||||
github.com/ckaznocha/intrange v0.3.0 // indirect
|
||||
github.com/clipperhouse/displaywidth v0.6.0 // indirect
|
||||
github.com/clipperhouse/stringish v0.1.1 // indirect
|
||||
github.com/clipperhouse/uax29/v2 v2.3.0 // indirect
|
||||
github.com/curioswitch/go-reassign v0.3.0 // indirect
|
||||
github.com/daixiang0/gci v0.13.5 // indirect
|
||||
github.com/denis-tingaikin/go-header v0.5.0 // indirect
|
||||
github.com/ettle/strcase v0.2.0 // indirect
|
||||
github.com/fatih/color v1.18.0 // indirect
|
||||
github.com/fatih/structtag v1.2.0 // indirect
|
||||
github.com/firefart/nonamedreturns v1.0.5 // indirect
|
||||
github.com/fsnotify/fsnotify v1.9.0 // indirect
|
||||
github.com/fzipp/gocyclo v0.6.0 // indirect
|
||||
github.com/ghostiam/protogetter v0.3.9 // indirect
|
||||
github.com/go-critic/go-critic v0.12.0 // 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.4.0 // indirect
|
||||
github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect
|
||||
github.com/gobwas/glob v0.2.3 // indirect
|
||||
github.com/gofrs/flock v0.12.1 // indirect
|
||||
github.com/golang/protobuf v1.5.3 // indirect
|
||||
github.com/golangci/dupl v0.0.0-20250308024227-f665c8d69b32 // indirect
|
||||
github.com/golangci/go-printf-func-name v0.1.0 // indirect
|
||||
github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d // indirect
|
||||
github.com/golangci/golangci-lint v1.64.8 // indirect
|
||||
github.com/golangci/misspell v0.6.0 // indirect
|
||||
github.com/golangci/plugin-module-register v0.1.1 // indirect
|
||||
github.com/golangci/revgrep v0.8.0 // indirect
|
||||
github.com/golangci/unconvert v0.0.0-20240309020433-c5143eacb3ed // indirect
|
||||
github.com/google/go-cmp v0.7.0 // indirect
|
||||
github.com/gordonklaus/ineffassign v0.1.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.1 // 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.7.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.7.1 // indirect
|
||||
github.com/jingyugao/rowserrcheck v1.1.1 // indirect
|
||||
github.com/jjti/go-spancheck v0.6.4 // indirect
|
||||
github.com/julz/importas v0.2.0 // indirect
|
||||
github.com/karamaru-alpha/copyloopvar v1.2.1 // indirect
|
||||
github.com/kisielk/errcheck v1.9.0 // indirect
|
||||
github.com/kkHAIKE/contextcheck v1.1.6 // indirect
|
||||
github.com/kulti/thelper v0.6.3 // indirect
|
||||
github.com/kunwardeep/paralleltest v1.0.10 // indirect
|
||||
github.com/lasiar/canonicalheader v1.1.2 // indirect
|
||||
github.com/ldez/exptostd v0.4.2 // indirect
|
||||
github.com/ldez/gomoddirectives v0.6.1 // indirect
|
||||
github.com/ldez/grignotin v0.9.0 // indirect
|
||||
github.com/ldez/tagliatelle v0.7.1 // indirect
|
||||
github.com/ldez/usetesting v0.4.2 // indirect
|
||||
github.com/leonklingele/grouper v1.1.2 // indirect
|
||||
github.com/macabu/inamedparam v0.1.3 // indirect
|
||||
github.com/maratori/testableexamples v1.0.0 // indirect
|
||||
github.com/maratori/testpackage v1.1.1 // 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.19 // indirect
|
||||
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
|
||||
github.com/mgechev/revive v1.7.0 // indirect
|
||||
github.com/mitchellh/go-homedir v1.1.0 // indirect
|
||||
github.com/moricho/tparallel v0.3.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.19.1 // 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.2.4 // indirect
|
||||
github.com/polyfloyd/go-errorlint v1.7.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.3-0.20240823090925-0fe6f58b47b1 // indirect
|
||||
github.com/quasilyte/go-ruleguard/dsl v0.3.22 // 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/rogpeppe/go-internal v1.14.1 // indirect
|
||||
github.com/ryancurrah/gomodguard v1.3.5 // indirect
|
||||
github.com/ryanrolds/sqlclosecheck v0.5.1 // 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.1 // indirect
|
||||
github.com/sashamelentyev/interfacebloat v1.1.0 // indirect
|
||||
github.com/sashamelentyev/usestdlibvars v1.28.0 // indirect
|
||||
github.com/securego/gosec/v2 v2.22.2 // indirect
|
||||
github.com/sirupsen/logrus v1.9.3 // indirect
|
||||
github.com/sivchari/containedctx v1.0.3 // indirect
|
||||
github.com/sivchari/tenv v1.12.1 // indirect
|
||||
github.com/sonatard/noctx v0.1.0 // indirect
|
||||
github.com/sourcegraph/go-diff v0.7.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.2.0 // indirect
|
||||
github.com/stretchr/objx v0.5.2 // indirect
|
||||
github.com/subosito/gotenv v1.6.0 // indirect
|
||||
github.com/tdakkota/asciicheck v0.4.1 // indirect
|
||||
github.com/tetafro/godot v1.5.0 // indirect
|
||||
github.com/timakin/bodyclose v0.0.0-20241017074812-ed6a65f985e3 // indirect
|
||||
github.com/timonwong/loggercheck v0.10.1 // indirect
|
||||
github.com/tomarrell/wrapcheck/v2 v2.10.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.0 // indirect
|
||||
github.com/uudashr/iface v1.3.1 // indirect
|
||||
github.com/xen0n/gosmopolitan v1.2.2 // 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.13.0 // indirect
|
||||
go-simpler.org/sloglint v0.9.0 // indirect
|
||||
go.uber.org/atomic v1.7.0 // indirect
|
||||
go.uber.org/automaxprocs v1.6.0 // indirect
|
||||
go.uber.org/multierr v1.6.0 // indirect
|
||||
go.uber.org/zap v1.24.0 // indirect
|
||||
go.yaml.in/yaml/v3 v3.0.4 // indirect
|
||||
golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac // 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.31.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.5 // indirect
|
||||
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||
honnef.co/go/tools v0.6.1 // indirect
|
||||
mvdan.cc/gofumpt v0.7.0 // indirect
|
||||
mvdan.cc/unparam v0.0.0-20240528143540-8a5130ca722f // indirect
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
@@ -12,3 +206,11 @@ 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/cmd/golangci-lint
|
||||
golang.org/x/tools/cmd/godoc
|
||||
golang.org/x/vuln/cmd/govulncheck
|
||||
)
|
||||
|
||||
@@ -19,6 +19,11 @@ const DefaultGrowthFactor uint64 = 2
|
||||
// [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
|
||||
|
||||
+11
-7
@@ -1,5 +1,6 @@
|
||||
package cuckoo
|
||||
|
||||
// An entry is a key-value pair.
|
||||
type entry[K, V any] struct {
|
||||
key K
|
||||
value V
|
||||
@@ -48,10 +49,13 @@ func (t *subtable[K, V]) drop(key K) (occupied bool) {
|
||||
return false
|
||||
}
|
||||
|
||||
func (t *subtable[K, V]) resize(capacity uint64) {
|
||||
t.slots = make([]slot[K, V], capacity)
|
||||
t.capacity = capacity
|
||||
t.size = 0
|
||||
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) {
|
||||
@@ -69,7 +73,7 @@ func (t *subtable[K, V]) update(key K, value V) (updated bool) {
|
||||
return false
|
||||
}
|
||||
|
||||
func (t *subtable[K, V]) evict(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
|
||||
func (t *subtable[K, V]) insert(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
|
||||
if t.capacity == 0 {
|
||||
return insertion, true
|
||||
}
|
||||
@@ -92,8 +96,8 @@ func (t *subtable[K, V]) evict(insertion entry[K, V]) (evicted entry[K, V], evic
|
||||
return insertion, true
|
||||
}
|
||||
|
||||
func newSubtable[K, V any](capacity uint64, hash Hash[K], compare EqualFunc[K]) subtable[K, V] {
|
||||
return subtable[K, V]{
|
||||
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,
|
||||
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
)
|
||||
|
||||
// ErrBadHash occurs when the hashes given to a [Table] cause too many key
|
||||
// collisions. Try rebuilding the table using:
|
||||
// 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.
|
||||
@@ -20,7 +20,7 @@ var ErrBadHash = errors.New("bad hash")
|
||||
// one with [New]. Or if you want more granularity, use [NewBy] or
|
||||
// [NewCustom].
|
||||
type Table[K, V any] struct {
|
||||
tableA, tableB subtable[K, V]
|
||||
tableA, tableB *subtable[K, V]
|
||||
growthFactor uint64
|
||||
minLoadFactor float64
|
||||
}
|
||||
@@ -54,30 +54,61 @@ func (t *Table[K, V]) load() float64 {
|
||||
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 [Table.grow] and
|
||||
// [Table.shrink]; use them instead.
|
||||
func (t *Table[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})
|
||||
// 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
|
||||
}
|
||||
|
||||
t.tableA.resize(capacity)
|
||||
t.tableB.resize(capacity)
|
||||
if t.tableB.update(entry.key, entry.value) {
|
||||
return
|
||||
}
|
||||
|
||||
for _, entry := range entries {
|
||||
if err := t.Put(entry.key, entry.value); err != nil {
|
||||
return err
|
||||
for range t.maxEvictions() {
|
||||
if entry, homeless = t.tableA.insert(entry); !homeless {
|
||||
return
|
||||
}
|
||||
|
||||
if entry, homeless = t.tableB.insert(entry); !homeless {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
return entry, true
|
||||
}
|
||||
|
||||
// resized creates an empty copy of the table, with a new capacity for each
|
||||
// bucket.
|
||||
func (t *Table[K, V]) resized(capacity uint64) *Table[K, V] {
|
||||
return &Table[K, V]{
|
||||
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
|
||||
// the array, and replaces the current table. It is a helper function for
|
||||
// [Table.grow] and [Table.shrink]; use them instead.
|
||||
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
|
||||
return true
|
||||
}
|
||||
|
||||
// grow increases the table's capacity by the growth factor. If the
|
||||
// capacity is 0, it increases it to 1.
|
||||
func (t *Table[K, V]) grow() error {
|
||||
func (t *Table[K, V]) grow() bool {
|
||||
var newCapacity uint64
|
||||
|
||||
if t.TotalCapacity() == 0 {
|
||||
@@ -91,7 +122,7 @@ func (t *Table[K, V]) grow() error {
|
||||
|
||||
// shrink reduces the table's capacity by the growth factor. It may
|
||||
// reduce it down to 0.
|
||||
func (t *Table[K, V]) shrink() error {
|
||||
func (t *Table[K, V]) shrink() bool {
|
||||
return t.resize(t.tableA.capacity / t.growthFactor)
|
||||
}
|
||||
|
||||
@@ -122,49 +153,48 @@ func (t *Table[K, V]) Has(key K) (exists bool) {
|
||||
return
|
||||
}
|
||||
|
||||
// Put sets the value for a key. Returns error if its value cannot be set.
|
||||
// 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) {
|
||||
if t.tableA.update(key, value) {
|
||||
return nil
|
||||
}
|
||||
var (
|
||||
entry = entry[K, V]{key, value}
|
||||
homeless bool
|
||||
)
|
||||
|
||||
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
|
||||
for range defaultGrowthLimit {
|
||||
if entry, homeless = t.insert(entry); !homeless {
|
||||
return
|
||||
}
|
||||
|
||||
if entry, eviction = t.tableB.evict(entry); !eviction {
|
||||
return nil
|
||||
// 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)
|
||||
}
|
||||
}
|
||||
|
||||
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)
|
||||
return fmt.Errorf("could not place entry after %d resizes: %w", defaultGrowthLimit, ErrBadHash)
|
||||
}
|
||||
|
||||
// Drop removes a value for a key in the table. Returns an error if its value
|
||||
// cannot be removed.
|
||||
func (t *Table[K, V]) Drop(key K) (err error) {
|
||||
t.tableA.drop(key)
|
||||
t.tableB.drop(key)
|
||||
// Drop removes a value for a key in the table. Returns whether the key had
|
||||
// existed.
|
||||
func (t *Table[K, V]) Drop(key K) bool {
|
||||
occupied := t.tableA.drop(key) || t.tableB.drop(key)
|
||||
|
||||
if t.load() < t.minLoadFactor {
|
||||
return t.shrink()
|
||||
// The error is not handled here, because table-shrinking is an internal
|
||||
// optimization.
|
||||
t.shrink()
|
||||
}
|
||||
|
||||
return nil
|
||||
return occupied
|
||||
}
|
||||
|
||||
// Entries returns an unordered sequence of all key-value pairs in the table.
|
||||
|
||||
Reference in New Issue
Block a user