package bloomf

All checked builds pass
  1. Overview
  2. Docs
Efficient Bloom filters for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

bloomf-v0.2.0.tbz
sha256=16409a1221e1d05a3d6b64ec0e5b302a60b6802cc573fdc243662e2fc85bd561
sha512=bc18e79cc782004edef88b24bc6ca586701294bd91c81ffc3de450df19f050e9e52b480980b74a5c38b7c70a3e9b4e94feca02007f1b661855868acf9cbdb245

Description

Efficient Bloom filters for OCaml

Added to opam-repository:

README

Bloomf - Efficient Bloom filters for OCaml OCaml-CI Build Status

Bloom filters are memory and time efficient data structures allowing probabilistic membership queries in a set.

A query negative result ensures that the element is not present in the set, while a positive result might be a false positive, i.e. the element might not be present and the BF membership query can return true anyway.

Internal parameters of the BF allow to control its false positive rate depending on the expected number of elements in it.

Online documentation is available here.

Install

The latest version of bloomf is available on opam with opam install bloomf.

Alternatively, you can build from sources with make or dune build.

Tests

Some of the tests, measuring false positive rate or size estimation, might fail once in a while since they are randomized. They are thus removed from dune runtest alias.

To run the whole test suite, run dune build @runtest-rand instead.

Benchmarks

Micro benchmarks are provided for create, add, mem and size_estimate operations. Expected error rate is 0.01.

They preform OLS regression analysis using the development version of bechamel. To reproduce them, pin bechamel then run dune build @bench.

Dependencies (3)

  1. bitv >= "1.4"
  2. dune >= "2.0"
  3. ocaml >= "4.06.0"

Dev Dependencies (1)

  1. alcotest with-test

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building bloomf with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.2.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure