M.V. Hutz
7cc1657403
All checks were successful
CI / Check PR Title (push) Has been skipped
CI / Makefile Lint (push) Successful in 47s
CI / Go Lint (push) Successful in 51s
CI / Markdown Lint (push) Successful in 46s
CI / Unit Tests (push) Successful in 47s
CI / Fuzz Tests (push) Successful in 1m19s
CI / Mutation Tests (push) Successful in 1m36s
## 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 Reviewed-on: #22 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
51 lines
1.7 KiB
Go
51 lines
1.7 KiB
Go
package cuckoo
|
|
|
|
import "fmt"
|
|
|
|
// DefaultCapacity is the initial capacity of a [Table]. 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
|
|
// implementations use 2.
|
|
const DefaultGrowthFactor uint64 = 2
|
|
|
|
// defaultMinimumLoad is the default lowest acceptable occupancy of a [Table].
|
|
// The higher the minimum load, the more likely that a [Table.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
|
|
|
|
type settings struct {
|
|
growthFactor uint64
|
|
minLoadFactor float64
|
|
bucketSize uint64
|
|
}
|
|
|
|
// An Option modifies the settings of a [Table]. 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
|
|
// value must be non-negative.
|
|
func Capacity(value int) Option {
|
|
if value < 0 {
|
|
panic(fmt.Sprintf("go-cuckoo: Capacity must be non-negative, got %d", value))
|
|
}
|
|
|
|
return func(s *settings) { s.bucketSize = uint64(value) }
|
|
}
|
|
|
|
// GrowthFactor controls how much the capacity of the [Table] multiplies when
|
|
// it must resize. The value must be greater than 1.
|
|
func GrowthFactor(value int) Option {
|
|
if value < 2 {
|
|
panic(fmt.Sprintf("go-cuckoo: GrowthFactor must be greater than 1, got %d", value))
|
|
}
|
|
|
|
return func(s *settings) { s.growthFactor = uint64(value) }
|
|
}
|