Change structure of examples, tests, bench, and tests-examples to properly match src structure

Author: tbagrel1

bench/Data/Mutable/Array.hs renamed to bench/Bench/Data/Array/Mutable.hs

@@ -11,7 +11,7 @@
 -- land in a file named “Array.dump-simpl”
 -- {-# OPTIONS_GHC -ddump-simpl -ddump-to-file -dsuppress-all -dsuppress-uniques #-}
 
-module Data.Mutable.Array (benchmarks) where
+module Bench.Data.Array.Mutable (benchmarks) where
 
 import Control.DeepSeq (rnf)
 import qualified Data.Array.Mutable.Linear as Array.Linear

bench/Data/Mutable/Quicksort.hs renamed to bench/Bench/Data/Array/Mutable/Quicksort.hs

@@ -1,11 +1,11 @@
 {-# LANGUAGE NumericUnderscores #-}
 
-module Data.Mutable.Quicksort (benchmarks) where
+module Bench.Data.Array.Mutable.Quicksort (benchmarks) where
 
 import Control.DeepSeq (force)
 import Control.Exception (evaluate)
+import Data.Array.Mutable.Quicksort (quicksortUsingArray, quicksortUsingList)
 import Data.List (sort)
-import Simple.Quicksort (quicksortUsingArray, quicksortUsingList)
 import System.Random
 import Test.Tasty.Bench
 

bench/Data/Mutable/HashMap.hs renamed to bench/Bench/Data/HashMap/Mutable.hs

@@ -11,7 +11,7 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TupleSections #-}
 
-module Data.Mutable.HashMap (benchmarks) where
+module Bench.Data.HashMap.Mutable (benchmarks) where
 
 import Control.DeepSeq (NFData (..), deepseq, force)
 import qualified Control.Monad.Random as Random

bench/Main.hs

@@ -1,14 +1,14 @@
 module Main where
 
-import qualified Data.Mutable.Array as Array
-import qualified Data.Mutable.HashMap as HashMap
-import qualified Data.Mutable.Quicksort as Quicksort
+import qualified Bench.Data.Array.Mutable as Array
+import qualified Bench.Data.Array.Mutable.Quicksort as Quicksort
+import qualified Bench.Data.HashMap.Mutable as HashMap
 import Test.Tasty.Bench (defaultMain)
 
 main :: IO ()
 main = do
   defaultMain
     [ Array.benchmarks,
-      HashMap.benchmarks,
-      Quicksort.benchmarks
+      Quicksort.benchmarks,
+      HashMap.benchmarks
     ]

examples/Simple/Quicksort.hs renamed to examples/Data/Array/Mutable/Quicksort.hs

@@ -6,7 +6,7 @@
 -- {-# OPTIONS_GHC -ddump-simpl -ddump-to-file -dsuppress-all -dsuppress-uniques #-}
 
 -- | This module implements quicksort with mutable arrays from linear-base
-module Simple.Quicksort where
+module Data.Array.Mutable.Quicksort where
 
 import Data.Array.Mutable.Linear (Array)
 import qualified Data.Array.Mutable.Linear as Array

examples/Simple/TopSort.hs renamed to examples/Data/HashMap/Mutable/TopSort.hs

@@ -5,7 +5,7 @@
 {-# OPTIONS_GHC -Wno-name-shadowing #-}
 {-# OPTIONS_GHC -Wno-unused-matches #-}
 
-module Simple.TopSort where
+module Data.HashMap.Mutable.TopSort where
 
 import Data.Bifunctor.Linear (second)
 import qualified Data.Functor.Linear as Data

examples/README.md

@@ -1,10 +1,12 @@
 # Examples
 
+ * `Data`
+   * These are examples of using the pure linear interface of mutable
+     data structures provided by linear base.
  * `Simple`
    * These are tutorial level examples for understanding linear
    types and using bread-and-butter tools in linear base.
    * Recommended order: `Pure`, `FileIO`.
  * `Foreign`
    * These are examples of explicitly allocating off the GC heap's
-   memory and on the system heap's memory
-
+   memory and on the system heap's memory.

linear-base.cabal

@@ -153,8 +153,8 @@ library examples
         Foreign.Heap
         Simple.FileIO
         Simple.Pure
-        Simple.Quicksort
-        Simple.TopSort
+        Data.Array.Mutable.Quicksort
+        Data.HashMap.Mutable.TopSort
     build-depends:
         base,
         linear-base,
@@ -169,12 +169,12 @@ test-suite test
     main-is:          Main.hs
     hs-source-dirs:   test
     other-modules:
-        Test.Data.Destination
-        Test.Data.Mutable.Array
-        Test.Data.Mutable.Vector
-        Test.Data.Mutable.HashMap
-        Test.Data.Mutable.Set
-        Test.Data.Polarized
+        Test.Data.Array.Destination
+        Test.Data.Array.Mutable
+        Test.Data.Vector.Mutable
+        Test.Data.HashMap.Mutable
+        Test.Data.Set.Mutable
+        Test.Data.Array.Polarized
         Test.Data.Functor.Linear
         Test.Data.V
         Test.Data.Replicator
@@ -200,7 +200,7 @@ test-suite test-examples
     hs-source-dirs:   test-examples
     other-modules:
         Test.Foreign
-        Test.Simple.Quicksort
+        Test.Data.Array.Mutable.Quicksort
     default-language: Haskell2010
     build-depends:
         base,
@@ -217,9 +217,9 @@ benchmark bench
     main-is:          Main.hs
     hs-source-dirs:   bench
     other-modules:
-        Data.Mutable.HashMap
-        Data.Mutable.Array
-        Data.Mutable.Quicksort
+        Bench.Data.HashMap.Mutable
+        Bench.Data.Array.Mutable
+        Bench.Data.Array.Mutable.Quicksort
     default-language: Haskell2010
     build-depends:
         base,

test-examples/Main.hs

@@ -1,7 +1,7 @@
 module Main where
 
+import Test.Data.Array.Mutable.Quicksort (quicksortTests)
 import Test.Foreign (foreignGCTests)
-import Test.Simple.Quicksort (quicksortTests)
 import Test.Tasty
 
 main :: IO ()

test-examples/Test/Simple/Quicksort.hs renamed to test-examples/Test/Data/Array/Mutable/Quicksort.hs

@@ -1,29 +1,29 @@
 {-# LANGUAGE OverloadedStrings #-}
 
-module Test.Simple.Quicksort (quicksortTests) where
+module Test.Data.Array.Mutable.Quicksort (quicksortTests) where
 
+import Data.Array.Mutable.Quicksort (quicksortUsingArray, quicksortUsingList)
 import Data.List (sort)
 import Hedgehog
 import qualified Hedgehog.Gen as Gen
 import qualified Hedgehog.Range as Range
-import Simple.Quicksort (quicksortUsingArray, quicksortUsingList)
 import Test.Tasty
 import Test.Tasty.Hedgehog (testPropertyNamed)
 
 quicksortTests :: TestTree
 quicksortTests =
   testGroup
     "quicksort tests"
-    [ testPropertyNamed "sort xs === quicksortUsingArray xs" "testQuicksortUsingArray" testQuicksortUsingArray,
-      testPropertyNamed "sort xs === quicksortUsingList xs" "testQuicksortUsingList" testQuicksortUsingList
+    [ testPropertyNamed "sort xs === quicksortUsingArray xs" "testQsortUsingArray" testQsortUsingArray,
+      testPropertyNamed "sort xs === quicksortUsingList xs" "testQsortUsingList" testQsortUsingList
     ]
 
-testQuicksortUsingArray :: Property
-testQuicksortUsingArray = property $ do
+testQsortUsingArray :: Property
+testQsortUsingArray = property $ do
   xs <- forAll $ Gen.list (Range.linear 0 1000) (Gen.int $ Range.linear 0 100)
   sort xs === quicksortUsingArray xs
 
-testQuicksortUsingList :: Property
-testQuicksortUsingList = property $ do
+testQsortUsingList :: Property
+testQsortUsingList = property $ do
   xs <- forAll $ Gen.list (Range.linear 0 1000) (Gen.int $ Range.linear 0 100)
   sort xs === quicksortUsingList xs