text-compression 0.1.0.10 → 0.1.0.11

raw patch · 6 files changed

+43/−5 lines, 6 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +4/−0
• src/Data/BWT.hs +2/−2
• src/Data/BWT/Internal.hs +2/−2
• src/Data/MTF.hs +17/−0
• src/Data/RLE.hs +17/−0
• text-compression.cabal +1/−1

@@ -43,3 +43,7 @@ ## 0.1.0.10 -- 2022-11-15  * Added Move-to-front transform (MTF) implementation.++## 0.1.0.11 -- 2022-11-16++* Adding more documentation for RLE and MTF implementations.

@@ -69,8 +69,8 @@                 -> BWT Word8 bytestringToBWT = toBWT . BS.unpack --- | A newtype to ensure you only uncompress a BWT created--- from textToBWT, since [Word8] -> Text is partial.+-- | A newtype to ensure you only uncompress a 'BWT' created+-- from 'textToBWT', since ['Word8'] -> 'Text' is partial. newtype TextBWT = TextBWT (BWT Word8)   deriving (Eq,Ord,Show,Read,Generic) 

@@ -76,7 +76,7 @@   -- | The BWTMatrix data type.--- Uses a massiv array internally.+-- Uses a 'DMA.Array' internally. type BWTMatrix = DMA.Array BN Ix1 String  {-------------------}@@ -214,7 +214,7 @@                  bwtcse  -- | Simple yet efficient implementation of converting a given string--- into a BWT Matrix (the BWTMatrix type is a massiv array).+-- into a BWT Matrix (the BWTMatrix type is a 'DMA.Array'). createBWTMatrix :: String                 -> BWTMatrix createBWTMatrix t =

@@ -12,6 +12,23 @@ -- Portability :  portable -- -- = Move-to-front transform (MTF)+--+-- Most users will get the most mileage by first compressing using a 'BWT'+-- on the initial 'ByteString' or 'Text' input before compressing to+-- a 'MTFB' or 'MTFT'.+--+-- To do this, users can use the 'bytestringToBWTToMTFB' and 'bytestringToBWTToMTFT' functions,+-- as well as the 'textToBWTToMTFB' and 'textToBWTToMTFT' functions.+--+-- The base functions for 'ByteString', 'bytestringToMTFB', 'bytestringToMTFT' can be used to+-- convert a 'Seq' ('Maybe' 'ByteString') to a 'MTFB' and 'MTFT', respectively.+--+-- Likewise, the base functions for 'Text', 'textToMTFB' and 'textToMTFT' can be used to+-- convert a 'Seq' ('Maybe' 'Text') to a 'MTFB' and 'MTFT' respectively.+--+-- There are various other lower-level functions for interacting with the MTF implementation on 'ByteString' and 'Text' as well.+--+-- @"Data.MTF.Internal"@ contains low-level, efficient, and stateful implementations of the MTF and Inverse MTF algorithms.   module Data.MTF ( -- * To MTF functions

@@ -12,6 +12,23 @@ -- Portability :  portable -- -- = Run-length encoding (RLE)+--+-- Most users will get the most mileage by first compressing using a 'BWT'+-- on the initial 'ByteString' or 'Text' input before compressing to+-- a 'RLEB' or 'RLET'.+--+-- To do this, users can use the 'bytestringToBWTToRLEB' and 'bytestringToBWTToRLET' functions,+-- as well as the 'textToBWTToRLEB' and 'textToBWTToRLET' functions.+--+-- The base functions for 'ByteString', 'bytestringToRLEB', 'bytestringToRLET' can be used to+-- convert a 'Seq' ('Maybe' 'ByteString') to a 'RLEB' and 'RLET', respectively.+--+-- Likewise, the base functions for 'Text', 'textToRLEB' and 'textToRLET' can be used to+-- convert a 'Seq' ('Maybe' 'Text') to a 'RLEB' and 'RLET' respectively.+--+-- There are various other lower-level functions for interacting with the RLE implementation on 'ByteString' and 'Text' as well.+--+-- @"Data.RLE.Internal"@ contains low-level, efficient, and stateful implementations of the RLE and Inverse RLE algorithms.   module Data.RLE ( -- * To RLE functions

@@ -20,7 +20,7 @@ -- PVP summary:     +-+------- breaking API changes --                  | | +----- non-breaking API additions --                  | | | +--- code changes with no API change-version:            0.1.0.10+version:            0.1.0.11  -- A short (one-line) description of the package. synopsis:           A text compression library.