Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OldPanda/bloomfilter
Yet another Bloomfilter implementation in Go, compatible with Java's Guava library
https://github.com/OldPanda/bloomfilter
bloomfilter bloomfilter-go golang golang-library
Last synced: 13 days ago
JSON representation
Yet another Bloomfilter implementation in Go, compatible with Java's Guava library
- Host: GitHub
- URL: https://github.com/OldPanda/bloomfilter
- Owner: OldPanda
- License: mit
- Created: 2021-01-01T01:28:04.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T03:55:05.000Z (over 1 year ago)
- Last Synced: 2024-05-01T13:41:51.646Z (6 months ago)
- Topics: bloomfilter, bloomfilter-go, golang, golang-library
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - bloomfilter - Yet another Bloomfilter implementation in Go, compatible with Java's Guava library. (Data Structures and Algorithms / Bloom and Cuckoo Filters)
- awesome-go - bloomfilter - Yet another Bloomfilter implementation in Go, compatible with Java's Guava library. (Data Structures and Algorithms / Bloom and Cuckoo Filters)
- awesome-go-extra - bloomfilter - 01-01T01:28:04Z|2021-06-30T00:59:36Z| (Generators / Bloom and Cuckoo Filters)
README
# bloomfilter
[](https://codecov.io/gh/OldPanda/bloomfilter)
[](https://pkg.go.dev/github.com/OldPanda/bloomfilter)
[](https://goreportcard.com/report/github.com/OldPanda/bloomfilter)
[](https://github.com/avelino/awesome-go)
## Overview
Yet another Bloomfilter implementation in Go, compatible with Java's Guava library. This library borrows how [Java's Guava libraray](https://guava.dev/) implements Bloomfilter hashing strategies to achieve the serialization compatibility.
## Installing
First pull the latest version of the library:
```
go get github.com/OldPanda/bloomfilter
```
Then import the this library in your code:
```
import "github.com/OldPanda/bloomfilter"
```
## Usage Examples
### Basic Usage
```Go
package main
import (
"fmt"
"github.com/OldPanda/bloomfilter"
)
func main() {
// create bloomfilter with expected insertion=500, error rate=0.01
bf, _ := bloomfilter.NewBloomFilter(500, 0.01)
// add number 0~199 into bloomfilter
for i := 0; i < 200; i++ {
bf.Put(i)
}
// check if number 100 and 200 are in bloomfilter
fmt.Println(bf.MightContain(100))
fmt.Println(bf.MightContain(200))
}
```
### Serialization
```Go
package main
import "github.com/OldPanda/bloomfilter"
func main() {
// expected insertion=500, error rate=0.01
bf, _ := bloomfilter.NewBloomFilter(500, 0.01)
// add 0~199 into bloomfilter
for i := 0; i < 200; i++ {
bf.Put(i)
}
// serialize bloomfilter to byte array
bytes := bf.ToBytes()
// handling the bytes ...
}
```
### Deserialization
```Go
package main
import (
"fmt"
"github.com/OldPanda/bloomfilter"
)
func main() {
// create bloomfilter from byte array
bf, _ := bloomfilter.FromBytes(bytes)
// check whether number 100 is in bloomfilter
fmt.Println(bf.MightContain(100))
}
```
## Benchmark
The benchmark testing runs on element insertion and query separately.
```Bash
» go test -bench . -benchmem ./...
# github.com/OldPanda/bloomfilter.test
goos: darwin
goarch: arm64
pkg: github.com/OldPanda/bloomfilter
BenchmarkBloomfilterInsertion-12 11091939 90.62 ns/op 17 B/op 1 allocs/op
BenchmarkBloomfilterQuery-12 20389624 53.16 ns/op 15 B/op 1 allocs/op
BenchmarkBloomfilterDeserialization-12 293098 3767 ns/op 13200 B/op 52 allocs/op
PASS
ok github.com/OldPanda/bloomfilter 3.719s
```