tools/go-cuckoo
1
0
Fork 0
Code Issues 2 Pull Requests Actions Releases 4 Wiki Activity

docs: note that the table isnt a source of truth
All checks were successful
CI / Check PR Title (pull_request) Successful in 31s
Details
CI / Go Lint (pull_request) Successful in 53s
Details
CI / Makefile Lint (pull_request) Successful in 54s
Details
CI / Markdown Lint (pull_request) Successful in 34s
Details
CI / Unit Tests (pull_request) Successful in 52s
Details
CI / Fuzz Tests (pull_request) Successful in 1m25s
Details
CI / Mutation Tests (pull_request) Successful in 1m10s
Details

Browse Source
This commit is contained in:
Maxim Hutz
2026-04-16 21:05:43 -04:00
parent 5452c02d4e
commit d13adcaa49
2 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc.go
View File

@@ -5,5 +5,8 @@
// a table with any key type using [NewCustom]. Custom [Hash] functions and // a table with any key type using [NewCustom]. Custom [Hash] functions and
// key comparison are also supported. // 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 // See more: https://en.wikipedia.org/wiki/Cuckoo_hashing
package cuckoo package cuckoo

2
table.go
View File

@@ -9,7 +9,7 @@ import (
) )
// ErrBadHash occurs when the hashes given to a [Table] cause too many key // 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 // 1. Different hash seeds. Equal seeds produce equal hash functions, which
// always cycle. // always cycle.