bloomfilter

README

BloomFilter

BloomFilter is a simple and efficient implementation of a Bloom filter in Go.

Installation

To install the package, run:

go get github.com/beastop/bloomfilter

Usage

Creating a Bloom Filter

package main

import (
	"fmt"
	"github.com/beastop/bloomfilter"
)

func main() {
	// Create a new Bloom filter
	bloom, err := bloomfilter.New(100, 0.01)
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	// Add items to the Bloom filter
	bloom.Add("foo")
	bloom.Add("bar")

	// Check if items are in the Bloom filter
	fmt.Println("foo in bloom filter:", bloom.Contains("foo"))
	fmt.Println("baz in bloom filter:", bloom.Contains("baz"))
}

Documentation

For detailed API documentation, please visit the GoDoc.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

Overview

Package bloomfilter is a lightweight implimentation of bloomfilter algorithm in pure golang.

Index

• type Bloom
  • func New(item_count int, fp_prob float64) (*Bloom, error)
  • func (b *Bloom) Add(item string)
  • func (b *Bloom) Contains(item string) bool

Types

type Bloom

type Bloom struct {
	// contains filtered or unexported fields
}

Bloom represents a Bloom filter data structure.

func New

func New(item_count int, fp_prob float64) (*Bloom, error)

New creates a new Bloom filter with the specified item count and false positive probability. Returns a pointer to the Bloom filter and an error if any.

func (*Bloom) Add

func (b *Bloom) Add(item string)

Add inserts an item into the Bloom filter.

func (*Bloom) Contains

func (b *Bloom) Contains(item string) bool

Contains checks if an item is in the Bloom filter. Returns true if the item is probably in the filter, false otherwise.