Rename hoist samplers to quickCheck samplers

README.md

@@ -63,7 +63,7 @@ in that respect closely related to QuickCheck's generator type `Gen a` to which
 it can be converted through, e.g.:
 
 ``` hs
-hoistRejectionSampler ::
+quickCheckRejectionSampler ::
   BoltzmannSampler a => (Int -> (LowerBound, UpperBound)) -> Gen a
 ```
 

api/Data/Boltzmann.hs

@@ -14,8 +14,8 @@ module Data.Boltzmann (
   toleranceRejectionSampler,
   mkBoltzmannSampler,
   mkDefBoltzmannSampler,
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
-  hoistToleranceRejectionSampler,
+  quickCheckToleranceRejectionSampler,
 
   -- * Buffon machines
   BuffonMachine,
@@ -39,8 +39,8 @@ import Data.Boltzmann.Sampler (
   BoltzmannSampler (..),
   LowerBound (..),
   UpperBound (..),
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
-  hoistToleranceRejectionSampler,
+  quickCheckToleranceRejectionSampler,
   rejectionSampler,
   toleranceRejectionSampler,
  )

internal/Data/Boltzmann/Sampler.hs

@@ -16,17 +16,18 @@ module Data.Boltzmann.Sampler (
   toleranceRejectionSampler,
 
   -- * Other utilities
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
-  hoistToleranceRejectionSampler,
+  quickCheckToleranceRejectionSampler,
 ) where
 
 import Control.Monad.Trans.Maybe (MaybeT, runMaybeT)
 import Data.Boltzmann.BuffonMachine (BuffonMachine, eval)
 import Data.Coerce (coerce)
 import System.Random (RandomGen)
-import Test.QuickCheck (Gen)
+
-import Test.QuickCheck.Gen (Gen (MkGen))
+import qualified Test.QuickCheck as QuickCheck (Gen)
-import Test.QuickCheck.Random (QCGen (QCGen))
+import qualified Test.QuickCheck.Gen as QuickCheck (Gen (MkGen))
+import qualified Test.QuickCheck.Random as QuickCheck (QCGen (QCGen))
 
 -- | Multiparametric Boltzmann samplers.
 class BoltzmannSampler a where
@@ -73,21 +74,26 @@ toleranceRejectionSampler n eps = rejectionSampler lb ub
     ub = MkUpperBound $ ceiling $ (1 + eps) * fromIntegral n
 
 -- |
---  Using the given tolerance, hoists a tolerance rejection sampler
+--  Using the given tolerance, maps a tolerance rejection sampler
 --  for @a@ to a Quickcheck generator @Gen a@.
-hoistRejectionSampler ::
+quickCheckRejectionSampler ::
   BoltzmannSampler a =>
   (Int -> (LowerBound, UpperBound)) ->
-  Gen a
+  QuickCheck.Gen a
-hoistRejectionSampler genBounds = MkGen $ \(QCGen g) n ->
+quickCheckRejectionSampler genBounds = QuickCheck.MkGen $
-  let (lb, ub) = genBounds n
+  \(QuickCheck.QCGen g) n ->
-      machine = rejectionSampler lb ub
+    let (lb, ub) = genBounds n
-   in eval machine g
+        machine = rejectionSampler lb ub
+     in eval machine g
 
 -- |
---  Using the given tolerance, hoists a tolerance rejection sampler
+--  Using the given tolerance, maps a tolerance rejection sampler
 --  for @a@ to a Quickcheck generator @Gen a@.
-hoistToleranceRejectionSampler :: BoltzmannSampler a => Double -> Gen a
+quickCheckToleranceRejectionSampler ::
-hoistToleranceRejectionSampler eps = MkGen $ \(QCGen g) n ->
+  BoltzmannSampler a =>
-  let machine = toleranceRejectionSampler n eps
+  Double ->
-   in eval machine g
+  QuickCheck.Gen a
+quickCheckToleranceRejectionSampler eps = QuickCheck.MkGen $
+  \(QuickCheck.QCGen g) n ->
+    let machine = toleranceRejectionSampler n eps
+     in eval machine g

stack.yaml

@@ -39,6 +39,7 @@ packages:
 #
 extra-deps:
 - criterion-1.5.12.0
+- testing-feat-1.1.0.0
 - git: https://github.com/maciej-bendkowski/paganini-hs
   commit: 941e8f6314ea49b79c2cf1a03924cbedc981917e
 - git: https://github.com/OctopiChalmers/BinderAnn

stack.yaml.lock

@@ -11,6 +11,13 @@ packages:
       sha256: 92034e3e490c5fe0eab10277f6e35534b37dc0962347025630380c7d37d99ca1
   original:
     hackage: criterion-1.5.12.0
+- completed:
+    hackage: testing-feat-1.1.0.0@sha256:7c7629c5014edf06aefbf30a061d1ee64c6ee15f438d868e34749fb22208ab0b,2466
+    pantry-tree:
+      size: 790
+      sha256: 444f3c68a4f4fa1488fbbe9e8d9bbcc5f226b12a5027ee93683d5f95bf0ece28
+  original:
+    hackage: testing-feat-1.1.0.0
 - completed:
     name: paganini-hs
     version: 0.3.0.0

test/Test/Samplers/BinTree.hs

@@ -9,7 +9,7 @@ import Data.Boltzmann (
   LowerBound (MkLowerBound),
   System (..),
   UpperBound (MkUpperBound),
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
   mkBoltzmannSampler,
   mkDefWeights,
  )
@@ -40,6 +40,6 @@ mkBoltzmannSampler
 
 instance Arbitrary BinTree where
   arbitrary =
-    hoistRejectionSampler $
+    quickCheckRejectionSampler $
       const (MkLowerBound 800, MkUpperBound 1200)
   shrink = const []

test/Test/Samplers/Lambda.hs

@@ -14,7 +14,7 @@ import Data.Boltzmann (
   LowerBound (MkLowerBound),
   System (..),
   UpperBound (MkUpperBound),
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
   mkBoltzmannSampler,
   mkDefWeights,
  )
@@ -67,7 +67,7 @@ instance Size Lambda where
 
 instance Arbitrary Lambda where
   arbitrary =
-    hoistRejectionSampler $
+    quickCheckRejectionSampler $
       const (MkLowerBound 8_000, MkUpperBound 12_000)
   shrink = const []
 
@@ -95,6 +95,6 @@ mkBoltzmannSampler
 
 instance Arbitrary BinLambda where
   arbitrary =
-    hoistRejectionSampler $
+    quickCheckRejectionSampler $
       const (MkLowerBound 5_000, MkUpperBound 6_400)
   shrink = const []

test/Test/Samplers/Tree.hs

@@ -9,7 +9,7 @@ import Data.Boltzmann (
   LowerBound (MkLowerBound),
   System (..),
   UpperBound (MkUpperBound),
-  hoistRejectionSampler,
+  quickCheckRejectionSampler,
   mkBoltzmannSampler,
   mkDefBoltzmannSampler,
   mkDefWeights,
@@ -30,7 +30,7 @@ instance Size Tree where
 
 instance Arbitrary Tree where
   arbitrary =
-    hoistRejectionSampler $
+    quickCheckRejectionSampler $
       const (MkLowerBound 1600, MkUpperBound 2400)
   shrink = const []
 
@@ -53,6 +53,6 @@ mkBoltzmannSampler
 
 instance Arbitrary Tree' where
   arbitrary =
-    hoistRejectionSampler $
+    quickCheckRejectionSampler $
       const (MkLowerBound 8500, MkUpperBound 11_150)
   shrink = const []