https://github.com/tannerryan/ring

Package ring provides a high performance and thread safe Go implementation of a bloom filter.
https://github.com/tannerryan/ring

go golang

Last synced: about 2 months ago
JSON representation

Package ring provides a high performance and thread safe Go implementation of a bloom filter.

• Host: GitHub
• URL: https://github.com/tannerryan/ring
• Owner: tannerryan
• License: bsd-2-clause
• Created: 2019-01-27T04:02:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-10T16:36:16.000Z (over 4 years ago)
• Last Synced: 2024-04-13T18:47:46.090Z (8 months ago)
• Topics: go, golang
• Language: Go
• Homepage: https://pkg.go.dev/github.com/tannerryan/ring
• Size: 40 KB
• Stars: 137
• Watchers: 1
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - ring - Go implementation of a high performance, thread safe bloom filter. (Data Structures and Algorithms / Bloom and Cuckoo Filters)
• awesome-go-extra - ring - 01-27T04:02:20Z|2020-09-10T16:36:16Z| (Generators / Bloom and Cuckoo Filters)

README

        
# ring - high performance bloom filter

[![Build

Status](https://img.shields.io/travis/tannerryan/ring.svg?style=flat-square)](https://travis-ci.org/tannerryan/ring)

[![codecov](https://img.shields.io/codecov/c/github/tannerryan/ring.svg?style=flat-square)](https://codecov.io/gh/tannerryan/ring)

[![Go Report

Card](https://goreportcard.com/badge/github.com/tannerryan/ring?style=flat-square)](https://goreportcard.com/report/github.com/tannerryan/ring)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/tannerryan/ring?tab=doc)](https://pkg.go.dev/github.com/tannerryan/ring?tab=doc)

[![GitHub

license](https://img.shields.io/github/license/tannerryan/ring.svg?style=flat-square)](https://github.com/tannerryan/ring/blob/master/LICENSE)

[![Mentioned in Awesome

Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go)

Package ring provides a high performance and thread safe Go implementation of a

bloom filter.

## Usage

Please see the [godoc](https://godoc.org/github.com/tannerryan/ring) for

usage.

## Accuracy

Running `make` will perform unit tests, comparing the target false positive rate

with the actual rate. Here is a test against 1 million elements with a targeted

false positive rate of 0.1%. Tests fail if the number of false positives exceeds

the target.

```

=== RUN   TestBadParameters

--- PASS: TestBadParameters (0.00s)

=== RUN   TestReset

--- PASS: TestReset (0.26s)

=== RUN   TestData

--- PASS: TestData (14.07s)

=== RUN   TestMerge

--- PASS: TestMerge (13.78s)

=== RUN   TestMarshal

--- PASS: TestMarshal (14.48s)

PASS

>> Number of elements:  1000000

>> Target false positive rate:  0.001000

>> Number of false positives:  99

>> Actual false positive rate:  0.000099

>> Number of false negatives:  0

>> Actual false negative rate:  0.000000

>> Benchmark Add():  10000000          158 ns/op

>> Benchmark Test():  10000000         173 ns/op

ok      command-line-arguments  47.914s

```

## License

Copyright (c) 2019 Tanner Ryan. All rights reserved. Use of this source code is

governed by a BSD-style license that can be found in the LICENSE file.