Files
go-cuckoo/compare_example_test.go
M.V. Hutz ea805b28e4
All checks were successful
CI / lint (push) Successful in 51s
CI / unit-test (push) Successful in 25s
CI / fuzz-test (push) Successful in 1m2s
CI / mutation-test (push) Successful in 41s
fix: EqualFunc not deterministic (#2)
The `ExampleEqualFunc_badEqualFunc` was non-deterministic, because the hashes used in the `CustomTable` could (by chance) map "Rob" and "Robert" to the same slot.

- Updated the test to use a deterministic hash.

Reviewed-on: #2
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
2026-03-17 01:54:24 +00:00

49 lines
1.3 KiB
Go

package cuckoo_test
import (
"fmt"
"git.maximhutz.com/tools/go-cuckoo"
)
// This example demonstrates what happens when EqualFunc and Hash disagree on
// equality. Although 'isEqual' only compares user IDs, but the hashes use the
// entire 'User' object. So, two objects with the same ID but different names
// hash to different slots, so the table cannot find them.
func ExampleEqualFunc_badEqualFunc() {
type User struct{ ID, Name string }
makeHash := func(seed uint64) cuckoo.Hash[User] {
return func(u User) uint64 {
digest := seed
for _, c := range u.ID + u.Name {
digest ^= uint64(c)
}
return digest
}
}
// Two users with the same ID are equal.
isEqual := func(a, b User) bool { return a.ID == b.ID }
userbase := cuckoo.NewCustomTable[User, bool](makeHash(1), makeHash(2), isEqual)
(userbase.Put(User{"1", "Robert Doe"}, true))
fmt.Println("Has Robert?", userbase.Has(User{"1", "Robert Doe"}))
fmt.Println("Has Johanna?", userbase.Has(User{"2", "Johanna Smith"}))
// The hashes are different, so even though the equal function returns true,
// the table does not recognize it.
fmt.Println("Equal?", isEqual(User{"1", "Rob Doe"}, User{"1", "Robert Doe"}))
fmt.Println("Has Rob?", userbase.Has(User{"1", "Rob Doe"}))
// Output:
// Has Robert? true
// Has Johanna? false
// Equal? true
// Has Rob? false
}