README
¶
Here is an example implementation of a bloom filter in Golang that includes an add and remove function, and is atomic aware:
To create a BloomFilter instance, call the NewBloomFilter function and pass in the desired size of the filter (the number of bits), as well as an array of hash functions to be used. For example:
filter := bloomfilter.NewBloomFilter(10000, []bloomfilter.HashFunc{bloomfilter.NewHashFunc()})
To add a key to the filter, call the Add method on the filter instance, passing in the key as a string. For example:
filter.Add("A")
filter.Add("B")
filter.Add("C")
To remove a key from the filter, call the Remove method on like below example:
filter.Remove("C")
To check if key exists:
filter.Check("C")
Documentation
¶
Overview ¶
Package bloomfilter implements a simple bloom filter using hashing functions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BloomFilter ¶
type BloomFilter struct {
// contains filtered or unexported fields
}
BloomFilter is a struct representing a bloom filter.
func NewBloomFilter ¶
func NewBloomFilter(size int, funcs []HashFunc) *BloomFilter
NewBloomFilter returns a new bloom filter instance.
The size parameter specifies the size of the in-memory bloom filter array. The funcs parameter is a slice of HashFuncs that will be used to hash inputs to the bloom filter.
func (*BloomFilter) Add ¶
func (b *BloomFilter) Add(key string)
Add adds a new input string to the bloom filter.
func (*BloomFilter) Check ¶
func (b *BloomFilter) Check(key string) bool
Check checks whether an input string is probably in the bloom filter.
func (*BloomFilter) Remove ¶
func (b *BloomFilter) Remove(key string)
Remove removes an input string from the bloom filter
Source Files