bloom

Documentation

Overview

Package bloom implements a simple bloom filter.

Index

• type Filter
  • func BasicFilter() Filter
  • func NewFilter(size int) Filter

Types

type Filter

type Filter interface {
	Add([]byte)
	Find([]byte) bool
	Merge(Filter) (Filter, error)
	HammingDistance(Filter) (int, error)
}

A Filter represents a bloom filter.

func BasicFilter

func BasicFilter() Filter

BasicFilter calls NewFilter with a bloom filter size of 2048 bytes.

func NewFilter

func NewFilter(size int) Filter

NewFilter creates a new bloom Filter with the given size. k (the number of hash functions), is hardcoded to 3.