Release bloomfilter-blocked-0.1.0.0
#770
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorisdral
force-pushed
the
jdral/bloomfilter-blocked
branch
2 times, most recently
from
3e2b44d to
ecb3fae
Compare
jorisdral
force-pushed
the
jdral/bloomfilter-blocked
branch
from
ecb3fae to
fcacf6d
Compare
This includes * A new README * Moved "examples" and "differences" haddock sections to the top-level module. * Make examples executable using `cabal-docspec` * Add `BloomPolicy` and `BloomSize` types for the blocked bloom filter instead of reusing the types of the same name from the classic bloom filter. This adds a bit of boilerplate, but it makes the documentation clearer because the hyperlinks were pointing from the blocked modules to the classic modules before. * Add `read` and `readHashes` to the blocked bloom filter, which the classic bloom filter already had implemented.
jorisdral
force-pushed
the
jdral/bloomfilter-blocked
branch
from
fcacf6d to
69db9f8
Compare
jorisdral
requested review from
dcoutts,
mheinzel,
recursion-ninja and
wenkokke
as code owners
dcoutts
approved these changes
Jul 3, 2025
| -- The main differences are | ||
| -- | ||
| -- * This packages support bloomfilters of arbitrary sizes | ||
| -- (not limited to powers of two). Also sizes over 2^32 are supported. |
There was a problem hiding this comment.
Up to a maximum of 2^41 bits (256 Gbytes).
There was a problem hiding this comment.
Or up to a maximum of 2^48 for classic.
Comment on lines
150
to
153
| -- * The 'Bloom' and 'MBloom' types are parametrised over a 'Hashable' type | ||
| -- class, instead of having a @a -> ['Hash']@ typed field. | ||
| -- This separation allows clean de\/serialization of Bloom filters in this | ||
| -- package, as the hashing scheme is static. |
There was a problem hiding this comment.
It's also faster than calling an unknown function for every hash.
Comment on lines
155
to
156
| -- * [@XXH3@ hash](https://xxhash.com/) is used instead of Jenkins' | ||
| -- @lookup3@. |
Comment on lines
+71
to
+75
| data BloomPolicy = BloomPolicy { | ||
| policyBits :: !Double, | ||
| policyHashes :: !Int | ||
| } | ||
| deriving stock Show |
There was a problem hiding this comment.
* Add `BloomPolicy` and `BloomSize` types for the blocked bloom filter instead
of reusing the types of the same name from the classic bloom filter. This adds
a bit of boilerplate, but it makes the documentation clearer because the
hyperlinks were pointing from the blocked modules to the classic modules
before.
Hmmm.
If the issue is just the docs, perhaps we should pull these types out into a common module, which could be marked not-home so they get documented as if they live in each module.
|
|
||
| Copyright 2008, 2009, 2010, 2011 Bryan O'Sullivan <[email protected]>. | ||
| `bloomfilter-blocked` is a Haskell library providing multiple fast and efficient |
There was a problem hiding this comment.
multiple/two
what does efficient refer to as distinct from fast? Perhaps space-efficient?
| the examples directory. | ||
| * **Blocked** floom filters, found in the `Data.BloomFilter.Blocked` module: an | ||
| implementation that optimises the memory layout of a classic bloom filter for | ||
| speed (cheaper CPU cache reads), at the cost of a slightly higher FPR for the |
| This library is written by Bryan O'Sullivan, <[email protected]>. | ||
| The library is a full rewrite of the [`bloomfilter`][bloomfilter:hackage] | ||
| package, originally authored by Bryan O'Sullivan <[email protected]>. The main | ||
| differences are: |
There was a problem hiding this comment.
TODO: benchmarks to show it's faster!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.