refactor: HashTable -> Table, table -> subtable

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

.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:

.markdownlint-cli2.jsonc

@@ -1,14 +0,0 @@
-{
-  "customRules": [".markdownlint-rules/one-sentence-per-line.mjs"],
-  "config": {
-    "default": true,
-    "heading-style": { "style": "atx" },
-    "ul-indent": { "indent": 2 },
-    "line-length": false,
-    "no-duplicate-heading": { "siblings_only": true },
-    "no-inline-html": {
-      "allowed_elements": ["br", "code", "details", "summary", "img", "picture", "source"]
-    },
-    "first-line-heading": true
-  }
-}

.markdownlint-rules/one-sentence-per-line.mjs

@@ -1,48 +0,0 @@
-// @ts-check
-
-/**
- * @typedef {object} ErrorInfo
- * @property {number} lineNumber
- * @property {string} [context]
- * @property {string} [detail]
- * @property {[number, number]} [range]
- */
-
-/**
- * @typedef {object} Params
- * @property {string[]} lines
- */
-
-/** @typedef {(error: ErrorInfo) => void} OnError */
-
-/**
- * @typedef {object} Rule
- * @property {string[]} names
- * @property {string} description
- * @property {string[]} tags
- * @property {(params: Params, onError: OnError) => void} function
- */
-
-/** @type {Rule} */
-export default {
-  names: ["one-sentence-per-line"],
-  description: "Each sentence must be on its own line",
-  tags: ["sentences"],
-  function: function (params, onError) {
-    let inFence = false;
-    params.lines.forEach((line, index) => {
-      if (/^```/.test(line)) {
-        inFence = !inFence;
-        return;
-      }
-      if (inFence) return;
-      // Skip headings, blank lines, HTML, table rows
-      if (/^(#|\s*[|<]|>|\s*$)/.test(line)) return;
-      // Strip list marker before checking
-      const text = line.replace(/^\s*(?:[-*+]|\d+\.)\s+/, "");
-      if (/[.!?]\s+[A-Z]/.test(text)) {
-        onError({ lineNumber: index + 1, context: text.trim() });
-      }
-    });
-  },
-};

.markdownlint.yml

@@ -0,0 +1,17 @@
+default: true
+heading-style:
+  style: atx
+ul-indent:
+  indent: 2
+line-length: false
+no-duplicate-heading:
+  siblings_only: true
+no-inline-html:
+  allowed_elements:
+    - br
+    - details
+    - summary
+    - img
+    - picture
+    - source
+first-line-heading: true

README.md

@@ -1,6 +1,3 @@
 # <img height="30" src="assets/logo.svg" alt="Go Cuckoo, by `mvhutz`."> Go Cuckoo
 
-A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time.
+A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time. Read more about it in [the package documentation](https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo).
-Read more about it in [the package documentation][docs].
-
-[docs]: https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo

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
 }

settings.go

@@ -19,11 +19,6 @@ 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

subtable.go

@@ -1,6 +1,5 @@
 package cuckoo
 
-// An entry is a key-value pair.
 type entry[K, V any] struct {
 	key   K
 	value V
@@ -20,11 +19,11 @@ type subtable[K, V any] struct {
 
 // 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 {
+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) {
+func (t subtable[K, V]) get(key K) (value V, found bool) {
 	if t.capacity == 0 {
 		return
 	}
@@ -49,16 +48,13 @@ func (t *subtable[K, V]) drop(key K) (occupied bool) {
 	return false
 }
 
-func (t *subtable[K, V]) resized(capacity uint64) *subtable[K, V] {
+func (t *subtable[K, V]) resize(capacity uint64) {
-	return &subtable[K, V]{
+	t.slots = make([]slot[K, V], capacity)
-		slots:    make([]slot[K, V], capacity),
+	t.capacity = capacity
-		capacity: capacity,
+	t.size = 0
-		hash:     t.hash,
-		compare:  t.compare,
-	}
 }
 
-func (t *subtable[K, V]) update(key K, value V) (updated bool) {
+func (t subtable[K, V]) update(key K, value V) (updated bool) {
 	if t.capacity == 0 {
 		return
 	}
@@ -73,7 +69,7 @@ func (t *subtable[K, V]) update(key K, value V) (updated bool) {
 	return false
 }
 
-func (t *subtable[K, V]) insert(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
+func (t *subtable[K, V]) evict(insertion entry[K, V]) (evicted entry[K, V], eviction bool) {
 	if t.capacity == 0 {
 		return insertion, true
 	}
@@ -96,8 +92,8 @@ func (t *subtable[K, V]) insert(insertion entry[K, V]) (evicted entry[K, V], evi
 	return insertion, true
 }
 
-func newSubtable[K, V any](capacity uint64, hash Hash[K], compare EqualFunc[K]) *subtable[K, V] {
+func newSubtable[K, V any](capacity uint64, hash Hash[K], compare EqualFunc[K]) subtable[K, V] {
-	return &subtable[K, V]{
+	return subtable[K, V]{
 		hash:     hash,
 		capacity: capacity,
 		compare:  compare,

table.go

@@ -9,7 +9,7 @@ import (
 )
 
 // 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:
+// collisions. Try rebuilding the table using:
 //
 //  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,61 +54,30 @@ func (t *Table[K, V]) load() float64 {
 	return float64(t.Size()) / float64(t.TotalCapacity())
 }
 
-// insert attempts to put/update an entry in the table, without modifying the
+// resize clears all tables, changes the sizes of them to a specific capacity,
-// size of the table. Returns a displaced entry and 'homeless = true' if an
+// and fills them back up again. It is a helper function for [Table.grow] and
-// entry could not be placed after exhausting evictions.
+// [Table.shrink]; use them instead.
-func (t *Table[K, V]) insert(entry entry[K, V]) (displaced entry[K, V], homeless bool) {
+func (t *Table[K, V]) resize(capacity uint64) error {
-	if t.tableA.update(entry.key, entry.value) {
+	entries := make([]entry[K, V], 0, t.Size())
-		return
-	}
-
-	if t.tableB.update(entry.key, entry.value) {
-		return
-	}
-
-	for range t.maxEvictions() {
-		if entry, homeless = t.tableA.insert(entry); !homeless {
-			return
-		}
-
-		if entry, homeless = t.tableB.insert(entry); !homeless {
-			return
-		}
-	}
-
-	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 {
+		entries = append(entries, entry[K, V]{k, v})
-			return false
+	}
+
+	t.tableA.resize(capacity)
+	t.tableB.resize(capacity)
+
+	for _, entry := range entries {
+		if err := t.Put(entry.key, entry.value); err != nil {
+			return err
 		}
 	}
 
-	*t = *updated
+	return nil
-	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() bool {
+func (t *Table[K, V]) grow() error {
 	var newCapacity uint64
 
 	if t.TotalCapacity() == 0 {
@@ -122,79 +91,73 @@ func (t *Table[K, V]) grow() bool {
 
 // shrink reduces the table's capacity by the growth factor. It may
 // reduce it down to 0.
-func (t *Table[K, V]) shrink() bool {
+func (t *Table[K, V]) shrink() error {
 	return t.resize(t.tableA.capacity / t.growthFactor)
 }
 
-// Get fetches the value for a key in the [Table]. Matches the comma-ok pattern
+// Get fetches the value for a key in the [Table]. Returns an error if no value
-// of a builtin map; see [Table.Find] for plain indexing.
+// is found.
-func (t *Table[K, V]) Get(key K) (value V, ok bool) {
+func (t *Table[K, V]) Get(key K) (value V, err error) {
 	if item, ok := t.tableA.get(key); ok {
-		return item, true
+		return item, nil
 	}
 
 	if item, ok := t.tableB.get(key); ok {
-		return item, true
+		return item, nil
 	}
 
-	return
+	return value, fmt.Errorf("key '%v' not found", key)
-}
-
-// 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)
+	_, err := t.Get(key)
-	return
+	return err == nil
 }
 
-// Put sets the value for a key. If it cannot be set, an error is returned.
+// Put sets the value for a key. Returns error if its value cannot be set.
 func (t *Table[K, V]) Put(key K, value V) (err error) {
-	var (
+	if t.tableA.update(key, value) {
-		entry    = entry[K, V]{key, value}
+		return nil
-		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)
+	if t.tableB.update(key, value) {
-}
+		return nil
+	}
 
-// Drop removes a value for a key in the table. Returns whether the key had
+	entry, eviction := entry[K, V]{key, value}, false
-// existed.
+	for range t.maxEvictions() {
-func (t *Table[K, V]) Drop(key K) bool {
+		if entry, eviction = t.tableA.evict(entry); !eviction {
-	occupied := t.tableA.drop(key) || t.tableB.drop(key)
+			return nil
+		}
+
+		if entry, eviction = t.tableB.evict(entry); !eviction {
+			return nil
+		}
+	}
 
 	if t.load() < t.minLoadFactor {
-		// The error is not handled here, because table-shrinking is an internal
+		return fmt.Errorf("hash functions produced a cycle at load %d/%d: %w", t.Size(), t.TotalCapacity(), ErrBadHash)
-		// optimization.
-		t.shrink()
 	}
 
-	return occupied
+	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 *Table[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.