docs

keilerkonzept · Sep 19, 2024 · 4a85b95 · 4a85b95
1 parent 4b23add
commit 4a85b95
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/hash.go b/hash.go
@@ -4,10 +4,12 @@ import "github.com/OneOfOne/xxhash"
 
 const hashSeed = 4848280
 
+// Fingerprint returns an item's fingerprint.
 func Fingerprint(item string) uint32 {
 	return xxhash.ChecksumString32S(item, hashSeed)
 }
 
+// BucketIndex returns the counter bucket index for an item in the given row of the sketch.
 func BucketIndex(item string, row, width int) int {
 	column := int(xxhash.ChecksumString32S(item, uint32(row))) % width
 	return row*width + column