bloom

package module

v0.0.0-...-cdc8013 Latest Latest Go to latest Published: Jun 14, 2020 License: Apache-2.0 Imports: 1 Imported by: 8

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/riobard/go-bloom

Links

Open Source Insights

README ¶

Bloom Filter using double hashing.

func doubleFNV(b []byte) (uint64, uint64) {
    hx := fnv.New64()
    hx.Write(b)
    x := hx.Sum64()
    hy := fnv.New64a()
    hy.Write(b)
    y := hy.Sum64()
    return x, y
}

bf := bloom.New(1000000, 0.0001, doubleFNV)
bf.Add([]byte("hello"))
bf.Test([]byte("hello"))
bf.Test([]byte("world"))

Documentation ¶

Overview ¶

Package bloom implements Bloom Filter using double hashing

Index ¶

type Filter
- func New(n int, p float64, h func([]byte) (uint64, uint64)) Filter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Filter ¶

type Filter interface {
	Add([]byte)       // add an entry to the filter
	Test([]byte) bool // test if an entry is in the filter
	Size() int        // size of the filter in bytes
	Reset()           // reset the filter to initial state
}

Filter is a generic Bloom Filter

func New ¶

func New(n int, p float64, h func([]byte) (uint64, uint64)) Filter

New creates a classic Bloom Filter that is optimal for n entries and false positive rate of p. h is a double hash that takes an entry and returns two different hashes.

Source Files ¶

View all Source files

filter.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL