Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yourbasic/bloom

Probabilistic set data structure
https://github.com/yourbasic/bloom

bloom-filter data-structures go

Last synced: about 2 months ago
JSON representation

Probabilistic set data structure

Awesome Lists containing this project

README

        

# Your basic Bloom filter

### Golang probabilistic set data structure

A Bloom filter is a fast and space-efficient probabilistic
data structure used to test set membership. A membership test
returns either ”likely member” or ”definitely not a member”.

![Neutral density filter](ND-filter.jpg)

*Image by [Robert Emperley][re], [CC BY-SA 2.0][ccbysa].*

### Installation

Once you have [installed Go][golang-install], run this command
to install the `bloom` package:

go get github.com/yourbasic/bloom

### Documentation

There is an online reference for the package at
[godoc.org/github.com/yourbasic/bloom][godoc-bloom].

### Roadmap

* The API of this library is frozen.
* Version numbers adhere to [semantic versioning][sv].

The only accepted reason to modify the API of this package
is to handle issues that can't be resolved in any other
reasonable way.

### Thanks

Thanks to [Sébastien Paolacci][sp] for his excellent
MurmurHash implementation.

Stefan Nilsson – [korthaj](https://github.com/korthaj)

[godoc-bloom]: https://godoc.org/github.com/yourbasic/bloom
[golang-install]: http://golang.org/doc/install.html
[ccbysa]: https://creativecommons.org/licenses/by-sa/2.0/deed.en
[re]: https://www.flickr.com/photos/66016280@N00
[sp]: https://github.com/spaolacci
[sv]: http://semver.org/