refactor: rename base module

Rename base module from 'Strings' to 'MCSP'.

app/Main.hs

@@ -6,10 +6,10 @@ import Data.Store (Size (ConstSize), Store (size), decodeIO, encode)
 import Data.Word (Word8)
 import GHC.Generics (Generic)
 
-import Strings.Data.Partition (randomShuffledBlocks)
-import Strings.Data.String (String)
-import Strings.Data.String.Deriving (derivingUnboxVia)
-import Strings.System.Random (generate)
+import MCSP.Data.Partition (randomShuffledBlocks)
+import MCSP.Data.String (String)
+import MCSP.Data.String.Deriving (derivingUnboxVia)
+import MCSP.System.Random (generate)
 
 data Letter = A | C | G | T
     deriving stock (Show, Read, Eq, Ord, Enum, Bounded, Generic)

bench/Bench.hs

@@ -4,9 +4,9 @@ import Control.Monad (replicateM)
 import Criterion.Main (Benchmark, bench, bgroup, defaultMain, nf)
 import Data.String qualified as Text
 
-import Strings.Data.String (String)
-import Strings.Heuristics.Combine (combineHeuristic, combineHeuristicS)
-import Strings.System.Random (generate)
+import MCSP.Data.String (String)
+import MCSP.Heuristics.Combine (combineHeuristic, combineHeuristicS)
+import MCSP.System.Random (generate)
 
 import TestLib.Heuristics (MCSPHeuristic, StringParameters (..), genStringPair, testHeuristic)
 

package.yaml

@@ -77,13 +77,13 @@ ghc-options:
 library:
   source-dirs: src
   exposed-modules:
-    - Strings.Data.Partition
-    - Strings.Data.RadixTree
-    - Strings.Data.String
-    - Strings.Data.String.Deriving
-    - Strings.Data.String.Extra
-    - Strings.Heuristics.Combine
-    - Strings.System.Random
+    - MCSP.Data.Partition
+    - MCSP.Data.RadixTree
+    - MCSP.Data.String
+    - MCSP.Data.String.Deriving
+    - MCSP.Data.String.Extra
+    - MCSP.Heuristics.Combine
+    - MCSP.System.Random
 
 internal-libraries:
   MCSP-Algorithms-test-lib:

src/Strings/Data/Partition.hs → src/MCSP/Data/Partition.hs

@@ -1,5 +1,5 @@
 -- | Operations on partitions of `String`.
