@@ -28,57 +28,80 @@
2828
2929module Streamly.Internal.Data.MutArray.Type
3030 (
31− -- * Type
31+ -- ** Type
3232 -- $arrayNotes
3333 MutArray (..)
34− , MutByteArray
35− , MutableByteArray
34+
35+ -- ** Conversion
36+ -- *** Pinned and Unpinned
3637 , pin
3738 , unpin
3839 , isPinned
3940
40− -- * Constructing and Writing
41+ -- ** Casting
42+ , cast
43+ , castUnsafe -- XXX unsafeCast
44+ , asBytes
45+ , unsafePinnedAsPtr
46+ , unsafeAsPtr
47+
4148 -- ** Construction
42− , nil
49+ , empty
50+
51+ -- *** New
52+ -- | New arrays are always empty arrays with some reserve capacity to
53+ -- extend the length without reallocating.
54+ , emptyOf
55+ , newArrayWith -- emptyAlignedWith
56+ , pinnedEmptyOf
57+ , pinnedNewAligned -- XXX not required
58+ -- , new -- uninitialized array of specified length
59+
60+ -- *** Cloning
61+ , clone
62+ , pinnedClone
4363
44− -- *** Uninitialized Arrays
45− , pinnedNew
46− , pinnedNewBytes
47− , pinnedNewAligned
48− , new
49− , newArrayWith
64+ -- *** Slicing
65+ -- | Get a subarray without copying
66+ , getSliceUnsafe -- XXX unsafeGetSlice
67+ , getSlice
68+ , splitAt -- XXX should be able to express using getSlice
69+ , breakOn
5070
51− -- *** From streams
71+ -- *** Stream Folds
5272 , ArrayUnsafe (..)
53− , writeNWithUnsafe
54− , writeNWith
55− , writeNUnsafe
56− , pinnedWriteNUnsafe
57− , writeN
58− , pinnedWriteN
59− , pinnedWriteNAligned
60−
61− , writeWith
62− , write
63− , pinnedWrite
64−
65− , writeRevN
66− -- , writeRev
67−
68− -- ** From containers
73+ , unsafeCreateOfWith
74+ , unsafeCreateOf
75+ , unsafePinnedCreateOf
76+ , pinnedCreateOf
77+ , createOfWith
78+ , createOf
79+ , revCreateOf
80+
81+ , pinnedCreate
82+ , createWith
83+ , create
84+ -- , revCreate
85+
86+ -- *** From containers
6987 , fromListN
7088 , pinnedFromListN
7189 , fromList
7290 , pinnedFromList
7391 , fromListRevN
7492 , fromListRev
75− , fromStreamDN
76− , fromStreamD
93+ , fromStreamN
94+ , fromStream
95+ , fromPureStreamN
7796 , fromPureStream
97+ , fromByteStr#
98+ , fromPtrN
99+ , fromChunksK
100+ , fromChunksRealloced -- fromSmallChunks
78101
79− -- * Random writes
102+ -- ** Random writes
80103 , putIndex
81− , putIndexUnsafe
104+ , putIndexUnsafe -- XXX unsafePutIndex
82105 , putIndices
83106 -- , putFromThenTo
84107 -- , putFrom -- start writing at the given position
@@ -86,78 +109,71 @@ module Streamly.Internal.Data.MutArray.Type
86109 -- , putFromTo
87110 -- , putFromRev
88111 -- , putUptoRev
89− , modifyIndexUnsafe
112+ , modifyIndexUnsafe -- XXX unsafeModifyIndex
90113 , modifyIndex
91114 , modifyIndices
92115 , modify
93116 , swapIndices
94117 , unsafeSwapIndices
95118
96− -- * Growing and Shrinking
97− -- Arrays grow only at the end, though it is possible to grow on both sides
98− -- and therefore have a cons as well as snoc. But that will require two
99− -- bounds in the array representation.
100−
101− -- ** Appending elements
102− , snocWith
103− , snoc
104− , snocLinear
105− , snocMay
106− , snocUnsafe
107−
108− -- ** Appending streams
109− , writeAppendNUnsafe
110− , writeAppendN
111− , writeAppendWith
112− , writeAppend
119+ -- ** Reading
113120
114− -- * Eliminating and Reading
115−
116− -- ** To streams
117− , reader
118− , readerRevWith
119− , readerRev
121+ -- *** Indexing
122+ , getIndex
123+ , getIndexUnsafe -- XXX unsafeGetIndex
124+ -- , getFromThenTo
125+ , getIndexRev -- getRevIndex?
126+ , indexReader
127+ , indexReaderWith
120128
121− -- ** To containers
122− , toStreamDWith
123− , toStreamDRevWith
124− , toStreamKWith
125− , toStreamKRevWith
129+ -- *** To Streams
126130 , read
127131 , readRev
132+ , toStreamWith
133+ , toStreamRevWith
128134 , toStreamK
135+ , toStreamKWith
129136 , toStreamKRev
137+ , toStreamKRevWith
138+
139+ -- *** To Containers
130140 , toList
131141
142+ -- *** Unfolds
132143 -- experimental
133144 , producerWith
134145 , producer
135146
136− -- ** Random reads
137− , getIndex
138− , getIndexUnsafe
139− , getIndices
140− , getIndicesD
141− -- , getFromThenTo
142− , getIndexRev
143−
144− -- * Memory Management
145− , blockSize
146− , arrayChunkBytes
147− , allocBytesToElemCount
148− , realloc
149− , resize
150− , resizeExp
151− , rightSize
147+ , reader
148+ , readerRevWith
149+ , readerRev
152150
153− -- * Size
151+ -- ** Size and Capacity
152+ -- *** Size
154153 , length
155154 , byteLength
155+
156+ -- *** Capacity
156157 -- , capacity
157158 , byteCapacity
158159 , bytesFree
159160
160− -- * In-place Mutation Algorithms
161+ -- *** Capacity Management
162+ , blockSize
163+ , arrayChunkBytes
164+ , allocBytesToElemCount
165+ , realloc -- this is "resize"
166+ , grow
167+ , growExp
168+ , rightSize
169+
170+ -- ** Folding
171+ , foldl'
172+ , foldr
173+ , byteCmp
174+ , byteEq
175+
176+ -- ** In-place Mutation Algorithms
161177 , strip
162178 , reverse
163179 , permute
@@ -167,62 +183,121 @@ module Streamly.Internal.Data.MutArray.Type
167183 , mergeBy
168184 , bubble
169185
170− -- * Casting
171− , cast
172− , castUnsafe
173− , asBytes
174− , asPtrUnsafe
175−
176− -- * Folding
177− , foldl'
178− , foldr
179− , cmp
180−
181− -- * Arrays of arrays
182− -- We can add dimensionality parameter to the array type to get
183− -- multidimensional arrays. Multidimensional arrays would just be a
184− -- convenience wrapper on top of single dimensional arrays.
186+ -- ** Growing and Shrinking
187+ -- | Arrays grow only at the end, though it is possible to grow on both
188+ -- sides and therefore have a cons as well as snoc. But that will require
189+ -- both lower and upper bound in the array representation.
185190
186− -- | Operations dealing with multiple arrays, streams of arrays or
187− -- multidimensional array representations.
188−
189− -- ** Construct from streams
190− , chunksOf
191− , pinnedChunksOf
192− , writeChunks
193−
194− -- ** Eliminate to streams
195− , flattenArrays
196− , flattenArraysRev
197− , fromArrayStreamK
191+ -- *** Appending elements
192+ , snocWith
193+ , snoc
194+ , snocLinear
195+ , snocMay
196+ , snocUnsafe -- XXX unsafeSnoc
198197
199− -- ** Construct from arrays
200− -- get chunks without copying
201− , getSliceUnsafe
202− , getSlice
203− -- , getSlicesFromLenN
204− , splitAt -- XXX should be able to express using getSlice
205− , breakOn
198+ -- *** Appending streams
199+ , unsafeAppendN
200+ , appendN
201+ , appendWith
202+ , append
206203
207− -- ** Cloning arrays
208− , clone
209− , pinnedClone
210−
211− -- ** Appending arrays
204+ -- *** Appending arrays
212205 , spliceCopy
213206 , spliceWith
214207 , splice
215208 , spliceExp
216− , spliceUnsafe
209+ , spliceUnsafe -- XXX unsafeSplice
217210 -- , putSlice
218211 -- , appendSlice
219212 -- , appendSliceFrom
220213
221− -- * Utilities
214+ -- ** Serialization using Unbox
215+ , pokeAppend
216+ , pokeAppendMay
217+ , pokeSkipUnsafe -- unsafePokeSkip
218+
219+ -- ** Deserialization using Unbox
220+ , peekUncons
221+ , peekUnconsUnsafe -- unsafePeekUncons
222+ , peekSkipUnsafe -- unsafePeekSkip
223+
224+ -- Arrays of arrays
225+ -- We can add dimensionality parameter to the array type to get
226+ -- multidimensional arrays. Multidimensional arrays would just be a
227+ -- convenience wrapper on top of single dimensional arrays.
228+
229+ -- ** Streams of Arrays
230+ -- *** Chunk
231+ -- | Group a stream into arrays.
232+ , chunksOf
233+ , pinnedChunksOf
234+ , buildChunks
235+
236+ -- *** Split
237+ -- | Split an array into slices.
238+
239+ -- , getSlicesFromLenN
240+ , splitOn
241+ -- , slicesOf
242+
243+ -- *** Concat
244+ -- | Append the arrays in a stream to form a stream of elements.
245+ , concatWith
246+ , concatRevWith
247+ , concat
248+ , concatRev
249+
250+ -- *** Compact
251+ -- | Append the arrays in a stream to form a stream of larger arrays.
252+ , SpliceState (..)
253+ , pCompactLE
254+ , pPinnedCompactLE
255+ , compactLeAs
256+ , fCompactGE
257+ , fPinnedCompactGE
258+ , lCompactGE
259+ , lPinnedCompactGE
260+ , compactGE
261+ , compactEQ
262+
263+ -- ** Utilities
222264 , roundUpToPower2
223265 , memcpy
224266 , memcmp
225267 , c_memchr
268+
269+ -- * Deprecated
270+ , asPtrUnsafe
271+ , writeChunks
272+ , flattenArrays
273+ , flattenArraysRev
274+ , fromArrayStreamK
275+ , fromStreamDN
276+ , fromStreamD
277+ , cmp
278+ , getIndices
279+ , getIndicesWith
280+ , resize
281+ , resizeExp
282+ , nil
283+ , new
284+ , pinnedNew
285+ , pinnedNewBytes
286+ , writeAppendNUnsafe
287+ , writeAppendN
288+ , writeAppendWith
289+ , writeAppend
290+ , writeNWithUnsafe
291+ , writeNWith
292+ , writeNUnsafe
293+ , pinnedWriteNUnsafe
294+ , writeN
295+ , pinnedWriteN
296+ , pinnedWriteNAligned -- XXX not required
297+ , writeWith
298+ , write
299+ , pinnedWrite
300+ , writeRevN
226301 )
227302where
228303
@@ -233,6 +308,7 @@ where
233308
234309import Control.Monad (when, void)
235310import Control.Monad.IO.Class (MonadIO(..))
311+import Data.Bifunctor (first)
236312import Data.Bits (shiftR, (.|.), (.&.))
237313import Data.Functor.Identity (Identity(..))
238314import Data.Proxy (Proxy(..))
@@ -241,7 +317,6 @@ import Foreign.C.Types (CSize(..), CInt(..))
241317import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
242318import Streamly.Internal.Data.MutByteArray.Type
243319 ( MutByteArray(..)
244− , MutableByteArray
245320 , PinnedState(..)
246321 , getMutableByteArray#
247322 , putSliceUnsafe
@@ -254,19 +329,23 @@ import GHC.Base
254329 , copyMutableByteArray#
255330 )
256331import GHC.Base (noinline)
257−import GHC.Exts (unsafeCoerce#)
332+import GHC.Exts (unsafeCoerce#, Addr#)
258333import GHC.Ptr (Ptr(..))
259334
260335import Streamly.Internal.Data.Fold.Type (Fold(..))
261336import Streamly.Internal.Data.Producer.Type (Producer (..))
262337import Streamly.Internal.Data.Stream.Type (Stream)
338+import Streamly.Internal.Data.Parser.Type (Parser (..))
263339import Streamly.Internal.Data.StreamK.Type (StreamK)
264340import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341+import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
265342import Streamly.Internal.Data.Unfold.Type (Unfold(..))
266343import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
267344
268345import qualified Streamly.Internal.Data.Fold.Type as FL
269346import qualified Streamly.Internal.Data.MutByteArray.Type as Unboxed
347+import qualified Streamly.Internal.Data.Parser.Type as Parser
348+-- import qualified Streamly.Internal.Data.Fold.Type as Fold
270349import qualified Streamly.Internal.Data.Producer as Producer
271350import qualified Streamly.Internal.Data.Stream.Type as D
272351import qualified Streamly.Internal.Data.Stream.Lift as D
@@ -274,7 +353,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
274353import qualified Prelude
275354
276355import Prelude hiding
277− (Foldable(..), read, unlines, splitAt, reverse, truncate)
356+ (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
278357
279358#include "DocTestDataMutArray.hs"
280359
@@ -282,6 +361,7 @@ import Prelude hiding
282361-- Foreign helpers
283362-------------------------------------------------------------------------------
284363
364+-- NOTE: Have to be "ccall unsafe" so that we can pass unpinned memory to these
285365foreign import ccall unsafe "string.h memcpy" c_memcpy
286366 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
287367
@@ -291,6 +371,9 @@ foreign import ccall unsafe "string.h memchr" c_memchr
291371foreign import ccall unsafe "string.h memcmp" c_memcmp
292372 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO CInt
293373
374+foreign import ccall unsafe "string.h strlen" c_strlen
375+ :: Ptr Word8 -> IO CSize
376+
294377-- | Given an 'Unboxed' type (unused first arg) and a number of bytes, return
295378-- how many elements of that type will completely fit in those bytes.
296379--
@@ -357,8 +440,8 @@ data MutArray a =
357440-- Pinning & Unpinning
358441-------------------------------------------------------------------------------
359442
360−-- | Copy the 'MutArray' to pinned memory if unpinned, else do nothing. The
361−-- overhead is a copy if the input array is unpinned.
443+-- | Return a copy of the array in pinned memory if unpinned, else return the
444+-- original array.
362445{-# INLINE pin #-}
363446pin :: MutArray a -> IO (MutArray a)
364447pin arr@MutArray{..} =
@@ -366,8 +449,8 @@ pin arr@MutArray{..} =
366449 then pure arr
367450 else pinnedClone arr
368451
369−-- | Copy the 'MutArray' to unpinned memory if pinned, else do nothing. The
370−-- overhead is a copy if the input array is pinned.
452+-- | Return a copy of the array in unpinned memory if pinned, else return the
453+-- original array.
371454{-# INLINE unpin #-}
372455unpin :: MutArray a -> IO (MutArray a)
373456unpin arr@MutArray{..} =
@@ -375,6 +458,7 @@ unpin arr@MutArray{..} =
375458 then clone arr
376459 else pure arr
377460
461+-- | Return 'True' if the array is allocated in pinned memory.
378462{-# INLINE isPinned #-}
379463isPinned :: MutArray a -> Bool
380464isPinned MutArray{..} = Unboxed.isPinned arrContents
@@ -395,6 +479,8 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
395479-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
396480-- allocatePinned in GHC source.
397481
482+-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483+
398484-- | @newArrayWith allocator alignment count@ allocates a new array of zero
399485-- length and with a capacity to hold @count@ elements, using @allocator
400486-- size alignment@ as the memory allocator function.
@@ -418,12 +504,25 @@ newArrayWith alloc alignSize count = do
418504 , arrBound = size
419505 }
420506
507+-- For arrays "nil" sounds a bit odd. empty is better. The only problem with
508+-- empty is that it is also used by the Alternative type class. But assuming we
509+-- will mostly import the Array module qualified this should be fine.
510+
511+-- | Create an empty array.
512+empty ::
513+#ifdef DEVBUILD
514+ Unbox a =>
515+#endif
516+ MutArray a
517+empty = MutArray Unboxed.empty 0 0 0
518+
519+{-# DEPRECATED nil "Please use empty instead." #-}
421520nil ::
422521#ifdef DEVBUILD
423522 Unbox a =>
424523#endif
425524 MutArray a
426−nil = MutArray Unboxed.nil 0 0 0
525+nil = empty
427526
428527{-# INLINE newBytesAs #-}
429528newBytesAs :: MonadIO m =>
@@ -440,12 +539,13 @@ newBytesAs ps bytes = do
440539 , arrBound = bytes
441540 }
442541
443−-- | Allocates a pinned empty array that can hold 'count' items. The memory of
444−-- the array is uninitialized and the allocation is aligned as per the
445−-- 'Unboxed' instance of the type.
542+-- | Allocates a pinned empty array that with a reserved capacity of bytes.
543+-- The memory of the array is uninitialized and the allocation is aligned as
544+-- per the 'Unboxed' instance of the type.
446545--
447546-- /Pre-release/
448547{-# INLINE pinnedNewBytes #-}
548+{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
449549pinnedNewBytes :: MonadIO m =>
450550#ifdef DEVBUILD
451551 Unbox a =>
@@ -470,21 +570,31 @@ newAs ps =
470570 (error "new: alignment is not used in unpinned arrays.")
471571
472572-- XXX can unaligned allocation be more efficient when alignment is not needed?
473−--
474−-- | Allocates an empty pinned array that can hold 'count' items. The memory of
475−-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
476−-- instance of the type.
477−--
573+
574+-- | Allocates a pinned array of zero length but growable to the specified
575+-- capacity without reallocation.
576+{-# INLINE pinnedEmptyOf #-}
577+pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
578+pinnedEmptyOf = newAs Pinned
579+
580+-- XXX Deprecate in major
581+-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
478582{-# INLINE pinnedNew #-}
479583pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
480−pinnedNew = newAs Pinned
584+pinnedNew = pinnedEmptyOf
481585
482−-- | Allocates an empty unpinned array that can hold 'count' items. The memory
483−-- of the array is uninitialized.
586+-- | Allocates an unpinned array of zero length but growable to the specified
587+-- capacity without reallocation.
484588--
589+{-# INLINE emptyOf #-}
590+emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591+emptyOf = newAs Unpinned
592+
593+-- XXX Deprecate in major
594+-- {-# DEPRECATED new "Please use emptyOf instead." #-}
485595{-# INLINE new #-}
486596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
487−new = newAs Unpinned
597+new = emptyOf
488598
489599-------------------------------------------------------------------------------
490600-- Random writes
@@ -500,7 +610,7 @@ putIndexUnsafe :: forall m a. (MonadIO m, Unbox a)
500610putIndexUnsafe i MutArray{..} x = do
501611 let index = INDEX_OF(arrStart, i, a)
502612 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
503− liftIO $ pokeByteIndex index arrContents x
613+ liftIO $ pokeAt index arrContents x
504614
505615invalidIndex :: String -> Int -> a
506616invalidIndex label i =
@@ -518,7 +628,7 @@ putIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m ()
518628putIndex i MutArray{..} x = do
519629 let index = INDEX_OF(arrStart,i,a)
520630 if i >= 0 && INDEX_VALID(index,arrEnd,a)
521− then liftIO $ pokeByteIndex index arrContents x
631+ then liftIO $ pokeAt index arrContents x
522632 else invalidIndex "putIndex" i
523633
524634-- | Write an input stream of (index, value) pairs to an array. Throws an
@@ -532,7 +642,7 @@ putIndices arr = FL.foldlM' step (return ())
532642
533643 where
534644
535− step () (i, x) = liftIO (putIndex i arr x)
645+ step () (i, x) = putIndex i arr x
536646
537647-- | Modify a given index of an array using a modifier function.
538648--
@@ -544,9 +654,9 @@ modifyIndexUnsafe :: forall m a b. (MonadIO m, Unbox a) =>
544654modifyIndexUnsafe i MutArray{..} f = liftIO $ do
545655 let index = INDEX_OF(arrStart,i,a)
546656 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
547− r <- peekByteIndex index arrContents
657+ r <- peekAt index arrContents
548658 let (x, res) = f r
549− pokeByteIndex index arrContents x
659+ pokeAt index arrContents x
550660 return res
551661
552662-- | Modify a given index of an array using a modifier function.
@@ -558,9 +668,9 @@ modifyIndex i MutArray{..} f = do
558668 let index = INDEX_OF(arrStart,i,a)
559669 if i >= 0 && INDEX_VALID(index,arrEnd,a)
560670 then liftIO $ do
561− r <- peekByteIndex index arrContents
671+ r <- peekAt index arrContents
562672 let (x, res) = f r
563− pokeByteIndex index arrContents x
673+ pokeAt index arrContents x
564674 return res
565675 else invalidIndex "modifyIndex" i
566676
@@ -594,8 +704,8 @@ modify MutArray{..} f = liftIO $
594704
595705 go i =
596706 when (INDEX_VALID(i,arrEnd,a)) $ do
597− r <- peekByteIndex i arrContents
598− pokeByteIndex i arrContents (f r)
707+ r <- peekAt i arrContents
708+ pokeAt i arrContents (f r)
599709 go (INDEX_NEXT(i,a))
600710
601711-- XXX We could specify the number of bytes to swap instead of Proxy. Need
@@ -609,10 +719,10 @@ swapArrayByteIndices ::
609719 -> Int
610720 -> IO ()
611721swapArrayByteIndices _ arrContents i1 i2 = do
612− r1 <- peekByteIndex i1 arrContents
613− r2 <- peekByteIndex i2 arrContents
614− pokeByteIndex i1 arrContents (r2 :: a)
615− pokeByteIndex i2 arrContents (r1 :: a)
722+ r1 <- peekAt i1 arrContents
723+ r2 <- peekAt i2 arrContents
724+ pokeAt i1 arrContents (r2 :: a)
725+ pokeAt i2 arrContents (r1 :: a)
616726
617727-- | Swap the elements at two indices without validating the indices.
618728--
@@ -728,24 +838,21 @@ arrayChunkBytes = 1024
728838roundDownTo :: Int -> Int -> Int
729839roundDownTo elemSize size = size - (size `mod` elemSize)
730840
731−-- XXX See if resizing can be implemented by reading the old array as a stream
732−-- and then using writeN to the new array.
733−--
734841-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
735842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
736843-- which complicates some inspection tests.
737844--
738−{-# NOINLINE reallocExplicit #-}
739−reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
740−reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
845+{-# NOINLINE reallocExplicitAs #-}
846+reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847+reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
741848 assertM(arrEnd <= arrBound)
742849
743850 -- Allocate new array
744851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
745852 contents <-
746− if Unboxed.isPinned arrContents
747− then Unboxed.pinnedNewByteArray newCapMaxInBytes
748− else Unboxed.newByteArray newCapMaxInBytes
853+ if ps == Pinned
854+ then Unboxed.pinnedNew newCapMaxInBytes
855+ else Unboxed.new newCapMaxInBytes
749856 let !(MutByteArray mbarrFrom#) = arrContents
750857 !(MutByteArray mbarrTo#) = contents
751858
@@ -768,6 +875,10 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
768875 , arrBound = newCapInBytes
769876 }
770877
878+-- XXX Should these be called reallocBytes etc?
879+-- XXX We may also need reallocAs to allocate as pinned/unpinned explicitly. In
880+-- fact clone/pinnedClone can be implemented using reallocAs.
881+
771882-- | @realloc newCapacity array@ reallocates the array to the specified
772883-- capacity in bytes.
773884--
@@ -779,7 +890,12 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
779890-- If the original array is pinned, the newly allocated array is also pinned.
780891{-# INLINABLE realloc #-}
781892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
782−realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
893+realloc bytes arr =
894+ let ps =
895+ if isPinned arr
896+ then Pinned
897+ else Unpinned
898+ in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
783899
784900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
785901-- in error messages and the capSizer is used to determine the capacity of the
@@ -802,14 +918,14 @@ reallocWith label capSizer minIncrBytes arr = do
802918 where
803919
804920 badSize newSize =
805− concat
921+ Prelude.concat
806922 [ label
807923 , ": new array size (in bytes) is less than required size "
808924 , show newSize
809925 , ". Please check the sizing function passed."
810926 ]
811927
812−-- | @resize newCapacity array@ changes the total capacity of the array so that
928+-- | @grow newCapacity array@ changes the total capacity of the array so that
813929-- it is enough to hold the specified number of elements. Nothing is done if
814930-- the specified capacity is less than the length of the array.
815931--
@@ -817,34 +933,46 @@ reallocWith label capSizer minIncrBytes arr = do
817933-- the block size (4K).
818934--
819935-- /Pre-release/
820−{-# INLINE resize #-}
821−resize :: forall m a. (MonadIO m, Unbox a) =>
936+{-# INLINE grow #-}
937+grow :: forall m a. (MonadIO m, Unbox a) =>
822938 Int -> MutArray a -> m (MutArray a)
823−resize nElems arr@MutArray{..} = do
939+grow nElems arr@MutArray{..} = do
824940 let req = SIZE_OF(a) * nElems
825− len = arrEnd - arrStart
826− if req < len
941+ cap = arrBound - arrStart
942+ if req < cap
827943 then return arr
828944 else realloc req arr
829945
830−-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
831−-- then it is rounded up to the closest power of 2.
946+{-# DEPRECATED resize "Please use grow instead." #-}
947+{-# INLINE resize #-}
948+resize :: forall m a. (MonadIO m, Unbox a) =>
949+ Int -> MutArray a -> m (MutArray a)
950+resize = grow
951+
952+-- | Like 'grow' but if the requested byte capacity is more than
953+-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
832954--
833955-- /Pre-release/
834−{-# INLINE resizeExp #-}
835−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
956+{-# INLINE growExp #-}
957+growExp :: forall m a. (MonadIO m, Unbox a) =>
836958 Int -> MutArray a -> m (MutArray a)
837−resizeExp nElems arr@MutArray{..} = do
959+growExp nElems arr@MutArray{..} = do
838960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
839961 req1 =
840962 if req > largeObjectThreshold
841963 then roundUpToPower2 req
842964 else req
843− len = arrEnd - arrStart
844− if req1 < len
965+ cap = arrBound - arrStart
966+ if req1 < cap
845967 then return arr
846968 else realloc req1 arr
847969
970+{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971+{-# INLINE resizeExp #-}
972+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973+ Int -> MutArray a -> m (MutArray a)
974+resizeExp = growExp
975+
848976-- | Resize the allocated memory to drop any reserved free space at the end of
849977-- the array and reallocate it to reduce wastage.
850978--
@@ -889,7 +1017,7 @@ rightSize arr@MutArray{..} = do
8891017snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
8901018snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
8911019 assert (newEnd <= arrBound) (return ())
892− pokeByteIndex arrEnd arrContents x
1020+ pokeAt arrEnd arrContents x
8931021 return $ arr {arrEnd = newEnd}
8941022
8951023-- | Really really unsafe, appends the element into the first array, may
@@ -909,7 +1037,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
9091037{-# INLINE snocMay #-}
9101038snocMay :: forall m a. (MonadIO m, Unbox a) =>
9111039 MutArray a -> a -> m (Maybe (MutArray a))
912−snocMay arr@MutArray{..} x = liftIO $ do
1040+snocMay arr@MutArray{..} x = do
9131041 let newEnd = INDEX_NEXT(arrEnd,a)
9141042 if newEnd <= arrBound
9151043 then Just <$> snocNewEnd newEnd arr x
@@ -923,7 +1051,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
9231051 -> a
9241052 -> m (MutArray a)
9251053snocWithRealloc sizer arr x = do
926− arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1054+ arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
9271055 snocUnsafe arr1 x
9281056
9291057-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -945,7 +1073,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
9451073 -> MutArray a
9461074 -> a
9471075 -> m (MutArray a)
948−snocWith allocSize arr x = liftIO $ do
1076+snocWith allocSize arr x = do
9491077 let newEnd = INDEX_NEXT(arrEnd arr,a)
9501078 if newEnd <= arrBound arr
9511079 then snocNewEnd newEnd arr x
@@ -989,6 +1117,126 @@ snoc = snocWith f
9891117 then oldSize * 2
9901118 else roundUpToPower2 oldSize * 2
9911119
1120+-------------------------------------------------------------------------------
1121+-- Serialization/Deserialization
1122+-------------------------------------------------------------------------------
1123+
1124+{-# INLINE pokeNewEnd #-}
1125+pokeNewEnd :: (MonadIO m, Unbox a) =>
1126+ Int -> MutArray Word8 -> a -> m (MutArray Word8)
1127+pokeNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1128+ assert (newEnd <= arrBound) (return ())
1129+ liftIO $ pokeAt arrEnd arrContents x
1130+ return $ arr {arrEnd = newEnd}
1131+
1132+-- | Really really unsafe, unboxes a Haskell type and appends the resulting
1133+-- bytes to the byte array, may cause silent data corruption or if you are
1134+-- lucky a segfault if the array does not have enough space to append the
1135+-- element.
1136+--
1137+-- /Internal/
1138+{-# INLINE pokeAppendUnsafe #-}
1139+pokeAppendUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1140+ MutArray Word8 -> a -> m (MutArray Word8)
1141+pokeAppendUnsafe arr@MutArray{..} = pokeNewEnd (arrEnd + SIZE_OF(a)) arr
1142+
1143+-- | Skip the specified number of bytes in the array. The data in the skipped
1144+-- region remains uninitialzed.
1145+{-# INLINE pokeSkipUnsafe #-}
1146+pokeSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1147+pokeSkipUnsafe n arr@MutArray{..} = do
1148+ let newEnd = arrEnd + n
1149+ in assert (newEnd <= arrBound) (arr {arrEnd = newEnd})
1150+
1151+-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152+-- capacity becomes full.
1153+--
1154+-- /Internal/
1155+{-# INLINE pokeAppendMay #-}
1156+pokeAppendMay :: forall m a. (MonadIO m, Unbox a) =>
1157+ MutArray Word8 -> a -> m (Maybe (MutArray Word8))
1158+pokeAppendMay arr@MutArray{..} x = liftIO $ do
1159+ let newEnd = arrEnd + SIZE_OF(a)
1160+ if newEnd <= arrBound
1161+ then Just <$> pokeNewEnd newEnd arr x
1162+ else return Nothing
1163+
1164+{-# NOINLINE pokeWithRealloc #-}
1165+pokeWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1166+ (Int -> Int)
1167+ -> MutArray Word8
1168+ -> a
1169+ -> m (MutArray Word8)
1170+pokeWithRealloc sizer arr x = do
1171+ arr1 <- liftIO $ reallocWith "pokeWithRealloc" sizer (SIZE_OF(a)) arr
1172+ pokeAppendUnsafe arr1 x
1173+
1174+{-# INLINE pokeAppendWith #-}
1175+pokeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1176+ (Int -> Int)
1177+ -> MutArray Word8
1178+ -> a
1179+ -> m (MutArray Word8)
1180+pokeAppendWith allocSize arr x = liftIO $ do
1181+ let newEnd = arrEnd arr + SIZE_OF(a)
1182+ if newEnd <= arrBound arr
1183+ then pokeNewEnd newEnd arr x
1184+ else pokeWithRealloc allocSize arr x
1185+
1186+-- | Unbox a Haskell type and append the resulting bytes to a mutable byte
1187+-- array. The array is grown exponentially when more space is needed.
1188+--
1189+-- Definition:
1190+--
1191+-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1192+--
1193+{-# INLINE pokeAppend #-}
1194+pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195+ MutArray Word8 -> a -> m (MutArray Word8)
1196+pokeAppend = pokeAppendWith f
1197+
1198+ where
1199+
1200+ f oldSize =
1201+ if isPower2 oldSize
1202+ then oldSize * 2
1203+ else roundUpToPower2 oldSize * 2
1204+
1205+-- | Really really unsafe, create a Haskell value from an unboxed byte array,
1206+-- does not check if the array is big enough, may return garbage or if you are
1207+-- lucky may cause a segfault.
1208+--
1209+-- /Internal/
1210+{-# INLINE peekUnconsUnsafe #-}
1211+peekUnconsUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1212+ MutArray Word8 -> m (a, MutArray Word8)
1213+peekUnconsUnsafe MutArray{..} = do
1214+ let start1 = arrStart + SIZE_OF(a)
1215+ assert (start1 <= arrEnd) (return ())
1216+ liftIO $ do
1217+ r <- peekAt arrStart arrContents
1218+ return (r, MutArray arrContents start1 arrEnd arrBound)
1219+
1220+-- | Discard the specified number of bytes in the array.
1221+{-# INLINE peekSkipUnsafe #-}
1222+peekSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1223+peekSkipUnsafe n MutArray{..} =
1224+ let start1 = arrStart + n
1225+ in assert (start1 <= arrEnd) (MutArray arrContents start1 arrEnd arrBound)
1226+
1227+-- | Create a Haskell value from its unboxed representation from the head of a
1228+-- byte array, return the value and the remaining array.
1229+{-# INLINE peekUncons #-}
1230+peekUncons :: forall m a. (MonadIO m, Unbox a) =>
1231+ MutArray Word8 -> m (Maybe a, MutArray Word8)
1232+peekUncons arr@MutArray{..} = do
1233+ let start1 = arrStart + SIZE_OF(a)
1234+ if start1 > arrEnd
1235+ then return (Nothing, arr)
1236+ else liftIO $ do
1237+ r <- peekAt arrStart arrContents
1238+ return (Just r, MutArray arrContents start1 arrEnd arrBound)
1239+
9921240-------------------------------------------------------------------------------
9931241-- Random reads
9941242-------------------------------------------------------------------------------
@@ -1003,7 +1251,7 @@ getIndexUnsafe :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
10031251getIndexUnsafe i MutArray{..} = do
10041252 let index = INDEX_OF(arrStart,i,a)
10051253 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
1006− liftIO $ peekByteIndex index arrContents
1254+ liftIO $ peekAt index arrContents
10071255
10081256-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
10091257--
@@ -1012,7 +1260,7 @@ getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (Maybe a)
10121260getIndex i MutArray{..} = do
10131261 let index = INDEX_OF(arrStart,i,a)
10141262 if i >= 0 && INDEX_VALID(index,arrEnd,a)
1015− then liftIO $ Just <$> peekByteIndex index arrContents
1263+ then liftIO $ Just <$> peekAt index arrContents
10161264 else return Nothing
10171265
10181266-- | /O(1)/ Lookup the element at the given index from the end of the array.
@@ -1025,21 +1273,16 @@ getIndexRev :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
10251273getIndexRev i MutArray{..} = do
10261274 let index = RINDEX_OF(arrEnd,i,a)
10271275 if i >= 0 && index >= arrStart
1028− then liftIO $ peekByteIndex index arrContents
1276+ then liftIO $ peekAt index arrContents
10291277 else invalidIndex "getIndexRev" i
10301278
10311279data GetIndicesState contents start end st =
10321280 GetIndicesState contents start end st
10331281
1034−-- | Given an unfold that generates array indices, read the elements on those
1035−-- indices from the supplied MutArray. An error is thrown if an index is out of
1036−-- bounds.
1037−--
1038−-- /Pre-release/
1039−{-# INLINE getIndicesD #-}
1040−getIndicesD :: (Monad m, Unbox a) =>
1282+{-# INLINE indexReaderWith #-}
1283+indexReaderWith :: (Monad m, Unbox a) =>
10411284 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1042−getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
1285+indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
10431286
10441287 where
10451288
@@ -1058,9 +1301,26 @@ getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
10581301 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
10591302 D.Stop -> return D.Stop
10601303
1304+{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305+{-# INLINE getIndicesWith #-}
1306+getIndicesWith :: (Monad m, Unbox a) =>
1307+ (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1308+getIndicesWith = indexReaderWith
1309+
1310+-- | Given an unfold that generates array indices, read the elements on those
1311+-- indices from the supplied MutArray. An error is thrown if an index is out of
1312+-- bounds.
1313+--
1314+-- /Pre-release/
1315+{-# INLINE indexReader #-}
1316+indexReader :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1317+indexReader = indexReaderWith liftIO
1318+
1319+-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320+{-# DEPRECATED getIndices "Please use indexReader instead." #-}
10611321{-# INLINE getIndices #-}
10621322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1063−getIndices = getIndicesD liftIO
1323+getIndices = indexReader
10641324
10651325-------------------------------------------------------------------------------
10661326-- Subarrays
@@ -1165,7 +1425,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
11651425
11661426 -- Invariant low < high on entry, and on return as well
11671427 moveHigh low high = do
1168− h <- peekByteIndex high arrContents
1428+ h <- peekAt high arrContents
11691429 if f h
11701430 then
11711431 -- Correctly classified, continue the loop
@@ -1185,7 +1445,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
11851445 -- low <= high
11861446 -- Both low and high are valid locations within the array
11871447 go low high = do
1188− l <- peekByteIndex low arrContents
1448+ l <- peekAt low arrContents
11891449 if f l
11901450 then
11911451 -- low is wrongly classified
@@ -1196,8 +1456,8 @@ partitionBy f arr@MutArray{..} = liftIO $ do
11961456 case r of
11971457 Nothing -> return low
11981458 Just (high1, h) -> do -- low < high1
1199− pokeByteIndex low arrContents h
1200− pokeByteIndex high1 arrContents l
1459+ pokeAt low arrContents h
1460+ pokeAt high1 arrContents l
12011461 let low1 = INDEX_NEXT(low,a)
12021462 high2 = INDEX_PREV(high1,a)
12031463 if low1 <= high2
@@ -1331,7 +1591,7 @@ chunksOfAs ps n (D.Stream step state) =
13311591 r <- step (adaptState gst) st
13321592 case r of
13331593 D.Yield x s -> do
1334− liftIO $ pokeByteIndex end contents x
1594+ liftIO $ pokeAt end contents x
13351595 let end1 = INDEX_NEXT(end,a)
13361596 return $
13371597 if end1 >= bound
@@ -1355,7 +1615,7 @@ chunksOfAs ps n (D.Stream step state) =
13551615--
13561616-- Same as the following but may be more efficient:
13571617--
1358−-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
1618+-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
13591619--
13601620-- /Pre-release/
13611621{-# INLINE_NORMAL chunksOf #-}
@@ -1364,17 +1624,29 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
13641624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
13651625-- benchmark. It seems it has difficulty producing optimized code when
13661626-- converting to StreamK. Investigate GHC optimizations.
1367−-- chunksOf n = D.foldMany (writeN n)
1627+-- chunksOf n = D.foldMany (createOf n)
13681628chunksOf = chunksOfAs Unpinned
13691629
13701630-- | Like 'chunksOf' but creates pinned arrays.
13711631{-# INLINE_NORMAL pinnedChunksOf #-}
13721632pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
13731633 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1374−-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
1634+-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
13751635pinnedChunksOf = chunksOfAs Pinned
13761636
1377−-- XXX This should take a PinnedState
1637+-- | When we are buffering a stream of unknown size into an array we do not
1638+-- know how much space to pre-allocate. So we start with the min size and emit
1639+-- the array then keep on doubling the size every time. Thus we do not need to
1640+-- guess the optimum chunk size.
1641+--
1642+-- We can incorporate this in chunksOfAs if the additional size parameter does
1643+-- not impact perf.
1644+--
1645+{-# INLINE _chunksOfRange #-}
1646+_chunksOfRange :: -- (MonadIO m, Unbox a) =>
1647+ PinnedState -> Int -> Int -> D.Stream m a -> D.Stream m (MutArray a)
1648+_chunksOfRange _ps _low _hi = undefined
1649+
13781650-- XXX buffer to a list instead?
13791651-- | Buffer the stream into arrays in memory.
13801652{-# INLINE arrayStreamKFromStreamDAs #-}
@@ -1392,16 +1664,10 @@ data FlattenState s contents a =
13921664 OuterLoop s
13931665 | InnerLoop s contents !Int !Int
13941666
1395−-- | Use the "reader" unfold instead.
1396−--
1397−-- @flattenArrays = unfoldMany reader@
1398−--
1399−-- We can try this if there are any fusion issues in the unfold.
1400−--
1401−{-# INLINE_NORMAL flattenArrays #-}
1402−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1403− => D.Stream m (MutArray a) -> D.Stream m a
1404−flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
1667+{-# INLINE_NORMAL concatWith #-}
1668+concatWith :: forall m a. (Monad m, Unbox a)
1669+ => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1670+concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
14051671
14061672 where
14071673
@@ -1418,19 +1684,30 @@ flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
14181684 return $ D.Skip $ OuterLoop st
14191685
14201686 step' _ (InnerLoop st contents p end) = do
1421− x <- liftIO $ peekByteIndex p contents
1687+ x <- liftio $ peekAt p contents
14221688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
14231689
1424−-- | Use the "readerRev" unfold instead.
1690+-- | Use the "reader" unfold instead.
14251691--
1426−-- @flattenArrays = unfoldMany readerRev@
1692+-- @concat = unfoldMany reader@
14271693--
14281694-- We can try this if there are any fusion issues in the unfold.
14291695--
1430−{-# INLINE_NORMAL flattenArraysRev #-}
1431−flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1696+{-# INLINE_NORMAL concat #-}
1697+concat :: forall m a. (MonadIO m, Unbox a)
14321698 => D.Stream m (MutArray a) -> D.Stream m a
1433−flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
1699+concat = concatWith liftIO
1700+
1701+{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702+{-# INLINE flattenArrays #-}
1703+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704+ => D.Stream m (MutArray a) -> D.Stream m a
1705+flattenArrays = concat
1706+
1707+{-# INLINE_NORMAL concatRevWith #-}
1708+concatRevWith :: forall m a. (Monad m, Unbox a)
1709+ => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1710+concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
14341711
14351712 where
14361713
@@ -1448,10 +1725,27 @@ flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
14481725 return $ D.Skip $ OuterLoop st
14491726
14501727 step' _ (InnerLoop st contents p start) = do
1451− x <- liftIO $ peekByteIndex p contents
1728+ x <- liftio $ peekAt p contents
14521729 let cur = INDEX_PREV(p,a)
14531730 return $ D.Yield x (InnerLoop st contents cur start)
14541731
1732+-- | Use the "readerRev" unfold instead.
1733+--
1734+-- @concat = unfoldMany readerRev@
1735+--
1736+-- We can try this if there are any fusion issues in the unfold.
1737+--
1738+{-# INLINE_NORMAL concatRev #-}
1739+concatRev :: forall m a. (MonadIO m, Unbox a)
1740+ => D.Stream m (MutArray a) -> D.Stream m a
1741+concatRev = concatRevWith liftIO
1742+
1743+{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744+{-# INLINE flattenArraysRev #-}
1745+flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1746+ => D.Stream m (MutArray a) -> D.Stream m a
1747+flattenArraysRev = concatRev
1748+
14551749-------------------------------------------------------------------------------
14561750-- Unfolds
14571751-------------------------------------------------------------------------------
@@ -1487,7 +1781,7 @@ producerWith liftio = Producer step (return . toArrayUnsafe) extract
14871781 -- few actions for correctness and execution order sanity. We want
14881782 -- the peek to occur right here and not lazily at some later point
14891783 -- because we want the peek to be ordered with respect to the touch.
1490− !x <- liftio $ peekByteIndex cur contents
1784+ !x <- liftio $ peekAt cur contents
14911785 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
14921786
14931787 extract = return . fromArrayUnsafe
@@ -1518,7 +1812,7 @@ readerRevWith liftio = Unfold step inject
15181812 {-# INLINE_LATE step #-}
15191813 step (ArrayUnsafe _ start p) | p < start = return D.Stop
15201814 step (ArrayUnsafe contents start p) = do
1521− !x <- liftio $ peekByteIndex p contents
1815+ !x <- liftio $ peekAt p contents
15221816 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
15231817
15241818-- | Unfold an array into a stream in reverse order.
@@ -1549,7 +1843,7 @@ toListFB c n MutArray{..} = go arrStart
15491843 -- evaluated/written to before we peek at them.
15501844 -- XXX
15511845 let !x = unsafeInlineIO $ do
1552− r <- peekByteIndex arrContents p
1846+ r <- peekAt arrContents p
15531847 return r
15541848 in c x (go (PTR_NEXT(p,a)))
15551849-}
@@ -1566,21 +1860,21 @@ toList MutArray{..} = liftIO $ go arrStart
15661860
15671861 go p | assert (p <= arrEnd) (p == arrEnd) = return []
15681862 go p = do
1569− x <- peekByteIndex p arrContents
1863+ x <- peekAt p arrContents
15701864 (:) x <$> go (INDEX_NEXT(p,a))
15711865
1572−{-# INLINE_NORMAL toStreamDWith #-}
1573−toStreamDWith ::
1866+{-# INLINE_NORMAL toStreamWith #-}
1867+toStreamWith ::
15741868 forall m a. (Monad m, Unbox a)
15751869 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1576−toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1870+toStreamWith liftio MutArray{..} = D.Stream step arrStart
15771871
15781872 where
15791873
15801874 {-# INLINE_LATE step #-}
15811875 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
15821876 step _ p = liftio $ do
1583− r <- peekByteIndex p arrContents
1877+ r <- peekAt p arrContents
15841878 return $ D.Yield r (INDEX_NEXT(p,a))
15851879
15861880-- | Convert a 'MutArray' into a stream.
@@ -1589,7 +1883,7 @@ toStreamDWith liftio MutArray{..} = D.Stream step arrStart
15891883--
15901884{-# INLINE_NORMAL read #-}
15911885read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1592−read = toStreamDWith liftIO
1886+read = toStreamWith liftIO
15931887
15941888{-# INLINE toStreamKWith #-}
15951889toStreamKWith ::
@@ -1601,18 +1895,18 @@ toStreamKWith liftio MutArray{..} = go arrStart
16011895
16021896 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
16031897 | otherwise =
1604− let elemM = peekByteIndex p arrContents
1898+ let elemM = peekAt p arrContents
16051899 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
16061900
16071901{-# INLINE toStreamK #-}
16081902toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
16091903toStreamK = toStreamKWith liftIO
16101904
1611−{-# INLINE_NORMAL toStreamDRevWith #-}
1612−toStreamDRevWith ::
1905+{-# INLINE_NORMAL toStreamRevWith #-}
1906+toStreamRevWith ::
16131907 forall m a. (Monad m, Unbox a)
16141908 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1615−toStreamDRevWith liftio MutArray{..} =
1909+toStreamRevWith liftio MutArray{..} =
16161910 let p = INDEX_PREV(arrEnd,a)
16171911 in D.Stream step p
16181912
@@ -1621,7 +1915,7 @@ toStreamDRevWith liftio MutArray{..} =
16211915 {-# INLINE_LATE step #-}
16221916 step _ p | p < arrStart = return D.Stop
16231917 step _ p = liftio $ do
1624− r <- peekByteIndex p arrContents
1918+ r <- peekAt p arrContents
16251919 return $ D.Yield r (INDEX_PREV(p,a))
16261920
16271921-- | Convert a 'MutArray' into a stream in reverse order.
@@ -1630,7 +1924,7 @@ toStreamDRevWith liftio MutArray{..} =
16301924--
16311925{-# INLINE_NORMAL readRev #-}
16321926readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1633−readRev = toStreamDRevWith liftIO
1927+readRev = toStreamRevWith liftIO
16341928
16351929{-# INLINE toStreamKRevWith #-}
16361930toStreamKRevWith ::
@@ -1644,7 +1938,7 @@ toStreamKRevWith liftio MutArray {..} =
16441938
16451939 go p | p < arrStart = K.nil
16461940 | otherwise =
1647− let elemM = peekByteIndex p arrContents
1941+ let elemM = peekAt p arrContents
16481942 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
16491943
16501944{-# INLINE toStreamKRev #-}
@@ -1679,7 +1973,7 @@ foldr f z arr = D.foldr f z $ read arr
16791973
16801974-- XXX Keep the bound intact to not lose any free space? Perf impact?
16811975
1682−-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
1976+-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
16831977-- array.
16841978--
16851979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1688,13 +1982,12 @@ foldr f z arr = D.foldr f z $ read arr
16881982-- Any free space left in the array after appending @n@ elements is lost.
16891983--
16901984-- /Internal/
1691−{-# INLINE_NORMAL writeAppendNUnsafe #-}
1692−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1985+{-# INLINE_NORMAL unsafeAppendN #-}
1986+unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
16931987 Int
16941988 -> m (MutArray a)
16951989 -> Fold m a (MutArray a)
1696−writeAppendNUnsafe n action =
1697− fmap fromArrayUnsafe $ FL.foldlM' step initial
1990+unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
16981991
16991992 where
17001993
@@ -1707,38 +2000,59 @@ writeAppendNUnsafe n action =
17072000 -- otherwise we lose that space.
17082001 arr1 <-
17092002 if free < needed
1710− then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2003+ then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
17112004 else return arr
17122005 return $ toArrayUnsafe arr1
17132006
17142007 step (ArrayUnsafe contents start end) x = do
1715− liftIO $ pokeByteIndex end contents x
2008+ liftIO $ pokeAt end contents x
17162009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
17172010
2011+{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012+{-# INLINE writeAppendNUnsafe #-}
2013+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2014+ Int
2015+ -> m (MutArray a)
2016+ -> Fold m a (MutArray a)
2017+writeAppendNUnsafe = unsafeAppendN
2018+
17182019-- | Append @n@ elements to an existing array. Any free space left in the array
17192020-- after appending @n@ elements is lost.
17202021--
1721−-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2022+-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
17222023--
1723−{-# INLINE_NORMAL writeAppendN #-}
2024+{-# INLINE_NORMAL appendN #-}
2025+appendN :: forall m a. (MonadIO m, Unbox a) =>
2026+ Int -> m (MutArray a) -> Fold m a (MutArray a)
2027+appendN n initial = FL.take n (unsafeAppendN n initial)
2028+
2029+-- XXX Deprecate in major
2030+-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031+{-# INLINE writeAppendN #-}
17242032writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
17252033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1726−writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2034+writeAppendN = appendN
17272035
1728−-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2036+-- | @appendWith realloc action@ mutates the array generated by @action@ to
17292037-- append the input stream. If there is no reserved space available in the
17302038-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
17312039-- where @oldSize@ is the current size of the array in bytes.
17322040--
17332041-- Note that the returned array may be a mutated version of original array.
17342042--
1735−-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2043+-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
17362044--
17372045-- /Pre-release/
2046+{-# INLINE appendWith #-}
2047+appendWith :: forall m a. (MonadIO m, Unbox a) =>
2048+ (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2049+appendWith sizer = FL.foldlM' (snocWith sizer)
2050+
2051+{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
17382052{-# INLINE writeAppendWith #-}
17392053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
17402054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1741−writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2055+writeAppendWith = appendWith
17422056
17432057-- | @append action@ mutates the array generated by @action@ to append the
17442058-- input stream. If there is no reserved space available in the array it is
@@ -1746,70 +2060,101 @@ writeAppendWith sizer = FL.foldlM' (snocWith sizer)
17462060--
17472061-- Note that the returned array may be a mutated version of original array.
17482062--
1749−-- >>> writeAppend = MutArray.writeAppendWith (* 2)
2063+-- >>> append = MutArray.appendWith (* 2)
17502064--
2065+{-# INLINE append #-}
2066+append :: forall m a. (MonadIO m, Unbox a) =>
2067+ m (MutArray a) -> Fold m a (MutArray a)
2068+append = appendWith (* 2)
2069+
2070+-- XXX Deprecate in major
2071+-- {-# DEPRECATED writeAppend "Please use append instead." #-}
17512072{-# INLINE writeAppend #-}
17522073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
17532074 m (MutArray a) -> Fold m a (MutArray a)
1754−writeAppend = writeAppendWith (* 2)
2075+writeAppend = append
17552076
17562077-- XXX We can carry bound as well in the state to make sure we do not lose the
17572078-- remaining capacity. Need to check perf impact.
17582079--
1759−-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1760−-- as argument.
2080+-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081+-- function as argument.
17612082--
1762−-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2083+-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
17632084--
17642085-- /Pre-release/
1765−{-# INLINE_NORMAL writeNWithUnsafe #-}
1766−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2086+{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087+unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
17672088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1768−writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2089+unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
17692090
17702091 where
17712092
17722093 initial = toArrayUnsafe <$> alloc (max n 0)
17732094
17742095 step (ArrayUnsafe contents start end) x = do
1775− liftIO $ pokeByteIndex end contents x
2096+ liftIO $ pokeAt end contents x
17762097 return
17772098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
17782099
2100+{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101+{-# INLINE writeNWithUnsafe #-}
2102+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103+ => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104+writeNWithUnsafe = unsafeCreateOfWith
2105+
17792106{-# INLINE_NORMAL writeNUnsafeAs #-}
17802107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
17812108 => PinnedState -> Int -> Fold m a (MutArray a)
1782−writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
2109+writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
17832110
1784−-- | Like 'writeN' but does not check the array bounds when writing. The fold
2111+-- | Like 'createOf' but does not check the array bounds when writing. The fold
17852112-- driver must not call the step function more than 'n' times otherwise it will
17862113-- corrupt the memory and crash. This function exists mainly because any
17872114-- conditional in the step function blocks fusion causing 10x performance
17882115-- slowdown.
17892116--
1790−-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
2117+-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
17912118--
1792−{-# INLINE_NORMAL writeNUnsafe #-}
2119+{-# INLINE_NORMAL unsafeCreateOf #-}
2120+unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121+ => Int -> Fold m a (MutArray a)
2122+unsafeCreateOf = writeNUnsafeAs Unpinned
2123+
2124+{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
2125+{-# INLINE writeNUnsafe #-}
17932126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
17942127 => Int -> Fold m a (MutArray a)
1795−writeNUnsafe = writeNUnsafeAs Unpinned
2128+writeNUnsafe = unsafeCreateOf
17962129
1797−-- | Like 'writeNUnsafe' but creates a pinned array.
1798−{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
2130+-- | Like 'unsafeCreateOf' but creates a pinned array.
2131+{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132+unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133+ => Int -> Fold m a (MutArray a)
2134+unsafePinnedCreateOf = writeNUnsafeAs Pinned
2135+
2136+{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137+{-# INLINE pinnedWriteNUnsafe #-}
17992138pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
18002139 => Int -> Fold m a (MutArray a)
1801−pinnedWriteNUnsafe = writeNUnsafeAs Pinned
2140+pinnedWriteNUnsafe = unsafePinnedCreateOf
18022141
1803−-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
2142+-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
18042143-- allocated using the @alloc@ function.
18052144--
1806−-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1807−-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2145+-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146+-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
18082147--
1809−{-# INLINE_NORMAL writeNWith #-}
2148+{-# INLINE_NORMAL createOfWith #-}
2149+createOfWith :: forall m a. (MonadIO m, Unbox a)
2150+ => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151+createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2152+
2153+-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154+{-# INLINE writeNWith #-}
18102155writeNWith :: forall m a. (MonadIO m, Unbox a)
18112156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1812−writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2157+writeNWith = createOfWith
18132158
18142159{-# INLINE_NORMAL writeNAs #-}
18152160writeNAs ::
@@ -1817,28 +2162,42 @@ writeNAs ::
18172162 => PinnedState
18182163 -> Int
18192164 -> Fold m a (MutArray a)
1820−writeNAs ps = writeNWith (newAs ps)
2165+writeNAs ps = createOfWith (newAs ps)
18212166
1822−-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
2167+-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
18232168-- 'MutArray'.
18242169--
1825−-- >>> writeN = MutArray.writeNWith MutArray.new
1826−-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1827−-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2170+-- >>> createOf = MutArray.createOfWith MutArray.new
2171+-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172+-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
18282173--
1829−{-# INLINE_NORMAL writeN #-}
2174+{-# INLINE_NORMAL createOf #-}
2175+createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176+createOf = writeNAs Unpinned
2177+
2178+-- XXX Deprecate in major
2179+-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180+{-# INLINE writeN #-}
18302181writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1831−writeN = writeNAs Unpinned
2182+writeN = createOf
2183+
2184+-- | Like 'createOf' but creates a pinned array.
2185+{-# INLINE_NORMAL pinnedCreateOf #-}
2186+pinnedCreateOf ::
2187+ forall m a. (MonadIO m, Unbox a)
2188+ => Int
2189+ -> Fold m a (MutArray a)
2190+pinnedCreateOf = writeNAs Pinned
18322191
1833−-- | Like 'writeN' but creates a pinned array.
1834−{-# INLINE_NORMAL pinnedWriteN #-}
2192+{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193+{-# INLINE pinnedWriteN #-}
18352194pinnedWriteN ::
18362195 forall m a. (MonadIO m, Unbox a)
18372196 => Int
18382197 -> Fold m a (MutArray a)
1839−pinnedWriteN = writeNAs Pinned
2198+pinnedWriteN = pinnedCreateOf
18402199
1841−-- | Like writeNWithUnsafe but writes the array in reverse order.
2200+-- | Like unsafeCreateOfWith but writes the array in reverse order.
18422201--
18432202-- /Internal/
18442203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -1855,11 +2214,11 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
18552214
18562215 step (ArrayUnsafe contents start end) x = do
18572216 let ptr = INDEX_PREV(start,a)
1858− liftIO $ pokeByteIndex ptr contents x
2217+ liftIO $ pokeAt ptr contents x
18592218 return
18602219 $ ArrayUnsafe contents ptr end
18612220
1862−-- | Like writeNWith but writes the array in reverse order.
2221+-- | Like createOfWith but writes the array in reverse order.
18632222--
18642223-- /Internal/
18652224{-# INLINE_NORMAL writeRevNWith #-}
@@ -1867,31 +2226,36 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
18672226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
18682227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
18692228
1870−-- | Like writeN but writes the array in reverse order.
2229+-- | Like 'createOf' but writes the array in reverse order.
18712230--
18722231-- /Pre-release/
1873−{-# INLINE_NORMAL writeRevN #-}
2232+{-# INLINE_NORMAL revCreateOf #-}
2233+revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234+revCreateOf = writeRevNWith new
2235+
2236+{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237+{-# INLINE writeRevN #-}
18742238writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1875−writeRevN = writeRevNWith new
2239+writeRevN = revCreateOf
18762240
18772241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
18782242-- input stream to a 'MutArray' aligned to the given size.
18792243--
1880−-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1881−-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
2244+-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245+-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
18822246--
18832247-- /Pre-release/
18842248--
18852249{-# INLINE_NORMAL pinnedWriteNAligned #-}
18862250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
18872251 => Int -> Int -> Fold m a (MutArray a)
1888−pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
2252+pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
18892253
18902254-- XXX Buffer to a list instead?
18912255
18922256-- | Buffer a stream into a stream of arrays.
18932257--
1894−-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2258+-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
18952259--
18962260-- Breaking an array into an array stream can be useful to consume a large
18972261-- array sequentially such that memory of the array is released incrementatlly.
@@ -1900,37 +2264,43 @@ pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
19002264--
19012265-- /Unimplemented/
19022266--
1903−{-# INLINE_NORMAL writeChunks #-}
2267+{-# INLINE_NORMAL buildChunks #-}
2268+buildChunks :: (MonadIO m, Unbox a) =>
2269+ Int -> Fold m a (StreamK n (MutArray a))
2270+buildChunks n = FL.many (createOf n) FL.toStreamK
2271+
2272+{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273+{-# INLINE writeChunks #-}
19042274writeChunks :: (MonadIO m, Unbox a) =>
19052275 Int -> Fold m a (StreamK n (MutArray a))
1906−writeChunks n = FL.many (writeN n) FL.toStreamK
2276+writeChunks = buildChunks
19072277
19082278{-# INLINE_NORMAL writeWithAs #-}
19092279writeWithAs :: forall m a. (MonadIO m, Unbox a)
19102280 => PinnedState -> Int -> Fold m a (MutArray a)
1911−-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
2281+-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
19122282writeWithAs ps elemCount =
19132283 FL.rmapM extract $ FL.foldlM' step initial
19142284
19152285 where
19162286
19172287 initial = do
1918− when (elemCount < 0) $ error "writeWith: elemCount is negative"
1919− liftIO $ newAs ps elemCount
2288+ when (elemCount < 0) $ error "createWith: elemCount is negative"
2289+ newAs ps elemCount
19202290
19212291 step arr@(MutArray _ start end bound) x
19222292 | INDEX_NEXT(end,a) > bound = do
19232293 let oldSize = end - start
19242294 newSize = max (oldSize * 2) 1
1925− arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
2295+ arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
19262296 snocUnsafe arr1 x
19272297 step arr x = snocUnsafe arr x
19282298
19292299 extract = liftIO . rightSize
19302300
1931−-- XXX Compare writeWith with fromStreamD which uses an array of streams
1932−-- implementation. We can write this using writeChunks above if that is faster.
1933−-- If writeWith is faster then we should use that to implement
2301+-- XXX Compare createWith with fromStreamD which uses an array of streams
2302+-- implementation. We can write this using buildChunks above if that is faster.
2303+-- If createWith is faster then we should use that to implement
19342304-- fromStreamD.
19352305--
19362306-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -1945,39 +2315,56 @@ writeWithAs ps elemCount =
19452315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
19462316-- malloc to compare against.
19472317
1948−-- | @writeWith minCount@ folds the whole input to a single array. The array
2318+-- | @createWith minCount@ folds the whole input to a single array. The array
19492319-- starts at a size big enough to hold minCount elements, the size is doubled
19502320-- every time the array needs to be grown.
19512321--
19522322-- /Caution! Do not use this on infinite streams./
19532323--
1954−-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
1955−-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
1956−-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
2324+-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
2325+-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
2326+-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
19572327--
19582328-- /Pre-release/
1959−{-# INLINE_NORMAL writeWith #-}
2329+{-# INLINE_NORMAL createWith #-}
2330+createWith :: forall m a. (MonadIO m, Unbox a)
2331+ => Int -> Fold m a (MutArray a)
2332+-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333+createWith = writeWithAs Unpinned
2334+
2335+{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336+{-# INLINE writeWith #-}
19602337writeWith :: forall m a. (MonadIO m, Unbox a)
19612338 => Int -> Fold m a (MutArray a)
1962−-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
1963−writeWith = writeWithAs Unpinned
2339+writeWith = createWith
19642340
19652341-- | Fold the whole input to a single array.
19662342--
1967−-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2343+-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
19682344-- rounded up to the element size.
19692345--
19702346-- /Caution! Do not use this on infinite streams./
19712347--
2348+{-# INLINE create #-}
2349+create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350+create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2351+
2352+-- XXX Deprecate in major
2353+-- {-# DEPRECATED write "Please use create instead." #-}
19722354{-# INLINE write #-}
19732355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1974−write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2356+write = create
19752357
1976−-- | Like 'write' but creates a pinned array.
2358+-- | Like 'create' but creates a pinned array.
2359+{-# INLINE pinnedCreate #-}
2360+pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2361+pinnedCreate =
2362+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2363+
2364+{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
19772365{-# INLINE pinnedWrite #-}
19782366pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1979−pinnedWrite =
1980− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2367+pinnedWrite = pinnedCreate
19812368
19822369-------------------------------------------------------------------------------
19832370-- construct from streams, known size
@@ -1987,25 +2374,31 @@ pinnedWrite =
19872374fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
19882375 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
19892376fromStreamDNAs ps limit str = do
1990− (arr :: MutArray a) <- liftIO $ newAs ps limit
2377+ (arr :: MutArray a) <- newAs ps limit
19912378 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
19922379 return $ arr {arrEnd = end}
19932380
19942381 where
19952382
19962383 fwrite arrContents ptr x = do
1997− liftIO $ pokeByteIndex ptr arrContents x
2384+ liftIO $ pokeAt ptr arrContents x
19982385 return $ INDEX_NEXT(ptr,a)
19992386
2000−-- | Use the 'writeN' fold instead.
2387+-- | Use the 'createOf' fold instead.
20012388--
2002−-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
2389+-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
20032390--
2004−{-# INLINE_NORMAL fromStreamDN #-}
2391+{-# INLINE_NORMAL fromStreamN #-}
2392+fromStreamN :: forall m a. (MonadIO m, Unbox a)
2393+ => Int -> D.Stream m a -> m (MutArray a)
2394+-- fromStreamDN n = D.fold (createOf n)
2395+fromStreamN = fromStreamDNAs Unpinned
2396+
2397+{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398+{-# INLINE fromStreamDN #-}
20052399fromStreamDN :: forall m a. (MonadIO m, Unbox a)
20062400 => Int -> D.Stream m a -> m (MutArray a)
2007−-- fromStreamDN n = D.fold (writeN n)
2008−fromStreamDN = fromStreamDNAs Unpinned
2401+fromStreamDN = fromStreamN
20092402
20102403-- | Create a 'MutArray' from the first N elements of a list. The array is
20112404-- allocated to size N, if the list terminates before N elements then the
@@ -2025,16 +2418,70 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
20252418-- /Pre-release/
20262419{-# INLINE fromListRevN #-}
20272420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2028−fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
2421+fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2422+
2423+-- | Convert a pure stream in Identity monad to a mutable array.
2424+{-# INLINABLE fromPureStreamN #-}
2425+fromPureStreamN :: (MonadIO m, Unbox a) =>
2426+ Int -> Stream Identity a -> m (MutArray a)
2427+fromPureStreamN n xs =
2428+ D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
20292429
20302430-- | Convert a pure stream in Identity monad to a mutable array.
20312431{-# INLINABLE fromPureStream #-}
20322432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
20332433fromPureStream xs =
2034− liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
2434+ D.fold create $ D.morphInner (return . runIdentity) xs
2435+
2436+{-# INLINABLE fromPtrN #-}
2437+fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
2438+fromPtrN len addr = do
2439+ -- memcpy is better than stream copy when the size is known.
2440+ -- XXX We can implement a stream copy in a similar way by streaming Word64
2441+ -- first and then remaining Word8.
2442+ arr <- new len
2443+ _ <- unsafeAsPtr arr
2444+ (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2445+ return (arr {arrEnd = len})
2446+
2447+{-# INLINABLE fromByteStr# #-}
2448+fromByteStr# :: MonadIO m => Addr# -> m (MutArray Word8)
2449+fromByteStr# addr = do
2450+ -- It is better to count the size first and allocate exact space.
2451+ -- Also, memcpy is better than stream copy when the size is known.
2452+ -- C strlen compares 4 bytes at a time, so is better than the stream
2453+ -- version. https://github.com/bminor/glibc/blob/master/string/strlen.c
2454+ -- XXX We can possibly use a stream of Word64 to do the same.
2455+ -- fromByteStr# addr = fromPureStream (D.fromByteStr# addr)
2456+ len <- liftIO $ c_strlen (Ptr addr)
2457+ let lenInt = fromIntegral len
2458+ arr <- new lenInt
2459+ _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2460+ return (arr {arrEnd = lenInt})
20352461
20362462-------------------------------------------------------------------------------
2037−-- convert stream to a single array
2463+-- convert a stream of arrays to a single array by reallocating and copying
2464+-------------------------------------------------------------------------------
2465+
2466+-- XXX Both of these implementations of splicing seem to perform equally well.
2467+-- We need to perform benchmarks over a range of sizes though.
2468+
2469+-- | Also see 'fromChunksK'.
2470+{-# INLINE fromChunksRealloced #-}
2471+fromChunksRealloced :: forall m a. (MonadIO m, Unbox a)
2472+ => Stream m (MutArray a) -> m (MutArray a)
2473+fromChunksRealloced s = do
2474+ res <- D.uncons s
2475+ case res of
2476+ Just (a, strm) -> do
2477+ arr <- D.foldlM' spliceExp (pure a) strm
2478+ -- Reallocation is exponential so there may be 50% empty space in
2479+ -- worst case. One more reallocation to reclaim the space.
2480+ rightSize arr
2481+ Nothing -> pure nil
2482+
2483+-------------------------------------------------------------------------------
2484+-- convert a stream of arrays to a single array by buffering arrays first
20382485-------------------------------------------------------------------------------
20392486
20402487{-# INLINE arrayStreamKLength #-}
@@ -2044,34 +2491,72 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
20442491-- | Convert an array stream to an array. Note that this requires peak memory
20452492-- that is double the size of the array stream.
20462493--
2494+{-# INLINE fromChunkskAs #-}
2495+fromChunkskAs :: (Unbox a, MonadIO m) =>
2496+ PinnedState -> StreamK m (MutArray a) -> m (MutArray a)
2497+fromChunkskAs ps as = do
2498+ len <- arrayStreamKLength as
2499+ arr <- newAs ps len
2500+ -- XXX is StreamK fold faster or StreamD fold?
2501+ K.foldlM' spliceUnsafe (pure arr) as
2502+ -- fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
2503+
2504+-- XXX Need to compare this with fromChunks and fromChunkList and keep the
2505+-- fastest or simplest one if all are equally fast.
2506+
2507+-- | Convert an array stream to an array. Note that this requires peak memory
2508+-- that is double the size of the array stream.
2509+--
2510+-- Also see 'fromChunksRealloced'.
2511+--
2512+{-# INLINE fromChunksK #-}
2513+fromChunksK :: (Unbox a, MonadIO m) =>
2514+ StreamK m (MutArray a) -> m (MutArray a)
2515+fromChunksK = fromChunkskAs Unpinned
2516+
2517+{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
20472518{-# INLINE fromArrayStreamK #-}
20482519fromArrayStreamK :: (Unbox a, MonadIO m) =>
20492520 StreamK m (MutArray a) -> m (MutArray a)
2050−fromArrayStreamK as = do
2051− len <- arrayStreamKLength as
2052− fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
2521+fromArrayStreamK = fromChunksK
20532522
20542523{-# INLINE fromStreamDAs #-}
20552524fromStreamDAs ::
20562525 (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
2057−fromStreamDAs ps m = arrayStreamKFromStreamDAs ps m >>= fromArrayStreamK
2526+fromStreamDAs ps m =
2527+ arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
20582528
2529+-- | Create an 'Array' from a stream. This is useful when we want to create a
2530+-- single array from a stream of unknown size. 'createOf' is at least twice
2531+-- as efficient when the size is already known.
2532+--
2533+-- Note that if the input stream is too large memory allocation for the array
2534+-- may fail. When the stream size is not known, `chunksOf` followed by
2535+-- processing of indvidual arrays in the resulting stream should be preferred.
2536+--
2537+-- /Pre-release/
2538+{-# INLINE fromStream #-}
2539+fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540+fromStream = fromStreamDAs Unpinned
2541+
2542+-- fromStream (Stream m) = P.fold create m
20592543-- CAUTION: a very large number (millions) of arrays can degrade performance
20602544-- due to GC overhead because we need to buffer the arrays before we flatten
20612545-- all the arrays.
20622546--
2063−-- XXX Compare if this is faster or "fold write".
2547+-- XXX Compare if this is faster or "fold create".
20642548--
20652549-- | We could take the approach of doubling the memory allocation on each
20662550-- overflow. This would result in more or less the same amount of copying as in
20672551-- the chunking approach. However, if we have to shrink in the end then it may
20682552-- result in an extra copy of the entire data.
20692553--
2070−-- >>> fromStreamD = StreamD.fold MutArray.write
2554+-- >>> fromStreamD = StreamD.fold MutArray.create
20712555--
20722556{-# INLINE fromStreamD #-}
2557+{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
20732558fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2074−fromStreamD = fromStreamDAs Unpinned
2559+fromStreamD = fromStream
20752560
20762561-- | Create a 'MutArray' from a list. The list must be of finite size.
20772562--
@@ -2096,22 +2581,44 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
20962581-- Cloning
20972582-------------------------------------------------------------------------------
20982583
2584+-- Arrays are aligned on 64-bit boundaries. The fastest way to copy an array is
2585+-- to unsafeCast it to Word64, read it, write it to Word64 array and unsafeCast
2586+-- it again. We can use SIMD read/write as well.
2587+
20992588{-# INLINE cloneAs #-}
2100−cloneAs :: MonadIO m => PinnedState -> MutArray a -> m (MutArray a)
2589+cloneAs ::
2590+ ( MonadIO m
2591+#ifdef DEVBUILD
2592+ , Unbox a
2593+#endif
2594+ )
2595+ => PinnedState -> MutArray a -> m (MutArray a)
21012596cloneAs ps src =
2102− liftIO $ do
2597+ do
21032598 let startSrc = arrStart src
21042599 srcLen = arrEnd src - startSrc
2105− newArrContents <- Unboxed.newBytesAs ps srcLen
2106− putSliceUnsafe (arrContents src) startSrc newArrContents 0 srcLen
2600+ newArrContents <-
2601+ Unboxed.cloneSliceUnsafeAs ps startSrc srcLen (arrContents src)
21072602 return $ MutArray newArrContents 0 srcLen srcLen
21082603
21092604{-# INLINE clone #-}
2110−clone :: MonadIO m => MutArray a -> m (MutArray a)
2605+clone ::
2606+ ( MonadIO m
2607+#ifdef DEVBUILD
2608+ , Unbox a
2609+#endif
2610+ )
2611+ => MutArray a -> m (MutArray a)
21112612clone = cloneAs Unpinned
21122613
21132614{-# INLINE pinnedClone #-}
2114−pinnedClone :: MonadIO m => MutArray a -> m (MutArray a)
2615+pinnedClone ::
2616+ ( MonadIO m
2617+#ifdef DEVBUILD
2618+ , Unbox a
2619+#endif
2620+ )
2621+ => MutArray a -> m (MutArray a)
21152622pinnedClone = cloneAs Pinned
21162623
21172624-------------------------------------------------------------------------------
@@ -2126,17 +2633,16 @@ spliceCopy :: forall m a. MonadIO m =>
21262633 Unbox a =>
21272634#endif
21282635 MutArray a -> MutArray a -> m (MutArray a)
2129−spliceCopy arr1 arr2 = liftIO $ do
2636+spliceCopy arr1 arr2 = do
21302637 let start1 = arrStart arr1
21312638 start2 = arrStart arr2
21322639 len1 = arrEnd arr1 - start1
21332640 len2 = arrEnd arr2 - start2
2134− let newLen = len1 + len2
2641+ let len = len1 + len2
21352642 newArrContents <-
21362643 if Unboxed.isPinned (arrContents arr1)
2137− then Unboxed.pinnedNewByteArray newLen
2138− else Unboxed.newByteArray newLen
2139− let len = len1 + len2
2644+ then liftIO $ Unboxed.pinnedNew len
2645+ else liftIO $ Unboxed.new len
21402646 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
21412647 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
21422648 return $ MutArray newArrContents 0 len len
@@ -2148,7 +2654,7 @@ spliceCopy arr1 arr2 = liftIO $ do
21482654spliceUnsafe :: MonadIO m =>
21492655 MutArray a -> MutArray a -> m (MutArray a)
21502656spliceUnsafe dst src =
2151− liftIO $ do
2657+ do
21522658 let startSrc = arrStart src
21532659 srcLen = arrEnd src - startSrc
21542660 endDst = arrEnd dst
@@ -2170,7 +2676,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
21702676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
21712677spliceWith sizer dst@(MutArray _ start end bound) src = do
21722678{-
2173− let f = writeAppendWith (`sizer` byteLength src) (return dst)
2679+ let f = appendWith (`sizer` byteLength src) (return dst)
21742680 in D.fold f (toStreamD src)
21752681-}
21762682 assert (end <= bound) (return ())
@@ -2186,7 +2692,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
21862692 $ "splice: newSize is less than the total size "
21872693 ++ "of arrays being appended. Please check the "
21882694 ++ "sizer function passed."
2189− liftIO $ realloc newSizeInBytes dst
2695+ realloc newSizeInBytes dst
21902696 else return dst
21912697 spliceUnsafe dst1 src
21922698
@@ -2223,14 +2729,24 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
22232729-- Splitting
22242730-------------------------------------------------------------------------------
22252731
2732+-- | Generate a stream of array slices using a predicate. The array element
2733+-- matching the predicate is dropped.
2734+--
2735+-- /Pre-release/
2736+{-# INLINE splitOn #-}
2737+splitOn :: (MonadIO m, Unbox a) =>
2738+ (a -> Bool) -> MutArray a -> Stream m (MutArray a)
2739+splitOn predicate arr =
2740+ fmap (\(i, len) -> getSliceUnsafe i len arr)
2741+ $ D.indexOnSuffix predicate (read arr)
2742+
22262743-- | Drops the separator byte
22272744{-# INLINE breakOn #-}
22282745breakOn :: MonadIO m
22292746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2230−breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2231− -- XXX Instead of using asPtrUnsafe (pinning memory) we can pass unlifted
2232− -- Addr# to memchr and it should be safe (from ghc 8.4).
2747+breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
22332748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749+ -- Need efficient stream based primitives that work on Word64.
22342750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
22352751 let sepIndex = loc `minusPtr` p
22362752 return $
@@ -2251,32 +2767,41 @@ breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
22512767 }
22522768 )
22532769
2770+-- | Like 'splitAt' but does not check whether the index is valid.
2771+--
2772+{-# INLINE unsafeSplitAt #-}
2773+unsafeSplitAt :: forall a. Unbox a =>
2774+ Int -> MutArray a -> (MutArray a, MutArray a)
2775+unsafeSplitAt i MutArray{..} =
2776+ let off = i * SIZE_OF(a)
2777+ p = arrStart + off
2778+ in ( MutArray
2779+ { arrContents = arrContents
2780+ , arrStart = arrStart
2781+ , arrEnd = p
2782+ , arrBound = p
2783+ }
2784+ , MutArray
2785+ { arrContents = arrContents
2786+ , arrStart = p
2787+ , arrEnd = arrEnd
2788+ , arrBound = arrBound
2789+ }
2790+ )
2791+
22542792-- | Create two slices of an array without copying the original array. The
22552793-- specified index @i@ is the first index of the second slice.
22562794--
2795+{-# INLINE splitAt #-}
22572796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2258−splitAt i arr@MutArray{..} =
2797+splitAt i arr =
22592798 let maxIndex = length arr - 1
22602799 in if i < 0
22612800 then error "sliceAt: negative array index"
22622801 else if i > maxIndex
22632802 then error $ "sliceAt: specified array index " ++ show i
22642803 ++ " is beyond the maximum index " ++ show maxIndex
2265− else let off = i * SIZE_OF(a)
2266− p = arrStart + off
2267− in ( MutArray
2268− { arrContents = arrContents
2269− , arrStart = arrStart
2270− , arrEnd = p
2271− , arrBound = p
2272− }
2273− , MutArray
2274− { arrContents = arrContents
2275− , arrStart = p
2276− , arrEnd = arrEnd
2277− , arrBound = arrBound
2278− }
2279− )
2804+ else unsafeSplitAt i arr
22802805
22812806-------------------------------------------------------------------------------
22822807-- Casting
@@ -2326,9 +2851,13 @@ cast arr =
23262851-- guarantees that unsafe calls will be performed in the calling thread. Making
23272852-- it safe to pass heap-allocated objects to unsafe functions.
23282853
2329−-- Should we just name it asPtr, the unsafety is implicit for any pointer
2854+-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
23302855-- operations. And we are safe from Haskell perspective because we will be
23312856-- pinning the memory.
2857+--
2858+-- XXX we cannot pass the length of the ptr here as in some cases it may not be
2859+-- available e.g. a null terminated C string. However, we can create another
2860+-- flavor of the API e.g. asPtrN.
23322861
23332862-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
23342863-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2346,48 +2875,377 @@ cast arr =
23462875--
23472876-- /Pre-release/
23482877--
2878+{-# INLINE unsafePinnedAsPtr #-}
2879+unsafePinnedAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2880+unsafePinnedAsPtr arr f =
2881+ Unboxed.unsafePinnedAsPtr
2882+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2883+
2884+{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
23492885{-# INLINE asPtrUnsafe #-}
23502886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2351−asPtrUnsafe arr f =
2352− Unboxed.asPtrUnsafe
2887+asPtrUnsafe = unsafePinnedAsPtr
2888+
2889+{-# INLINE unsafeAsPtr #-}
2890+unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891+unsafeAsPtr arr f =
2892+ Unboxed.unsafeAsPtr
23532893 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
23542894
23552895-------------------------------------------------------------------------------
23562896-- Equality
23572897-------------------------------------------------------------------------------
23582898
2359−-- | Compare the length of the arrays. If the length is equal, compare the
2360−-- lexicographical ordering of two underlying byte arrays otherwise return the
2361−-- result of length comparison.
2899+-- | Byte compare two arrays. Compare the length of the arrays. If the length
2900+-- is equal, compare the lexicographical ordering of two underlying byte arrays
2901+-- otherwise return the result of length comparison.
2902+--
2903+-- /Unsafe/: Note that the 'Unbox' instance of sum types with constructors of
2904+-- different sizes may leave some memory uninitialized which can make byte
2905+-- comparison unreliable.
23622906--
23632907-- /Pre-release/
2908+{-# INLINE byteCmp #-}
2909+byteCmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2910+byteCmp arr1 arr2 = do
2911+ let marr1 = getMutableByteArray# (arrContents arr1)
2912+ marr2 = getMutableByteArray# (arrContents arr2)
2913+ !(I# st1#) = arrStart arr1
2914+ !(I# st2#) = arrStart arr2
2915+ !(I# len#) = byteLength arr1
2916+ case compare (byteLength arr1) (byteLength arr2) of
2917+ EQ -> do
2918+ r <- liftIO $ IO $ \s# ->
2919+ let res =
2920+ I#
2921+ (compareByteArrays#
2922+ (unsafeCoerce# marr1)
2923+ st1#
2924+ (unsafeCoerce# marr2)
2925+ st2#
2926+ len#)
2927+ in (# s#, res #)
2928+ return $ compare r 0
2929+ x -> return x
2930+
23642931{-# INLINE cmp #-}
2932+{-# DEPRECATED cmp "Please use byteCmp instead." #-}
23652933cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2366−cmp arr1 arr2 =
2367− liftIO
2368− $ do
2369− let marr1 = getMutableByteArray# (arrContents arr1)
2370− marr2 = getMutableByteArray# (arrContents arr2)
2371− !(I# st1#) = arrStart arr1
2372− !(I# st2#) = arrStart arr2
2373− !(I# len#) = byteLength arr1
2374− case compare (byteLength arr1) (byteLength arr2) of
2375− EQ -> do
2376− r <- liftIO $ IO $ \s# ->
2377− let res =
2378− I#
2379− (compareByteArrays#
2380− (unsafeCoerce# marr1)
2381− st1#
2382− (unsafeCoerce# marr2)
2383− st2#
2384− len#)
2385− in (# s#, res #)
2386− return $ compare r 0
2387− x -> return x
2934+cmp = byteCmp
23882935
2936+-- | Byte equality of two arrays.
2937+--
2938+-- >>> byteEq arr1 arr2 = (==) EQ $ MArray.byteCmp arr1 arr2
2939+--
2940+-- /Unsafe/: See 'byteCmp'.
2941+{-# INLINE byteEq #-}
2942+byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
2943+byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2944+
2945+-------------------------------------------------------------------------------
2946+-- Compact
23892947-------------------------------------------------------------------------------
2390−-- NFData
2948+
2949+-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2950+-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2951+-- can leave some memory unused. They can split the last array to fit it
2952+-- exactly in the space.
2953+
2954+{-# INLINE_NORMAL pCompactLeAs #-}
2955+pCompactLeAs ::
2956+ forall m a. (MonadIO m, Unbox a)
2957+ => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958+pCompactLeAs ps maxElems = Parser step initial extract
2959+
2960+ where
2961+
2962+ maxBytes = maxElems * SIZE_OF(a)
2963+
2964+ functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2965+
2966+ initial =
2967+ return
2968+ $ if maxElems <= 0
2969+ then error
2970+ $ functionName
2971+ ++ ": the size of arrays ["
2972+ ++ show maxElems ++ "] must be a natural number"
2973+ else Parser.IPartial Nothing
2974+
2975+ step Nothing arr =
2976+ return
2977+ $ let len = byteLength arr
2978+ in if len >= maxBytes
2979+ then Parser.Done 0 arr
2980+ else Parser.Partial 0 (Just arr)
2981+ -- XXX Split the last array to use the space more compactly.
2982+ step (Just buf) arr =
2983+ let len = byteLength buf + byteLength arr
2984+ in if len > maxBytes
2985+ then return $ Parser.Done 1 buf
2986+ else do
2987+ buf1 <-
2988+ if byteCapacity buf < maxBytes
2989+ then liftIO $ reallocExplicitAs
2990+ ps (SIZE_OF(a)) maxBytes buf
2991+ else return buf
2992+ buf2 <- spliceUnsafe buf1 arr
2993+ return $ Parser.Partial 0 (Just buf2)
2994+
2995+ extract Nothing = return $ Parser.Done 0 nil
2996+ extract (Just buf) = return $ Parser.Done 0 buf
2997+
2998+-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2999+-- only if the combined size would be less than or equal to @maxElems@
3000+-- elements. Note that it won't split an array if the original array is already
3001+-- larger than maxElems.
3002+--
3003+-- @maxElems@ must be greater than 0.
3004+--
3005+-- Generates unpinned arrays irrespective of the pinning status of input
3006+-- arrays.
3007+--
3008+-- /Internal/
3009+{-# INLINE pCompactLE #-}
3010+pCompactLE ::
3011+ forall m a. (MonadIO m, Unbox a)
3012+ => Int -> Parser (MutArray a) m (MutArray a)
3013+pCompactLE = pCompactLeAs Unpinned
3014+
3015+-- | Pinned version of 'pCompactLE'.
3016+{-# INLINE pPinnedCompactLE #-}
3017+pPinnedCompactLE ::
3018+ forall m a. (MonadIO m, Unbox a)
3019+ => Int -> Parser (MutArray a) m (MutArray a)
3020+pPinnedCompactLE = pCompactLeAs Pinned
3021+
3022+data SpliceState s arr
3023+ = SpliceInitial s
3024+ | SpliceBuffering s arr
3025+ | SpliceYielding arr (SpliceState s arr)
3026+ | SpliceFinish
3027+
3028+-- This mutates the first array (if it has space) to append values from the
3029+-- second one. This would work for immutable arrays as well because an
3030+-- immutable array never has additional space so a new array is allocated
3031+-- instead of mutating it.
3032+
3033+{-# INLINE_NORMAL compactLeAs #-}
3034+compactLeAs :: forall m a. (MonadIO m, Unbox a)
3035+ => PinnedState -> Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
3036+compactLeAs ps maxElems (D.Stream step state) =
3037+ D.Stream step' (SpliceInitial state)
3038+
3039+ where
3040+
3041+ maxBytes = maxElems * SIZE_OF(a)
3042+
3043+ functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
3044+
3045+ {-# INLINE_LATE step' #-}
3046+ step' gst (SpliceInitial st) = do
3047+ when (maxElems <= 0) $
3048+ -- XXX we can pass the module string from the higher level API
3049+ error $ functionName ++ ": the size of arrays [" ++ show maxElems
3050+ ++ "] must be a natural number"
3051+ r <- step gst st
3052+ case r of
3053+ D.Yield arr s -> return $
3054+ let len = byteLength arr
3055+ in if len >= maxBytes
3056+ then D.Skip (SpliceYielding arr (SpliceInitial s))
3057+ else D.Skip (SpliceBuffering s arr)
3058+ D.Skip s -> return $ D.Skip (SpliceInitial s)
3059+ D.Stop -> return D.Stop
3060+
3061+ -- XXX Split the last array to use the space more compactly.
3062+ step' gst (SpliceBuffering st buf) = do
3063+ r <- step gst st
3064+ case r of
3065+ D.Yield arr s -> do
3066+ let len = byteLength buf + byteLength arr
3067+ if len > maxBytes
3068+ then return $
3069+ D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3070+ else do
3071+ buf1 <- if byteCapacity buf < maxBytes
3072+ then liftIO $ reallocExplicitAs
3073+ ps (SIZE_OF(a)) maxBytes buf
3074+ else return buf
3075+ buf2 <- spliceUnsafe buf1 arr
3076+ return $ D.Skip (SpliceBuffering s buf2)
3077+ D.Skip s -> return $ D.Skip (SpliceBuffering s buf)
3078+ D.Stop -> return $ D.Skip (SpliceYielding buf SpliceFinish)
3079+
3080+ step' _ SpliceFinish = return D.Stop
3081+
3082+ step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3083+
3084+
3085+{-# INLINE_NORMAL fCompactGeAs #-}
3086+fCompactGeAs ::
3087+ forall m a. (MonadIO m, Unbox a)
3088+ => PinnedState -> Int -> FL.Fold m (MutArray a) (MutArray a)
3089+fCompactGeAs ps minElems = Fold step initial extract extract
3090+
3091+ where
3092+
3093+ minBytes = minElems * SIZE_OF(a)
3094+
3095+ functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3096+
3097+ initial =
3098+ return
3099+ $ if minElems < 0
3100+ then error
3101+ $ functionName
3102+ ++ ": the size of arrays ["
3103+ ++ show minElems ++ "] must be a natural number"
3104+ else FL.Partial Nothing
3105+
3106+ step Nothing arr =
3107+ return
3108+ $ let len = byteLength arr
3109+ in if len >= minBytes
3110+ then FL.Done arr
3111+ else FL.Partial (Just arr)
3112+ -- XXX Buffer arrays as a list to avoid copy and reallocations
3113+ step (Just buf) arr = do
3114+ let len = byteLength buf + byteLength arr
3115+ buf1 <-
3116+ if byteCapacity buf < len
3117+ then liftIO $ reallocExplicitAs
3118+ ps (SIZE_OF(a)) (max minBytes len) buf
3119+ else return buf
3120+ buf2 <- spliceUnsafe buf1 arr
3121+ if len >= minBytes
3122+ then return $ FL.Done buf2
3123+ else return $ FL.Partial (Just buf2)
3124+
3125+ extract Nothing = return nil
3126+ extract (Just buf) = return buf
3127+
3128+-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129+-- until the size becomes greater than or equal to @minElems@.
3130+--
3131+-- Generates unpinned arrays irrespective of the pinning status of input
3132+-- arrays.
3133+{-# INLINE fCompactGE #-}
3134+fCompactGE ::
3135+ forall m a. (MonadIO m, Unbox a)
3136+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3137+fCompactGE = fCompactGeAs Unpinned
3138+
3139+-- | Pinned version of 'fCompactGE'.
3140+{-# INLINE fPinnedCompactGE #-}
3141+fPinnedCompactGE ::
3142+ forall m a. (MonadIO m, Unbox a)
3143+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3144+fPinnedCompactGE = fCompactGeAs Pinned
3145+
3146+{-# INLINE_NORMAL lCompactGeAs #-}
3147+lCompactGeAs :: forall m a. (MonadIO m, Unbox a)
3148+ => PinnedState -> Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3149+-- The fold version turns out to be a little bit slower.
3150+-- lCompactGeAs ps n = FL.many (fCompactGeAs ps n)
3151+lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
3152+ Fold step initial extract final
3153+
3154+ where
3155+
3156+ minBytes = minElems * SIZE_OF(a)
3157+
3158+ functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
3159+
3160+ initial = do
3161+ when (minElems <= 0) $
3162+ -- XXX we can pass the module string from the higher level API
3163+ error $ functionName ++ ": the size of arrays ["
3164+ ++ show minElems ++ "] must be a natural number"
3165+
3166+ r <- initial1
3167+ return $ first (Tuple' Nothing) r
3168+
3169+ {-# INLINE runInner #-}
3170+ runInner len acc buf =
3171+ if len >= minBytes
3172+ then do
3173+ r <- step1 acc buf
3174+ case r of
3175+ FL.Done _ -> return $ FL.Done ()
3176+ FL.Partial s -> do
3177+ _ <- final1 s
3178+ res <- initial1
3179+ return $ first (Tuple' Nothing) res
3180+ else return $ FL.Partial $ Tuple' (Just buf) acc
3181+
3182+ step (Tuple' Nothing r1) arr =
3183+ runInner (byteLength arr) r1 arr
3184+
3185+ -- XXX Buffer arrays as a list to avoid copy and reallocations
3186+ step (Tuple' (Just buf) r1) arr = do
3187+ let len = byteLength buf + byteLength arr
3188+ buf1 <- if byteCapacity buf < len
3189+ then liftIO $ reallocExplicitAs
3190+ ps (SIZE_OF(a)) (max minBytes len) buf
3191+ else return buf
3192+ buf2 <- spliceUnsafe buf1 arr
3193+ runInner len r1 buf2
3194+
3195+ -- XXX Several folds do extract >=> final, therefore, we need to make final
3196+ -- return "m b" rather than using extract post it if we want extract to be
3197+ -- partial.
3198+ --
3199+ -- extract forces the pending buffer to be sent to the fold which is not
3200+ -- what we want.
3201+ extract _ = error "lCompactGE: not designed for scanning"
3202+
3203+ final (Tuple' Nothing r1) = final1 r1
3204+ final (Tuple' (Just buf) r1) = do
3205+ r <- step1 r1 buf
3206+ case r of
3207+ FL.Partial rr -> final1 rr
3208+ FL.Done _ -> return ()
3209+
3210+-- | Like 'compactGE' but for transforming folds instead of stream.
3211+--
3212+-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3213+--
3214+-- Generates unpinned arrays irrespective of the pinning status of input
3215+-- arrays.
3216+{-# INLINE lCompactGE #-}
3217+lCompactGE :: forall m a. (MonadIO m, Unbox a)
3218+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3219+lCompactGE = lCompactGeAs Unpinned
3220+
3221+-- | Pinned version of 'lCompactGE'.
3222+{-# INLINE lPinnedCompactGE #-}
3223+lPinnedCompactGE :: forall m a. (MonadIO m, Unbox a)
3224+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3225+lPinnedCompactGE = lCompactGeAs Pinned
3226+
3227+-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228+-- the size becomes greater than or equal to @n@.
3229+--
3230+-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
3231+--
3232+{-# INLINE compactGE #-}
3233+compactGE ::
3234+ (MonadIO m, Unbox a)
3235+ => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236+compactGE n = D.foldMany (fCompactGE n)
3237+
3238+-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
3239+-- arrays of exact size @n@.
3240+--
3241+-- /Unimplemented/
3242+{-# INLINE compactEQ #-}
3243+compactEQ :: -- (MonadIO m, Unbox a) =>
3244+ Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3245+compactEQ _n = undefined -- D.parseManyD (pCompactEQ n)
3246+
3247+-------------------------------------------------------------------------------
3248+-- In-place mutation algorithms
23913249-------------------------------------------------------------------------------
23923250
23933251-- | Strip elements which match with predicate from both ends.
@@ -2416,7 +3274,7 @@ strip eq arr@MutArray{..} = liftIO $ do
24163274 getStart cur = do
24173275 if cur < arrEnd
24183276 then do
2419− r <- peekByteIndex cur arrContents
3277+ r <- peekAt cur arrContents
24203278 if eq r
24213279 then getStart (INDEX_NEXT(cur,a))
24223280 else return cur
@@ -2426,7 +3284,7 @@ strip eq arr@MutArray{..} = liftIO $ do
24263284 if cur > low
24273285 then do
24283286 let prev = INDEX_PREV(cur,a)
2429− r <- peekByteIndex prev arrContents
3287+ r <- peekAt prev arrContents
24303288 if eq r
24313289 then getLast prev low
24323290 else return cur