https://github.com/vonmo/erbloom

Safe and Fast Bloom Filter + FBFs for Erlang
https://github.com/vonmo/erbloom

bloom-filter elixir erlang nifs rust rustler

Last synced: 3 days ago
JSON representation

Safe and Fast Bloom Filter + FBFs for Erlang

• Host: GitHub
• URL: https://github.com/vonmo/erbloom
• Owner: Vonmo
• License: mit
• Created: 2018-02-18T10:38:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-16T11:39:05.000Z (over 1 year ago)
• Last Synced: 2024-03-15T02:13:38.516Z (10 months ago)
• Topics: bloom-filter, elixir, erlang, nifs, rust, rustler
• Language: Erlang
• Homepage:
• Size: 880 KB
• Stars: 56
• Watchers: 3
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# erbloom

Safe and Fast Bloom Filter + FBFs for Erlang

![CI](https://github.com/Vonmo/erbloom/workflows/CI/badge.svg?branch=master)

[Online Documentation](https://hexdocs.pm/erbloom/)

## Features:

* [Bloom filter structure](https://en.wikipedia.org/wiki/Bloom_filter) (type: `bloom`)

* [Forgetful Bloom Filters](http://dprg.cs.uiuc.edu/docs/fbf_cac15/fbfpaper-2.pdf) (type: `fbf`)

## Supported OS:

* linux

* macos

* windows

## Deps definition:

mix.exs:

`{:erbloom, "~> 2.1.0-rc.2"}`

rebar.config:

`{erbloom, "2.1.0-rc.2"}`

erlang.mk:

`dep_erbloom = hex 2.1.0-rc.2`

## Using as a lib

1. Add deps in rebar.conf:

  ```

  {deps, [

      {erbloom, ".*", {git, "https://github.com/Vonmo/erbloom.git", {tag, "v2.0.2"}}}      

  ]}

  ```

2. Now you can create a new filter instance:

  `{ok, Filter} = bloom:new(9585059,1000000).`

   or filter with wanted rate of false positives: 

   `bloom:new_optimal(1000000, 0.55).`

3. Create a new forgetful filter:

   `{ok, Filter} = bloom:new_forgetful(BitmapSize, ItemsCount, NumFilters, RotateAfter).`

   or with fp_rate:

   `bloom:new_forgetful_optimal(ItemsCount, NumFilters, RotateAfter, FpRate).`

3. Set a new element

  `bloom:set(Filter, "somekey").`

4. Check up element

  `bloom:check(Filter, "anotherkey").`

5. Serialize

   `{ok, Binary} = bloom:serialize(Filter).`

6. Deserialize

   `bloom:deserialize(Binary).`

## Docker environment

* `make build_imgs` - build docker images

* `make up` - run sandbox

* `make down` - terminate sandbox

* `make tests` - run tests

* `make lint` - linter

* `make xref` - xref analysis

* `make prod` - generate release for target

* `make doc` - generate documentation from EDoc

##

Without docker you must install erlang >=20.1 and rust >=1.23 on your machine. After you can run these goals:

**release:**

`rebar3 as prod release`

**test:**

`rebar3 as test ct`