packages feed

groan (empty) → 0.1.0.0

raw patch · 6 files changed

+1118/−0 lines, 6 filesdep +basedep +containersdep +contiguous

Dependencies added: base, containers, contiguous, groan, hedgehog, hspec, hspec-hedgehog, primitive, transformers, vector

Files

+ Data/Vector/Groan.hs view
@@ -0,0 +1,249 @@+{-# LANGUAGE Strict #-}++module Data.Vector.Groan (+  Buffer,++  -- * Running computations that allocate to a buffer+  run,+  runPrim,++  -- * Creating buffers+  new,+  replicate,+  thaw,++  -- * Reading+  read,++  -- ** Size and capacity+  size,+  capacity,++  -- * Mutable operations++  -- ** Pop+  popBack,++  -- ** Writes+  write,++  -- *** Appends+  pushBack,+  pushAllBack,+  pushFoldableBack,++  -- * Conversion+  freeze,+  unsafeFreeze,+  unsafeFreezeVector,+) where++import Control.Monad (forM_)+import Control.Monad.Primitive+import Control.Monad.ST.Strict+import Control.Monad.Trans.State.Strict+import Data.Primitive.Array+import Data.Primitive.Contiguous qualified as C+import Data.Primitive.MutVar+import Data.Vector (Vector)+import Data.Vector qualified as V+import Prelude hiding (read, replicate)++-- | Single-threaded buffer+newtype Buffer s a = Buffer (MutVar s (BufferRep s a))++data BufferRep s a = BufferRep+  { length :: {-# UNPACK #-} !Int+  , buffer :: {-# UNPACK #-} !(MutableArray s a)+  }++{-# INLINE run #-}+run :: Int -> (forall s. Buffer s a -> ST s ()) -> Vector a+run initialCapacity fn = runST do+  buffer <- new initialCapacity+  fn buffer+  unsafeFreezeVector buffer++{-# INLINE runPrim #-}+runPrim :: (PrimMonad m) => Int -> (Buffer (PrimState m) a -> m ()) -> m (Vector a)+runPrim initialCapacity fn = do+  buffer <- new initialCapacity+  fn buffer+  unsafeFreezeVector buffer++-- | Create a buffer with an initial (unfilled) capacity+{-# INLINE new #-}+new :: forall a m. (PrimMonad m) => Int -> m (Buffer (PrimState m) a)+new initialCapacity = do+  buffer <- newArray initialCapacity uninitialisedElement+  Buffer <$> newMutVar (BufferRep 0 buffer)++-- | Create a buffer with n initial elements+{-# INLINE replicate #-}+replicate :: (PrimMonad m) => Int -> a -> m (Buffer (PrimState m) a)+replicate size initialElem = do+  buffer <- newArray size initialElem+  Buffer <$> newMutVar (BufferRep size buffer)++-- | Create a buffer from an array, copying its elements+{-# INLINE thaw #-}+thaw :: (PrimMonad m) => Array a -> m (Buffer (PrimState m) a)+thaw input = do+  buffer <- thawArray input 0 (sizeofArray input)+  Buffer <$> newMutVar (BufferRep (sizeofArray input) buffer)++{-# INLINE read #-}++-- | Read an item from a buffer+read :: (PrimMonad m) => Buffer (PrimState m) a -> Int -> m a+read (Buffer ref) i = do+  BufferRep len buf <- readMutVar ref+  if i < len+    then readArray buf i+    else error ("index: out of range " <> show (i, len))++{-# INLINE write #-}++-- | Write an item to a buffer+--+-- The index given must be within the buffer's existing *length* - not capacity.+write :: (PrimMonad m) => Buffer (PrimState m) a -> Int -> a -> m ()+write (Buffer ref) i a = do+  BufferRep len buf <- readMutVar ref+  if i < len+    then writeArray buf i a+    else error ("index: out of range " <> show (i, len))++{-# INLINE pushBack #-}++-- | Push an element to end of the buffer, returning the new length+pushBack :: (PrimMonad m) => Buffer (PrimState m) a -> a -> m Int+pushBack (Buffer ref) a = do+  BufferRep len dest <- readMutVar ref+  let capacity = sizeofMutableArray dest+  if len < capacity+    then do+      writeArray dest len a+      writeMutVar ref (BufferRep (len + 1) dest)+    else do+      next <- newArray (grow (capacity + 1)) uninitialisedElement+      copyMutableArray next 0 dest 0 (sizeofMutableArray dest)+      writeArray next len a+      writeMutVar ref (BufferRep (len + 1) next)+  pure (len + 1)++{-# INLINE pushFoldableBack #-}++-- | Push multiple elements to the end of the buffer, returning the new length+pushFoldableBack :: (Foldable f, PrimMonad m) => Buffer (PrimState m) a -> f a -> m Int+pushFoldableBack b@(Buffer ref) f+  | null f = size b+pushFoldableBack (Buffer ref) f = do+  BufferRep {length = len, buffer = dest} <- readMutVar ref+  let capacity = sizeofMutableArray dest+  let nextLen = len + Prelude.length f+  if nextLen < capacity+    then do+      -- just write+      writtenLen <- (`execStateT` len) do+        forM_ f \x -> StateT \i -> do+          writeArray dest i x+          pure ((), i + 1)+      -- assert (writtenLen == nextLen)+      writeMutVar ref (BufferRep writtenLen dest)+    else do+      -- grow then write+      dest <- C.resize dest (grow nextLen)+      writtenLen <- (`execStateT` len) do+        forM_ f \x -> StateT \i -> do+          writeArray dest i x+          pure ((), i + 1)+      -- assert (writtenLen == nextLen)+      writeMutVar ref (BufferRep writtenLen dest)+  pure nextLen++{-# INLINE pushAllBack #-}++-- | Push multiple elements to the end of the buffer+pushAllBack :: (PrimMonad m) => Buffer (PrimState m) a -> C.Sliced Array a -> m Int+pushAllBack b@(Buffer ref) arr+  | C.null arr = size b+pushAllBack (Buffer ref) arr = do+  BufferRep len dest <- readMutVar ref+  let capacity = sizeofMutableArray dest+  let nextLen = len + C.size arr+  if nextLen < capacity+    then do+      -- just write+      C.copy dest len arr+      writeMutVar ref (BufferRep nextLen dest)+    else do+      -- grow then write+      dest <- C.resize dest (grow nextLen)+      C.copy dest len arr+      writeMutVar ref (BufferRep nextLen dest)+  pure nextLen++{-# INLINE popBack #-}++-- | Pop the last element off of the buffer+popBack :: (PrimMonad m) => Buffer (PrimState m) a -> m (Maybe (a, Int))+popBack (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  let i = len - 1+  if i >= 0+    then do+      writeMutVar ref (BufferRep i buf)+      el <- readArray buf i+      pure (Just (el, i))+    else pure Nothing++-- | Freeze the buffer by copying+{-# INLINE freeze #-}+freeze :: (PrimMonad m) => Buffer (PrimState m) a -> m (Array a)+freeze (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  C.freeze (C.sliceMut buf 0 len)++-- | Freeze the buffer without copying+{-# INLINE unsafeFreeze #-}+unsafeFreeze :: (PrimMonad m) => Buffer (PrimState m) a -> m (C.Sliced C.Array a)+unsafeFreeze (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  frz <- C.unsafeFreeze buf+  pure (C.slice frz 0 len)++-- | Freeze the buffer into a 'Vector' without copying+{-# INLINE unsafeFreezeVector #-}+unsafeFreezeVector :: (PrimMonad m) => Buffer (PrimState m) a -> m (Vector a)+unsafeFreezeVector (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  frz <- C.unsafeFreeze buf+  pure (V.unsafeFromArraySlice frz 0 len)++--------------------------------------------------------------------------------++-- | The current length of the buffer+{-# INLINE size #-}+size :: (PrimMonad m) => Buffer (PrimState m) a -> m Int+size (Buffer ref) = do+  BufferRep len _buf <- readMutVar ref+  pure len++-- | The current capacity (as in, remaining free space) of the buffer+{-# INLINE capacity #-}+capacity :: (PrimMonad m) => Buffer (PrimState m) a -> m Int+capacity (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  let capacity = sizeofMutableArray buf+  return (capacity - len)++--------------------------------------------------------------------------------++{-# INLINE grow #-}+grow :: Int -> Int+grow i = i * 2++{-# NOINLINE uninitialisedElement #-}+uninitialisedElement :: a+uninitialisedElement = error "Buffer: Not initialised"
+ Data/Vector/Groan/Unboxed.hs view
@@ -0,0 +1,183 @@+{-# LANGUAGE Strict #-}++module Data.Vector.Groan.Unboxed (+  Buffer,++  -- * Running computations that allocate to a buffer+  run,+  runPrim,++  -- * Creating buffers+  new,+  replicate,+  thaw,++  -- * Reading+  read,++  -- ** Size and capacity+  size,+  capacity,++  -- * Mutable operations++  -- ** Pop+  popBack,++  -- ** Writes+  write,++  -- *** Appends+  pushBack,++  -- * Conversion+  freeze,+  unsafeFreeze,+) where++import Control.Monad (forM_)+import Control.Monad.Primitive+import Control.Monad.ST.Strict+import Control.Monad.Trans.State.Strict+import Data.Monoid (First (..))+import Data.Primitive.MutVar+import Data.Vector qualified as V+import Data.Vector.Unboxed (Unbox)+import Data.Vector.Unboxed qualified as U+import Data.Vector.Unboxed.Mutable qualified as UM+import Prelude hiding (read, replicate)++-- | Single-threaded buffer+newtype Buffer s a = Buffer (MutVar s (BufferRep s a))++data BufferRep s a = BufferRep+  { length :: {-# UNPACK #-} !Int+  , buffer :: !(UM.MVector s a)+  }++{-# INLINE run #-}+run :: (Unbox a) => Int -> a -> (forall s. Buffer s a -> ST s ()) -> U.Vector a+run initialCapacity z fn = runST do+  buffer <- new initialCapacity z+  fn buffer+  unsafeFreeze buffer++{-# INLINE runPrim #-}+runPrim :: (Unbox a, PrimMonad m) => Int -> a -> (Buffer (PrimState m) a -> m ()) -> m (U.Vector a)+runPrim initialCapacity z fn = do+  buffer <- new initialCapacity z+  fn buffer+  unsafeFreeze buffer++-- | Create a buffer with an initial (unfilled) capacity and a value for+-- uninitialised elements+{-# INLINE new #-}+new :: forall a m. (Unbox a, PrimMonad m) => Int -> a -> m (Buffer (PrimState m) a)+new initialCapacity uninitialisedElement = do+  buffer <- UM.replicate initialCapacity uninitialisedElement+  Buffer <$> newMutVar (BufferRep 0 buffer)++-- | Create a buffer with n initial elements+{-# INLINE replicate #-}+replicate :: (Unbox a, PrimMonad m) => Int -> a -> m (Buffer (PrimState m) a)+replicate size initialElem = do+  buffer <- UM.replicate size initialElem+  Buffer <$> newMutVar (BufferRep size buffer)++-- | Create a buffer from an array, copying its elements+{-# INLINE thaw #-}+thaw :: (Unbox a, PrimMonad m) => U.Vector a -> m (Buffer (PrimState m) a)+thaw input = do+  buffer <- U.thaw input+  Buffer <$> newMutVar (BufferRep (U.length input) buffer)++{-# INLINE read #-}++-- | Read an item from a buffer+read :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> Int -> m a+read (Buffer ref) i = do+  BufferRep len buf <- readMutVar ref+  if i < len+    then UM.read buf i+    else error ("index: out of range " <> show (i, len))++{-# INLINE write #-}++-- | Write an item to a buffer+--+-- The index given must be within the buffer's existing *length* - not capacity.+write :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> Int -> a -> m ()+write (Buffer ref) i a = do+  BufferRep len buf <- readMutVar ref+  if i < len+    then UM.write buf i a+    else error ("index: out of range " <> show (i, len))++{-# INLINE pushBack #-}++-- | Push an element to end of the buffer, returning the new length+pushBack :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> a -> m Int+pushBack (Buffer ref) a = do+  BufferRep len dest <- readMutVar ref+  let capacity = UM.length dest+  if len < capacity+    then do+      UM.write dest len a+      writeMutVar ref (BufferRep (len + 1) dest)+    else do+      next <- UM.replicate (grow (capacity + 1)) a+      UM.copy (UM.slice 0 len next) dest+      UM.write next len a+      writeMutVar ref (BufferRep (len + 1) next)+  pure (len + 1)++{-# INLINE popBack #-}++-- | Pop the last element off of the buffer+popBack :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> m (Maybe (a, Int))+popBack (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  let i = len - 1+  if i >= 0+    then do+      writeMutVar ref (BufferRep i buf)+      el <- UM.read buf i+      pure (Just (el, i))+    else pure Nothing++-- | Freeze the buffer by copying+{-# INLINE freeze #-}+freeze :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> m (U.Vector a)+freeze (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  U.freeze (UM.slice 0 len buf)++-- | Freeze the buffer into a 'Vector' without copying+{-# INLINE unsafeFreeze #-}+unsafeFreeze :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> m (U.Vector a)+unsafeFreeze (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  U.unsafeFreeze (UM.slice 0 len buf)++--------------------------------------------------------------------------------++-- | The current length of the buffer+{-# INLINE size #-}+size :: (PrimMonad m) => Buffer (PrimState m) a -> m Int+size (Buffer ref) = do+  BufferRep len _buf <- readMutVar ref+  pure len++-- | The current capacity (as in, remaining free space) of the buffer+{-# INLINE capacity #-}+capacity :: (Unbox a, PrimMonad m) => Buffer (PrimState m) a -> m Int+capacity (Buffer ref) = do+  BufferRep len buf <- readMutVar ref+  let capacity = UM.length buf+  pure (capacity - len)++--------------------------------------------------------------------------------++{-# INLINE grow #-}+grow :: Int -> Int+grow i = i * 2
+ LICENSE view
@@ -0,0 +1,374 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+    means each individual or legal entity that creates, contributes to+    the creation of, or owns Covered Software.++1.2. "Contributor Version"+    means the combination of the Contributions of others (if any) used+    by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+    means Covered Software of a particular Contributor.++1.4. "Covered Software"+    means Source Code Form to which the initial Contributor has attached+    the notice in Exhibit A, the Executable Form of such Source Code+    Form, and Modifications of such Source Code Form, in each case+    including portions thereof.++1.5. "Incompatible With Secondary Licenses"+    means++    (a) that the initial Contributor has attached the notice described+        in Exhibit B to the Covered Software; or++    (b) that the Covered Software was made available under the terms of+        version 1.1 or earlier of the License, but not also under the+        terms of a Secondary License.++1.6. "Executable Form"+    means any form of the work other than Source Code Form.++1.7. "Larger Work"+    means a work that combines Covered Software with other material, in +    a separate file or files, that is not Covered Software.++1.8. "License"+    means this document.++1.9. "Licensable"+    means having the right to grant, to the maximum extent possible,+    whether at the time of the initial grant or subsequently, any and+    all of the rights conveyed by this License.++1.10. "Modifications"+    means any of the following:++    (a) any file in Source Code Form that results from an addition to,+        deletion from, or modification of the contents of Covered+        Software; or++    (b) any new file in Source Code Form that contains any Covered+        Software.++1.11. "Patent Claims" of a Contributor+    means any patent claim(s), including without limitation, method,+    process, and apparatus claims, in any patent Licensable by such+    Contributor that would be infringed, but for the grant of the+    License, by the making, using, selling, offering for sale, having+    made, import, or transfer of either its Contributions or its+    Contributor Version.++1.12. "Secondary License"+    means either the GNU General Public License, Version 2.0, the GNU+    Lesser General Public License, Version 2.1, the GNU Affero General+    Public License, Version 3.0, or any later versions of those+    licenses.++1.13. "Source Code Form"+    means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+    means an individual or a legal entity exercising rights under this+    License. For legal entities, "You" includes any entity that+    controls, is controlled by, or is under common control with You. For+    purposes of this definition, "control" means (a) the power, direct+    or indirect, to cause the direction or management of such entity,+    whether by contract or otherwise, or (b) ownership of more than+    fifty percent (50%) of the outstanding shares or beneficial+    ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+    Licensable by such Contributor to use, reproduce, make available,+    modify, display, perform, distribute, and otherwise exploit its+    Contributions, either on an unmodified basis, with Modifications, or+    as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+    for sale, have made, import, and otherwise transfer either its+    Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+    or++(b) for infringements caused by: (i) Your and any other third party's+    modifications of Covered Software, or (ii) the combination of its+    Contributions with other software (except as part of its Contributor+    Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+    its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+    Form, as described in Section 3.1, and You must inform recipients of+    the Executable Form how they can obtain a copy of such Source Code+    Form by reasonable means in a timely manner, at a charge no more+    than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+    License, or sublicense it under different terms, provided that the+    license for the Executable Form does not attempt to limit or alter+    the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+*                                                                      *+*  6. Disclaimer of Warranty                                           *+*  -------------------------                                           *+*                                                                      *+*  Covered Software is provided under this License on an "as is"       *+*  basis, without warranty of any kind, either expressed, implied, or  *+*  statutory, including, without limitation, warranties that the       *+*  Covered Software is free of defects, merchantable, fit for a        *+*  particular purpose or non-infringing. The entire risk as to the     *+*  quality and performance of the Covered Software is with You.        *+*  Should any Covered Software prove defective in any respect, You     *+*  (not any Contributor) assume the cost of any necessary servicing,   *+*  repair, or correction. This disclaimer of warranty constitutes an   *+*  essential part of this License. No use of any Covered Software is   *+*  authorized under this License except under this disclaimer.         *+*                                                                      *+************************************************************************++************************************************************************+*                                                                      *+*  7. Limitation of Liability                                          *+*  --------------------------                                          *+*                                                                      *+*  Under no circumstances and under no legal theory, whether tort      *+*  (including negligence), contract, or otherwise, shall any           *+*  Contributor, or anyone who distributes Covered Software as          *+*  permitted above, be liable to You for any direct, indirect,         *+*  special, incidental, or consequential damages of any character      *+*  including, without limitation, damages for lost profits, loss of    *+*  goodwill, work stoppage, computer failure or malfunction, or any    *+*  and all other commercial damages or losses, even if such party      *+*  shall have been informed of the possibility of such damages. This   *+*  limitation of liability shall not apply to liability for death or   *+*  personal injury resulting from such party's negligence to the       *+*  extent applicable law prohibits such limitation. Some               *+*  jurisdictions do not allow the exclusion or limitation of           *+*  incidental or consequential damages, so this exclusion and          *+*  limitation may not apply to You.                                    *+*                                                                      *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++  This Source Code Form is subject to the terms of the Mozilla Public+  License, v. 2.0. If a copy of the MPL was not distributed with this+  file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++  This Source Code Form is "Incompatible With Secondary Licenses", as+  defined by the Mozilla Public License, v. 2.0.+
+ groan.cabal view
@@ -0,0 +1,128 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.38.2.+--+-- see: https://github.com/sol/hpack++name:           groan+version:        0.1.0.0+synopsis:       ugh, another growable vector library?+description:    Yet another contiguous growable vector buffer library.+                .+                For algorithms where you need to pass around a growing buffer between+                a few different contexts, such as in and out of a data-structure,+                you're likely to get better performance using a mutable array than+                with a continuation-based builder type. This is because in the+                continuation-based builder, you're building up a linked list of+                append thunks, and there's no ability for GHC to fuse them together.+                In comparison, buffers have easily predictable performance.+category:       Data Structures, Data+author:         Michael Ledger+maintainer:     Michael Ledger <mike@quasimal.com>+license:        MPL-2.0+license-file:   LICENSE+build-type:     Simple++source-repository head+  type: git+  location: https://gitlab.com/combobulate.systems/records-edsl.git++library+  exposed-modules:+      Data.Vector.Groan+      Data.Vector.Groan.Unboxed+  hs-source-dirs:+      ./+  default-extensions:+      AllowAmbiguousTypes+      BangPatterns+      BlockArguments+      DataKinds+      DeriveAnyClass+      DerivingStrategies+      DerivingVia+      DuplicateRecordFields+      ExplicitForAll+      GADTs+      ImportQualifiedPost+      LambdaCase+      MultiWayIf+      MultilineStrings+      NamedFieldPuns+      NoImplicitPrelude+      NoStarIsType+      OverloadedLabels+      OverloadedRecordDot+      OverloadedStrings+      PartialTypeSignatures+      PatternSynonyms+      PolyKinds+      RequiredTypeArguments+      ScopedTypeVariables+      StrictData+      TemplateHaskell+      TemplateHaskellQuotes+      TypeApplications+      TypeFamilies+      ViewPatterns+  build-depends:+      base ==4.21.*+    , contiguous ==0.6.*+    , primitive ==0.9.*+    , transformers ==0.6.*+    , vector ==0.13.*+  default-language: GHC2024++test-suite tests+  type: exitcode-stdio-1.0+  main-is: spec.hs+  other-modules:+      Data.Vector.Groan.List+      Paths_groan+  hs-source-dirs:+      tests+  default-extensions:+      AllowAmbiguousTypes+      BangPatterns+      BlockArguments+      DataKinds+      DeriveAnyClass+      DerivingStrategies+      DerivingVia+      DuplicateRecordFields+      ExplicitForAll+      GADTs+      ImportQualifiedPost+      LambdaCase+      MultiWayIf+      MultilineStrings+      NamedFieldPuns+      NoImplicitPrelude+      NoStarIsType+      OverloadedLabels+      OverloadedRecordDot+      OverloadedStrings+      PartialTypeSignatures+      PatternSynonyms+      PolyKinds+      RequiredTypeArguments+      ScopedTypeVariables+      StrictData+      TemplateHaskell+      TemplateHaskellQuotes+      TypeApplications+      TypeFamilies+      ViewPatterns+  ghc-options: -threaded -rtsopts -with-rtsopts=-N+  build-depends:+      base ==4.12.*+    , containers+    , contiguous+    , groan+    , hedgehog ==1.7.*+    , hspec+    , hspec-hedgehog+    , primitive+    , transformers+    , vector+  default-language: GHC2024
+ tests/Data/Vector/Groan/List.hs view
@@ -0,0 +1,77 @@+module Data.Vector.Groan.List where++import Control.Monad.Primitive+import Data.Foldable+import Data.IORef+import Data.Primitive.Array+import Data.Primitive.Contiguous qualified as C+import Data.Sequence (Seq (..))+import Data.Sequence qualified as Seq+import Data.Vector.Groan qualified as B+import Data.Vector.Groan.Unboxed qualified as U+import Prelude++newtype Buffer a = Buffer (IORef (Seq a))++type Capacity = Int+type Length = Int+type Index = Int++new :: Capacity -> IO (Buffer a)+new _ = Buffer <$> newIORef Seq.empty++replicate :: Length -> a -> IO (Buffer a)+replicate n a = Buffer <$> newIORef (Seq.replicate n a)++thaw :: Array a -> IO (Buffer a)+thaw arr = Buffer <$> newIORef (Seq.fromList (toList arr))++read :: Buffer a -> Index -> IO a+read (Buffer ref) i = do+  s <- readIORef ref+  case Seq.lookup i s of+    Nothing -> error ("index: out of range " <> show (i, Seq.length s))+    Just a -> pure a++write :: Buffer a -> Index -> a -> IO ()+write (Buffer ref) i a = do+  s <- readIORef ref+  if i < Seq.length s+    then writeIORef ref (Seq.update i a s)+    else error ("index: out of range " <> show (i, Seq.length s))++pushBack+  :: Buffer a+  -> a+  -> IO Length+  -- ^ New length+pushBack (Buffer ref) a = do+  modifyIORef' ref (:|> a)+  Seq.length <$> readIORef ref++pushFoldableBack+  :: (Foldable f)+  => Buffer a+  -> f a+  -> IO Length+  -- ^ New length+pushFoldableBack (Buffer ref) f = do+  modifyIORef' ref (\s -> foldl' (:|>) s f)+  Seq.length <$> readIORef ref++popBack :: Buffer a -> IO (Maybe (a, Length))+popBack (Buffer ref) =+  atomicModifyIORef ref \case+    xs :|> x -> (xs, Just (x, Seq.length xs))+    Empty -> (Empty, Nothing)++freeze :: Buffer a -> IO (Array a)+freeze (Buffer ref) = do+  s <- readIORef ref+  pure (C.fromListN (Seq.length s) (toList s))++size :: Buffer a -> IO Length+size (Buffer ref) = Seq.length <$> readIORef ref++capacity :: Buffer a -> IO Capacity+capacity = size
+ tests/spec.hs view
@@ -0,0 +1,107 @@+import Control.Exception (SomeException, try)+import Control.Monad (void)+import Control.Monad.IO.Class (MonadIO (liftIO))+import Control.Monad.Primitive (RealWorld)+import Data.Foldable (forM_)+import Data.Functor ((<&>))+import Data.Int+import Data.Primitive.Contiguous qualified as C+import Data.Vector.Groan (pushFoldableBack)+import Data.Vector.Groan qualified as B+import Data.Vector.Groan.List qualified as List+import Data.Vector.Groan.Unboxed qualified as U+import Data.Vector.Unboxed qualified as UV+import Hedgehog.Gen qualified as Gen+import Hedgehog.Range qualified as Range+import Test.Hspec+import Test.Hspec.Hedgehog+import Prelude++type Element = Int32++genElement :: Gen Element+genElement = Gen.int32 (Range.linear minBound maxBound)++genElements :: Gen [Element]+genElements = Gen.list (Range.exponential 0 100) genElement++genManyElements :: Gen [Element]+genManyElements = Gen.list (Range.exponential 100 5000) genElement++testOp+  :: (a ~ Element, Show r, Eq r)+  => ([a] -> IO (buffer a))+  -> (buffer a -> IO (C.Array a))+  -> (buffer a -> IO r)+  -> (List.Buffer a -> IO r)+  -> PropertyT IO ()+testOp bufferNew bufferFreeze bufferOp listOp = do+  elements <- forAll genElements+  buf <- liftIO (bufferNew elements)+  listBuf <- liftIO (List.thaw (C.fromList elements))+  referenceOpResult <- liftIO (try @SomeException (listOp listBuf) <&> either (const Nothing) Just)+  actualOpResult <- liftIO (try @SomeException (bufferOp buf) <&> either (const Nothing) Just)+  reference <- liftIO (List.freeze listBuf)+  actual <- liftIO (bufferFreeze buf)+  referenceOpResult === actualOpResult+  reference === actual++main :: IO ()+main = hspec do+  describe "Data.Vector.Groan" do+    let+      testBOp+        :: (Eq r, Show r)+        => (B.Buffer RealWorld Element -> IO r)+        -> (List.Buffer Element -> IO r)+        -> PropertyT IO ()+      testBOp = testOp (B.thaw . C.fromList) B.freeze+    it "pushBack[1]" do+      elt <- forAll genElement+      testBOp+        (`B.pushBack` elt)+        (`List.pushBack` elt)+    it "pushBack[n]" do+      elts <- forAll genManyElements+      testBOp+        (\buf -> mapM_ (B.pushBack buf) elts)+        (\list -> mapM_ (List.pushBack list) elts)+    it "pushFoldableBack" do+      elts <- forAll genElements+      testBOp+        (`B.pushFoldableBack` elts)+        (`List.pushFoldableBack` elts)+    it "pushAllBack" do+      elts <- forAll genElements+      testBOp+        (`B.pushAllBack` C.toSlice (C.fromList @C.Array elts))+        (`List.pushFoldableBack` elts)+    it "popBack" do+      testBOp B.popBack List.popBack+    it "read" do+      i <- forAll (Gen.int (Range.linear 0 100))+      testBOp (`B.read` i) (`List.read` i)++  describe "Data.Vector.Groan.Unboxed" do+    let+      testUOp+        :: (Eq r, Show r)+        => (U.Buffer RealWorld Element -> IO r)+        -> (List.Buffer Element -> IO r)+        -> PropertyT IO ()+      testUOp = testOp (U.thaw . UV.fromList) (fmap (C.fromList . UV.toList) . U.freeze)+    it "pushBack[1]" do+      elt <- forAll genElement+      testUOp+        (`U.pushBack` elt)+        (`List.pushBack` elt)+    it "pushBack[n]" do+      elts <- forAll genManyElements+      testUOp+        (\buf -> mapM_ (U.pushBack buf) elts)+        (\list -> mapM_ (List.pushBack list) elts)+    it "popBack" do+      testUOp U.popBack List.popBack+    it "read" do+      i <- forAll (Gen.int (Range.linear 0 100))+      testUOp (`U.read` i) (`List.read` i)