refactor!: shorter constructors, bucket → subtable #22

Merged

mvhutz merged 6 commits from refactor/name-bucket-slot-table into main 2026-04-16 03:15:39 +00:00

Conversation 0 Commits 6 Files Changed 11 +172 -174

mvhutz commented 2026-04-14 01:21:38 +00:00

Owner

Copy Link

Description

Currently, the name of bucket is a bit confusing, because it is considered a 'table' in literature (as well as the whole hash table). A bucket is better described as a 'subtable', which is used by the total hash table to perform cuckoo hashing.

In addition, the constructors NewTable, NewTableBy, and NewCustomTable were given shorter names, because the package name cuckoo already implies that New* would create a hash table with cuckoo hashing. This package has one use-case, and so it unambiguous what constructors produce.

Changes

• NewTable -> New
• NewTableBy -> NewBy
• NewCustomTable -> NewCustom
• bucket -> subtable

Design Decisions

• I would have renamed Table and subtable to map equivalents, but 'submap' implies that a certain subsection of the map is contained within it, which isn't quite right.
• I chose not to go with Map and table, because of the split naming convention.

Checklist

• Tests pass
• Docs updated

## Description Currently, the name of `bucket` is a bit confusing, because it is considered a 'table' in literature (as well as the whole hash table). A `bucket` is better described as a 'subtable', which is used by the total hash table to perform cuckoo hashing. In addition, the constructors `NewTable`, `NewTableBy`, and `NewCustomTable` were given shorter names, because the package name `cuckoo` already implies that `New*` would create a hash table with cuckoo hashing. This package has one use-case, and so it unambiguous what constructors produce. ## Changes - `NewTable` -> `New` - `NewTableBy` -> `NewBy` - `NewCustomTable` -> `NewCustom` - `bucket` -> `subtable` ### Design Decisions - I would have renamed `Table` and `subtable` to map equivalents, but 'submap' implies that a certain subsection of the map is contained within it, which isn't quite right. - I chose not to go with `Map` and `table`, because of the split naming convention. ## Checklist - [x] Tests pass - [x] Docs updated

mvhutz added 5 commits 2026-04-14 01:21:38 +00:00

refactor: bucket -> table, Table -> HashTable 2fd9da973b

refactor: constructors, update docs ... 395a3560c7

- NewCustomTable -> NewCustom
- NewTableBy -> NewBy
- NewTable -> New

docs: replaced instances of "bucket" with "table" ... 6a5b40c097

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

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

refactor: HashTable -> Table, table -> subtable 5c39182958

mvhutz added 1 commit 2026-04-16 03:13:22 +00:00

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

mvhutz merged commit 7cc1657403 into main 2026-04-16 03:15:39 +00:00

mvhutz deleted branch refactor/name-bucket-slot-table 2026-04-16 03:15:40 +00:00

mvhutz referenced this issue from a commit 2026-04-16 03:15:40 +00:00

refactor!: shorter constructors, `bucket` → `subtable` (#22)

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is not working

duplicate

This issue or pull request already exists

enhancement

New feature

help wanted

Need some help

invalid

Something is wrong

question

More information is needed

wontfix

This won't be fixed

No Label

Milestone

No items

No Milestone

Assignees

Clear assignees

mvhutz

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: tools/go-cuckoo#22