-module Strings.Data.Partition (
+module MCSP.Data.Partition (
     Partition,
     PartitionPair,
     SimpleEnum,
@@ -18,8 +18,8 @@ import Data.Int (Int)
 import GHC.Enum (Bounded, Enum)
 import GHC.Num ((-))
 
-import Strings.Data.String (String (Null, (:>), (:>:)), Unbox, concat, replicateM)
-import Strings.System.Random (Random, partitions, shuffle, uniformE, uniformRE)
+import MCSP.Data.String (String (Null, (:>), (:>:)), Unbox, concat, replicateM)
+import MCSP.System.Random (Random, partitions, shuffle, uniformE, uniformRE)
 
 -- | A collection of substrings of the same string.
 type Partition a = [String a]

src/Strings/Data/RadixTree.hs → src/MCSP/Data/RadixTree.hs

@@ -1,5 +1,5 @@
 -- | A compressed trie of string radices.
-module Strings.Data.RadixTree (
+module MCSP.Data.RadixTree (
     -- * Data Types
     RadixTree,
     Map.RadixTreeMap,
@@ -26,8 +26,8 @@ import Data.List (map)
 import Data.Maybe (Maybe)
 import Data.Ord (Ord)
 
-import Strings.Data.RadixTree.Map qualified as Map
-import Strings.Data.String (String (..))
+import MCSP.Data.RadixTree.Map qualified as Map
+import MCSP.Data.String (String (..))
 
 -- | A set of `String`s represented by a [radix tree](https://en.wikipedia.org/wiki/Radix_tree).
 --

src/Strings/Data/RadixTree/Map.hs → src/MCSP/Data/RadixTree/Map.hs

@@ -1,5 +1,5 @@
 -- | A map of `String` keys represented by a radix tree.
-module Strings.Data.RadixTree.Map (
+module MCSP.Data.RadixTree.Map (
     -- * Data Types
     RadixTreeMap (..),
     Edge (..),
@@ -51,8 +51,8 @@ import Text.Show (Show (showsPrec), showChar, showParen, showString, shows)
 import Data.Map.Strict qualified as Map
 import Data.Map.Strict.Internal (Map (Bin))
 
-import Strings.Data.String (ShowString, String (..), Unbox, (++))
-import Strings.Data.String.Prefix (splitCommonPrefix, stripPrefix)
+import MCSP.Data.String (ShowString, String (..), Unbox, (++))
+import MCSP.Data.String.Prefix (splitCommonPrefix, stripPrefix)
 
 -- --------------- --
 -- Data definition --

src/Strings/Data/RadixTree/Suffix.hs → src/MCSP/Data/RadixTree/Suffix.hs

@@ -1,5 +1,5 @@
 -- | A compressed trie of string suffixes.
-module Strings.Data.RadixTree.Suffix (
+module MCSP.Data.RadixTree.Suffix (
     SuffixTree,
     suffixes,
     construct,
@@ -16,8 +16,8 @@ import Data.Ord (Ord (..))
 import Data.Semigroup (Semigroup (..))
 import Text.Show (Show)
 
-import Strings.Data.RadixTree.Map qualified as Map
-import Strings.Data.String (String (..), length)
+import MCSP.Data.RadixTree.Map qualified as Map
+import MCSP.Data.String (String (..), length)
 
 -- --------------- --
 -- Data definition --

src/Strings/Data/String.hs → src/MCSP/Data/String.hs

@@ -1,5 +1,5 @@
 -- | Generic strings using backed by a contiguous array of unboxed characters.
-module Strings.Data.String (
+module MCSP.Data.String (
     -- * Unboxed string
     String (.., Unboxed, Null, NonNull, Head, Last, Singleton, (:<), (:>), (:<:), (:>:)),
     Unbox,
@@ -182,7 +182,7 @@ import Data.Vector.Generic qualified as Generic
 import Data.Vector.Generic.Mutable qualified as Mutable
 import Data.Vector.Unboxed (MVector, Unbox, Vector)
 
-import Strings.Data.String.Text (ReadString (..), ShowString (..), readCharsPrec)
+import MCSP.Data.String.Text (ReadString (..), ShowString (..), readCharsPrec)
 
 -- --------------- --
 -- Data definition --

src/Strings/Data/String/Deriving.hs → src/MCSP/Data/String/Deriving.hs

@@ -1,5 +1,5 @@
 -- | Simplified `derivingUnbox`.
-module Strings.Data.String.Deriving (
+module MCSP.Data.String.Deriving (
     EnumLike,
     derivingUnboxVia,
 ) where

src/Strings/Data/String/Extra.hs → src/MCSP/Data/String/Extra.hs

@@ -1,12 +1,12 @@
 -- | Custom operations for `String`.
-module Strings.Data.String.Extra (
+module MCSP.Data.String.Extra (
     -- ** Character set analysis
     frequency,
     singletons,
     hasOneOf,
 
     -- ** Substring analysis
-    module Strings.Data.String.Prefix,
+    module MCSP.Data.String.Prefix,
     suffixes,
     longestCommonSubstring,
 ) where
@@ -22,9 +22,9 @@ import Data.Ord (Ord)
 import Data.Set (Set, insert, member)
 import GHC.Num ((+))
 
-import Strings.Data.RadixTree.Suffix (construct, findMax, suffixes)
-import Strings.Data.String (String)
-import Strings.Data.String.Prefix
+import MCSP.Data.RadixTree.Suffix (construct, findMax, suffixes)
+import MCSP.Data.String (String)
+import MCSP.Data.String.Prefix
 
 -- ---------------------- --
 -- Character set analysis --

src/Strings/Data/String/Prefix.hs → src/MCSP/Data/String/Prefix.hs

@@ -1,5 +1,5 @@
 -- | Prefix operations on `String`.
-module Strings.Data.String.Prefix (
+module MCSP.Data.String.Prefix (
     stripPrefix,
     isPrefixOf,
     commonPrefix,
@@ -15,7 +15,7 @@ import Data.Ord (min)
 import Data.Tuple.Extra (fst3)
 import GHC.Num ((-))
 
-import Strings.Data.String (String, length, splitAt, take, unsafeIndex, unsafeSlice)
+import MCSP.Data.String (String, length, splitAt, take, unsafeIndex, unsafeSlice)
 
 -- ---------------------- --
 -- String prefix analysis --

src/Strings/Data/String/Text.hs → src/MCSP/Data/String/Text.hs

@@ -1,7 +1,7 @@
 {-# LANGUAGE UndecidableInstances #-}
 
 -- | Textual conversion for strings.
-module Strings.Data.String.Text (
+module MCSP.Data.String.Text (
     ShowString (..),
     ReadString (..),
     readCharsPrec,

src/Strings/Heuristics/Combine.hs → src/MCSP/Heuristics/Combine.hs

@@ -1,5 +1,5 @@
 -- | Combine Heuristics for solving the MCSP problem.
-module Strings.Heuristics.Combine (
+module MCSP.Heuristics.Combine (
     combineHeuristic,
     combineHeuristicS,
 ) where
@@ -9,9 +9,9 @@ import Prelude hiding (String, (++))
 import Data.Bifunctor (first, second)
 import Data.Set (Set)
 
-import Strings.Data.Partition (PartitionPair, chars)
-import Strings.Data.String (String, (++))
-import Strings.Data.String.Extra (hasOneOf, singletons)
+import MCSP.Data.Partition (PartitionPair, chars)
+import MCSP.Data.String (String, (++))
+import MCSP.Data.String.Extra (hasOneOf, singletons)
 
 -- | Applies a function until the result converges.
 converge :: Eq a => (a -> a) -> a -> a

src/Strings/System/Random.hs → src/MCSP/System/Random.hs

@@ -1,5 +1,5 @@
 -- | Randomized operations using a `Random` monad for "PCG" operations.
-module Strings.System.Random (
+module MCSP.System.Random (
     Random,
     Seed,
     staticSeed,
@@ -30,7 +30,7 @@ import System.Random.PCG qualified as PCG
 import System.Random.PCG.Class (Generator)
 import System.Random.Shuffle qualified as Shuffle (shuffle)
 
-import Strings.System.Random.Static (mkWord64)
+import MCSP.System.Random.Static (mkWord64)
 
 -- | A monad capable of producing random values of @a@.
 type Random a = forall g m. Generator g m => RandT g m a

src/Strings/System/Random/Static.hs → src/MCSP/System/Random/Static.hs

@@ -1,5 +1,5 @@
 -- | Compile time random value generation.
-module Strings.System.Random.Static (
+module MCSP.System.Random.Static (
     mkWord64,
     RandomIO,
     mkRandomQ,

test/Spec.hs

@@ -10,9 +10,9 @@ import Data.String qualified as Text
 import System.IO (IO, putStrLn)
 import Text.Show (Show, show)
 
-import Strings.Data.RadixTree (construct)
-import Strings.Data.String (String, concat)
-import Strings.System.Random (generate, shuffle)
+import MCSP.Data.RadixTree (construct)
+import MCSP.Data.String (String, concat)
+import MCSP.System.Random (generate, shuffle)
 
 assertEq :: (Show a, Eq a) => Text.String -> a -> a -> IO Bool
 assertEq function expected found

test/lib/TestLib/Heuristics.hs

@@ -7,9 +7,9 @@ module TestLib.Heuristics (
 
 import Prelude hiding (String)
 
-import Strings.Data.Partition (PartitionPair, randomShuffledCharsWithSingletons)
-import Strings.Data.String (String)
-import Strings.System.Random (Random)
+import MCSP.Data.Partition (PartitionPair, randomShuffledCharsWithSingletons)
+import MCSP.Data.String (String)
+import MCSP.System.Random (Random)
 
 -- | Heuristic for the MCSP problem.
 type MCSPHeuristic a = String a -> String a -> PartitionPair a