Release bloomfilter-blocked-0.1.0.0

Author: jorisdral

bloomfilter-blocked/CHANGELOG.md

@@ -1,5 +1,5 @@
 # Revision history for bloomfilter-blocked
 
-## 0.1.0.0 -- YYYY-mm-dd
+## 0.1.0.0 -- 2025-08-06
 
 * First version. Released on an unsuspecting world.

bloomfilter-blocked/README.md

@@ -1,18 +1,18 @@
 # bloomfilter-blocked
 
 `bloomfilter-blocked` is a Haskell library providing multiple fast and efficient
-implementations of [bloom filters][bloom-filter:wiki]. It is a full rewrite of
-the [`bloomfilter`][bloomfilter:hackage] package, originally authored by Bryan
-O'Sullivan <[email protected]>.
+implementations of [bloom filters](https://en.wikipedia.org/wiki/Bloom_filter).
+It is a full rewrite of the
+[`bloomfilter`](https://hackage.haskell.org/package/bloomfilter) package,
+originally authored by Bryan O'Sullivan <[email protected]>.
 
 A bloom filter is a space-efficient data structure representing a set that can
 be probablistically queried for set membership. The set membership query returns
 no false negatives, but it might return false positives. That is, if an element
 was added to a bloom filter, then a subsequent query definitely returns `True`.
 If an element was *not* added to a filter, then a subsequent query may still
 return `True` if `False` would be the correct answer. The probabiliy of false
-positives -- the false positive rate (FPR) -- is configurable, as we will
-describe later.
+positives -- the false positive rate (FPR) -- is configurable.
 
 The library includes two implementations of bloom filters: classic, and blocked.
 
@@ -48,8 +48,9 @@ User should take into account the following:
 
 # Differences from the `bloomfilter` package
 
-The library is a full rewrite of the [`bloomfilter`][bloomfilter:hackage]
-package, originally authored by Bryan O'Sullivan <[email protected]>. The main
+The library is a full rewrite of the
+[`bloomfilter`](https://hackage.haskell.org/package/bloomfilter) package,
+originally authored by Bryan O'Sullivan <[email protected]>. The main
 differences are:
 
 * `bloomfilter-blocked` supports both classic and blocked bloom filters, whereas
@@ -62,14 +63,9 @@ differences are:
   over a `Hashable` type class, instead of having a `a -> [Hash]` typed field.
   This separation in `bloomfilter-blocked` allows clean (de-)serialisation of
   filters as the hashing scheme is static.
-* `bloomfilter-blocked` uses [`XXH3`][xxh3] for hashing instead of [Jenkins'
-  `lookup3`][lookup3:wiki], which `bloomfilter` uses.
+* `bloomfilter-blocked` uses [`XXH3`](https://xxhash.com/) for hashing instead
+  of [Jenkins'
+  `lookup3`](https://en.wikipedia.org/wiki/Jenkins_hash_function#lookup3), which
+  `bloomfilter` uses.
 * The user can configure hash salts for improved security in
   `bloomfilter-blocked`, whereas this is not supported in `bloomfilter`.
-
-<!-- Sources -->
-
-[bloom-filter:wiki]: https://en.wikipedia.org/wiki/Bloom_filter
-[bloomfilter:hackage]: https://hackage.haskell.org/package/bloomfilter
-[xxh3]: https://xxhash.com/
-[lookup3:wiki]: https://en.wikipedia.org/wiki/Jenkins_hash_function#lookup3

bloomfilter-blocked/bloomfilter-blocked.cabal

@@ -2,7 +2,24 @@ cabal-version:      3.4
 name:               bloomfilter-blocked
 version:            0.1.0.0
 synopsis:           Classic and block-style bloom filters
-description:        Classic and block-style bloom filters.
+description:
+  @bloomfilter-blocked@ is a Haskell library providing multiple fast and efficient
+  implementations of [bloom filters](https://en.wikipedia.org/wiki/Bloom_filter).
+  It is a full rewrite of the
+  [@bloomfilter@](https://hackage.haskell.org/package/bloomfilter) package,
+  originally authored by Bryan O'Sullivan <[email protected]>.
+
+  The library includes two implementations of bloom filters: classic, and blocked.
+
+  * /Classic/ bloom filters, found in the "Data.BloomFilter.Classic" module: a
+    default implementation that is faithful to the canonical description of a
+    bloom filter data structure.
+
+  * /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
+    same amount of assigned memory.
+
 license:            Apache-2.0
 license-files:
   LICENSE
@@ -111,9 +128,13 @@ benchmark bench
     , criterion
     , random
 
-executable fpr-calc
+-- It's not really a test suite, but if we make it an executable then its
+-- dependencies will be included for dependency resolution when building the
+-- main library. As a test-suite, it's more accurately represented as an
+-- internal component.
+test-suite fpr-calc
   import:         language, warnings
-  scope:          private
+  type:           exitcode-stdio-1.0
   hs-source-dirs: tests
   main-is:        fpr-calc.hs
   build-depends:
@@ -126,14 +147,19 @@ executable fpr-calc
 
   ghc-options:    -threaded
 
-executable spell
+-- It's not really a test suite, but if we make it an executable then its
+-- dependencies will be included for dependency resolution when building the
+-- main library. As a test-suite, it's more accurately represented as an
+-- internal component.
+test-suite spell
   import:         language, warnings
-  scope:          private
+  type:           exitcode-stdio-1.0
   hs-source-dirs: examples
   main-is:        spell.hs
   build-depends:
     , base
     , bloomfilter-blocked
+    , directory
 
 -- this exists due to windows
 library xxhash
@@ -155,7 +181,7 @@ library xxhash
   hs-source-dirs:  xxhash/src
   build-depends:
     , base        <5
-    , bytestring
+    , bytestring  ^>=0.11 || ^>=0.12
     , primitive   ^>=0.9
 
 test-suite xxhash-tests

bloomfilter-blocked/examples/spell.hs

@@ -1,14 +1,24 @@
 {-# LANGUAGE BangPatterns #-}
 module Main (main) where
 
-import           Control.Monad (forM_)
+import           Control.Monad (forM_, unless, when)
+import           System.Directory
 import           System.Environment (getArgs)
+import           System.Exit
 
 import qualified Data.BloomFilter as B
 
 main :: IO ()
 main = do
     files <- getArgs
+    when (null files) $ do
+      putStrLn "No files to spell"
+      exitSuccess
+    putStrLn $ "Spelling files: " ++ show files
+    hasDictionary <- doesFileExist "/usr/share/dict/words"
+    unless hasDictionary $ do
+      putStrLn "No dictionary found"
+      exitSuccess
     dictionary <- readFile "/usr/share/dict/words"
     let !bloom = B.fromList (B.policyForFPR 0.01) bSalt (words dictionary)
     forM_ files $ \file ->

bloomfilter-blocked/tests/fpr-calc.hs

@@ -11,7 +11,7 @@ import qualified Data.IntSet as IntSet
 import           Data.List (unfoldr)
 import           Math.Regression.Simple
 import           System.Environment (getArgs)
-import           System.Exit (exitFailure)
+import           System.Exit (exitSuccess)
 import           System.IO
 import           System.Random
 
@@ -28,7 +28,7 @@ main = do
       ["Regression"] -> main_regression
       _   -> do
         putStrLn "Usage: bloomfilter-fpr-calc [Generate|Regression]"
-        exitFailure
+        exitSuccess
 
 main_regression :: IO ()
 main_regression = do

cabal.project.release

@@ -1,7 +1,7 @@
 index-state:
   -- Bump this if you need newer packages from Hackage
-  -- current date: quickcheck-lockstep-0.8.0
-  , hackage.haskell.org 2025-07-03T13:54:16Z
+  -- current date: release bloomfilter-blocked-0.1.0.0
+  , hackage.haskell.org 2025-08-06T00:00:00Z
 
 packages:
   .

test-prototypes/Test/ScheduledMergesQLS.hs

@@ -19,7 +19,7 @@ import           Prelude hiding (lookup)
 
 import           ScheduledMerges as LSM
 
-import           Test.QuickCheck
+import           Test.QuickCheck hiding (Some)
 import           Test.QuickCheck.StateModel hiding (lookUpVar)
 import           Test.QuickCheck.StateModel.Lockstep hiding (ModelOp)
 import qualified Test.QuickCheck.StateModel.Lockstep.Defaults as Lockstep

test/Test/Database/LSMTree/Internal/Readers.hs

@@ -41,7 +41,7 @@ import qualified System.FS.BlockIO.Sim as FsSim
 import qualified System.FS.Sim.MockFS as MockFS
 import qualified Test.QuickCheck as QC
 import           Test.Tasty (TestTree, testGroup)
-import           Test.Tasty.QuickCheck
+import           Test.Tasty.QuickCheck hiding (Some)
 import           Test.Util.Orphans ()
 
 import           Test.QuickCheck.StateModel

test/Test/Database/LSMTree/StateMachine/DL.hs

@@ -25,7 +25,7 @@ import qualified System.FS.Sim.Stream as Stream
 import           System.FS.Sim.Stream (Stream)
 import           Test.Database.LSMTree.StateMachine hiding (tests)
 import           Test.Database.LSMTree.StateMachine.Op
-import           Test.QuickCheck as QC hiding (label)
+import           Test.QuickCheck as QC hiding (Some, label)
 import           Test.QuickCheck.DynamicLogic
 import qualified Test.QuickCheck.Gen as QC
 import qualified Test.QuickCheck.Random as QC