@@ -1,107 +1,66 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE UnboxedTuples #-}
32-- |
4−-- Module : Streamly.Internal.Data.MutArray.Type
3+-- Module : Streamly.Internal.Data.MutArray.Mut.Type
54-- Copyright : (c) 2020 Composewell Technologies
65-- License : BSD3-3-Clause
76-- Maintainer : streamly@composewell.com
87-- Stability : experimental
98-- Portability : GHC
109--
11−-- Pinned and unpinned mutable array for 'Unboxed' types. Fulfils the following
12−-- goals:
13−--
14−-- * Random access (array)
15−-- * Efficient storage (unboxed)
16−-- * Performance (unboxed access)
17−-- * Performance - in-place operations (mutable)
18−-- * Performance - GC (pinned, mutable)
19−-- * interfacing with OS (pinned)
20−--
21−-- Stream and Fold APIs allow easy, efficient and convenient operations on
22−-- arrays.
23−--
2410-- Mutable arrays and file system files are quite similar, they can grow and
2511-- their content is mutable. Therefore, both have similar APIs as well. We
2612-- strive to keep the API consistent for both. Ideally, you should be able to
2713-- replace one with another with little changes to the code.
2814
29−module Streamly.Internal.Data.MutArray.Type
15+module Streamly.Internal.Data.Array.Mut.Type
3016 (
31− -- ** Type
17+ -- * Type
3218 -- $arrayNotes
3319 MutArray (..)
34−
35− -- ** Conversion
36− -- *** Pinned and Unpinned
20+ , MutableByteArray
21+ , touch
3722 , pin
3823 , unpin
39− , isPinned
40−
41− -- ** Casting
42− , cast
43− , castUnsafe -- XXX unsafeCast
44− , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
4724
25+ -- * Constructing and Writing
4826 -- ** Construction
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
63−
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
27+ , nil
7028
71− -- *** Stream Folds
29+ -- *** Uninitialized Arrays
30+ , newPinned
31+ , newPinnedBytes
32+ , newAlignedPinned
33+ , new
34+ , newArrayWith
35+
36+ -- *** Initialized Arrays
37+ , withNewArrayUnsafe
38+
39+ -- *** From streams
7240 , ArrayUnsafe (..)
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
41+ , writeNWithUnsafe
42+ , writeNWith
43+ , writeNUnsafe
44+ , writeN
45+ , writeNAligned
46+
47+ , writeWith
48+ , write
49+
50+ , writeRevN
51+ -- , writeRev
52+
53+ -- ** From containers
8754 , fromListN
88− , pinnedFromListN
8955 , fromList
90− , pinnedFromList
9156 , fromListRevN
9257 , fromListRev
93− , fromStreamN
94− , fromStream
95− , fromPureStreamN
96− , fromPureStream
97− , fromByteStr#
98− , fromPtrN
99− , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
101−
102− -- ** Random writes
58+ , fromStreamDN
59+ , fromStreamD
60+
61+ -- * Random writes
10362 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
63+ , putIndexUnsafe
10564 , putIndices
10665 -- , putFromThenTo
10766 -- , putFrom -- start writing at the given position
@@ -109,71 +68,78 @@ module Streamly.Internal.Data.MutArray.Type
10968 -- , putFromTo
11069 -- , putFromRev
11170 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
71+ , modifyIndexUnsafe
11372 , modifyIndex
11473 , modifyIndices
11574 , modify
11675 , swapIndices
11776 , unsafeSwapIndices
11877
119− -- ** Reading
78+ -- * Growing and Shrinking
79+ -- Arrays grow only at the end, though it is possible to grow on both sides
80+ -- and therefore have a cons as well as snoc. But that will require two
81+ -- bounds in the array representation.
12082
121− -- *** Indexing
122− , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
124− -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
126− , indexReader
127− , indexReaderWith
128−
129− -- *** To Streams
130− , read
131− , readRev
132− , toStreamWith
133− , toStreamRevWith
134− , toStreamK
135− , toStreamKWith
136− , toStreamKRev
137− , toStreamKRevWith
83+ -- ** Appending elements
84+ , snocWith
85+ , snoc
86+ , snocLinear
87+ , snocMay
88+ , snocUnsafe
13889
139− -- *** To Containers
140− , toList
90+ -- ** Appending streams
91+ , writeAppendNUnsafe
92+ , writeAppendN
93+ , writeAppendWith
94+ , writeAppend
14195
142− -- *** Unfolds
143− -- experimental
144− , producerWith
145− , producer
96+ -- * Eliminating and Reading
14697
98+ -- ** To streams
14799 , reader
148100 , readerRevWith
149101 , readerRev
150102
151− -- ** Size and Capacity
152− -- *** Size
153− , length
154− , byteLength
103+ -- ** To containers
104+ , toStreamDWith
105+ , toStreamDRevWith
106+ , toStreamKWith
107+ , toStreamKRevWith
108+ , toStreamD
109+ , toStreamDRev
110+ , toStreamK
111+ , toStreamKRev
112+ , toList
155113
156− -- *** Capacity
157− -- , capacity
158− , byteCapacity
159− , bytesFree
114+ -- experimental
115+ , producerWith
116+ , producer
117+
118+ -- ** Random reads
119+ , getIndex
120+ , getIndexUnsafe
121+ , getIndices
122+ , getIndicesD
123+ -- , getFromThenTo
124+ , getIndexRev
160125
161− -- *** Capacity Management
126+ -- * Memory Management
162127 , blockSize
163128 , arrayChunkBytes
164129 , allocBytesToElemCount
165− , realloc -- this is "resize"
166− , grow
167− , growExp
130+ , realloc
131+ , resize
132+ , resizeExp
168133 , rightSize
169134
170− -- ** Folding
171− , foldl'
172− , foldr
173− , byteCmp
174− , byteEq
135+ -- * Size
136+ , length
137+ , byteLength
138+ -- , capacity
139+ , byteCapacity
140+ , bytesFree
175141
176− -- ** In-place Mutation Algorithms
142+ -- * In-place Mutation Algorithms
177143 , strip
178144 , reverse
179145 , permute
@@ -183,124 +149,66 @@ module Streamly.Internal.Data.MutArray.Type
183149 , mergeBy
184150 , bubble
185151
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.
152+ -- * Casting
153+ , cast
154+ , castUnsafe
155+ , asBytes
156+ , asPtrUnsafe
190157
191− -- *** Appending elements
192− , snocWith
193− , snoc
194− , snocLinear
195− , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
158+ -- * Folding
159+ , foldl'
160+ , foldr
161+ , cmp
162+
163+ -- * Arrays of arrays
164+ -- We can add dimensionality parameter to the array type to get
165+ -- multidimensional arrays. Multidimensional arrays would just be a
166+ -- convenience wrapper on top of single dimensional arrays.
167+
168+ -- | Operations dealing with multiple arrays, streams of arrays or
169+ -- multidimensional array representations.
170+
171+ -- ** Construct from streams
172+ , chunksOf
173+ , arrayStreamKFromStreamD
174+ , writeChunks
175+
176+ -- ** Eliminate to streams
177+ , flattenArrays
178+ , flattenArraysRev
179+ , fromArrayStreamK
197180
198− -- *** Appending streams
199− , unsafeAppendN
200− , appendN
201− , appendWith
202− , append
181+ -- ** Construct from arrays
182+ -- get chunks without copying
183+ , getSliceUnsafe
184+ , getSlice
185+ -- , getSlicesFromLenN
186+ , splitAt -- XXX should be able to express using getSlice
187+ , breakOn
203188
204− -- *** Appending arrays
189+ -- ** Appending arrays
205190 , spliceCopy
206191 , spliceWith
207192 , splice
208193 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
194+ , spliceUnsafe
195+ , putSliceUnsafe
210196 -- , putSlice
211197 -- , appendSlice
212198 -- , appendSliceFrom
213199
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
200+ -- * Utilities
264201 , roundUpToPower2
265202 , memcpy
266203 , memcmp
267204 , 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
301205 )
302206where
303207
208+-- Notes:
209+-- When we use a purely lazy Monad like Identity, we need to force ordering of
210+-- some actions for correctness.
211+
304212#include "assert.hs"
305213#include "inline.hs"
306214#include "ArrayMacros.h"
@@ -308,60 +216,61 @@ where
308216
309217import Control.Monad (when, void)
310218import Control.Monad.IO.Class (MonadIO(..))
311−import Data.Bifunctor (first)
312219import Data.Bits (shiftR, (.|.), (.&.))
313−import Data.Functor.Identity (Identity(..))
314220import Data.Proxy (Proxy(..))
315221import Data.Word (Word8)
316222import Foreign.C.Types (CSize(..), CInt(..))
317223import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
318−import Streamly.Internal.Data.MutByteArray.Type
319− ( MutByteArray(..)
320− , PinnedState(..)
224+import Streamly.Internal.Data.Unboxed
225+ ( MutableByteArray(..)
226+ , Unbox
321227 , getMutableByteArray#
322− , putSliceUnsafe
228+ , peekWith
229+ , pokeWith
230+ , sizeOf
231+ , touch
323232 )
324−import Streamly.Internal.Data.Unbox (Unbox(..))
325233import GHC.Base
326234 ( IO(..)
327235 , Int(..)
236+ , byteArrayContents#
328237 , compareByteArrays#
329238 , copyMutableByteArray#
330239 )
331240import GHC.Base (noinline)
332−import GHC.Exts (unsafeCoerce#, Addr#)
241+import GHC.Exts (unsafeCoerce#)
333242import GHC.Ptr (Ptr(..))
334243
335244import Streamly.Internal.Data.Fold.Type (Fold(..))
336245import Streamly.Internal.Data.Producer.Type (Producer (..))
337−import Streamly.Internal.Data.Stream.Type (Stream)
338−import Streamly.Internal.Data.Parser.Type (Parser (..))
339−import Streamly.Internal.Data.StreamK.Type (StreamK)
246+import Streamly.Internal.Data.Stream.StreamD.Type (Stream)
247+import Streamly.Internal.Data.Stream.StreamK.Type (StreamK)
340248import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341−import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
342249import Streamly.Internal.Data.Unfold.Type (Unfold(..))
343250import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
344251
345252import qualified Streamly.Internal.Data.Fold.Type as FL
346−import 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
349253import qualified Streamly.Internal.Data.Producer as Producer
350−import qualified Streamly.Internal.Data.Stream.Type as D
351−import qualified Streamly.Internal.Data.Stream.Lift as D
352−import qualified Streamly.Internal.Data.StreamK.Type as K
254+import qualified Streamly.Internal.Data.Stream.StreamD.Type as D
255+import qualified Streamly.Internal.Data.Stream.StreamK.Type as K
256+import qualified Streamly.Internal.Data.Unboxed as Unboxed
353257import qualified Prelude
354258
355259import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
260+ (length, foldr, read, unlines, splitAt, reverse, truncate)
357261
358−#include "DocTestDataMutArray.hs"
262+-- $setup
263+-- >>> :m
264+-- >>> import qualified Streamly.Internal.Data.Array.Mut.Type as MutArray
265+-- >>> import qualified Streamly.Internal.Data.Stream as Stream
266+-- >>> import qualified Streamly.Internal.Data.Stream.StreamD as StreamD
267+-- >>> import qualified Streamly.Internal.Data.Fold as Fold
268+-- >>> import qualified Streamly.Internal.Data.Fold.Type as Fold
359269
360270-------------------------------------------------------------------------------
361271-- Foreign helpers
362272-------------------------------------------------------------------------------
363273
364−-- NOTE: Have to be "ccall unsafe" so that we can pass unpinned memory to these
365274foreign import ccall unsafe "string.h memcpy" c_memcpy
366275 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
367276
@@ -371,9 +280,6 @@ foreign import ccall unsafe "string.h memchr" c_memchr
371280foreign import ccall unsafe "string.h memcmp" c_memcmp
372281 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO CInt
373282
374−foreign import ccall unsafe "string.h strlen" c_strlen
375− :: Ptr Word8 -> IO CSize
376−
377283-- | Given an 'Unboxed' type (unused first arg) and a number of bytes, return
378284-- how many elements of that type will completely fit in those bytes.
379285--
@@ -399,12 +305,14 @@ memcmp p1 p2 len = do
399305
400306-- $arrayNotes
401307--
402−-- We can use an 'Unboxed' constraint in the MutArray type and the constraint
403−-- can be automatically provided to a function that pattern matches on the
404−-- MutArray type. However, it has huge performance cost, so we do not use it.
308+-- We can use an 'Unboxed' constraint in the MutArray type and the constraint can
309+-- be automatically provided to a function that pattern matches on the MutArray
310+-- type. However, it has huge performance cost, so we do not use it.
405311-- Investigate a GHC improvement possiblity.
406312
407−-- | An unboxed mutable array. An array is created with a given length
313+-- XXX Rename the fields to better names.
314+
315+-- | An unboxed, pinned mutable array. An array is created with a given length
408316-- and capacity. Length is the number of valid elements in the array. Capacity
409317-- is the maximum number of elements that the array can be expanded to without
410318-- having to reallocate the memory.
@@ -428,7 +336,7 @@ data MutArray a =
428336 -- The array is a range into arrContents. arrContents may be a superset of
429337 -- the slice represented by the array. All offsets are in bytes.
430338 MutArray
431− { arrContents :: {-# UNPACK #-} !MutByteArray
339+ { arrContents :: {-# UNPACK #-} !MutableByteArray
432340 , arrStart :: {-# UNPACK #-} !Int -- ^ index into arrContents
433341 , arrEnd :: {-# UNPACK #-} !Int -- ^ index into arrContents
434342 -- Represents the first invalid index of
@@ -440,28 +348,17 @@ data MutArray a =
440348-- Pinning & Unpinning
441349-------------------------------------------------------------------------------
442350
443−-- | Return a copy of the array in pinned memory if unpinned, else return the
444−-- original array.
445351{-# INLINE pin #-}
446352pin :: MutArray a -> IO (MutArray a)
447−pin arr@MutArray{..} =
448− if Unboxed.isPinned arrContents
449− then pure arr
450− else pinnedClone arr
353+pin arr@MutArray{..} = do
354+ contents <- Unboxed.pin arrContents
355+ return $ arr {arrContents = contents}
451356
452−-- | Return a copy of the array in unpinned memory if pinned, else return the
453−-- original array.
454357{-# INLINE unpin #-}
455358unpin :: MutArray a -> IO (MutArray a)
456−unpin arr@MutArray{..} =
457− if Unboxed.isPinned arrContents
458− then clone arr
459− else pure arr
460−
461−-- | Return 'True' if the array is allocated in pinned memory.
462−{-# INLINE isPinned #-}
463−isPinned :: MutArray a -> Bool
464−isPinned MutArray{..} = Unboxed.isPinned arrContents
359+unpin arr@MutArray{..} = do
360+ contents <- Unboxed.unpin arrContents
361+ return $ arr {arrContents = contents}
465362
466363-------------------------------------------------------------------------------
467364-- Construction
@@ -476,11 +373,9 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
476373-- files and arrays.
477374
478375-- GHC always guarantees word-aligned memory, alignment is important only when
479−-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
376+-- we need more than that. See stg_newAlignedPinnedByteArrayzh and
480377-- allocatePinned in GHC source.
481378
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484379-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485380-- length and with a capacity to hold @count@ elements, using @allocator
486381-- size alignment@ as the memory allocator function.
@@ -493,7 +388,7 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
493388-- /Pre-release/
494389{-# INLINE newArrayWith #-}
495390newArrayWith :: forall m a. (MonadIO m, Unbox a)
496− => (Int -> Int -> m MutByteArray) -> Int -> Int -> m (MutArray a)
391+ => (Int -> Int -> m MutableByteArray) -> Int -> Int -> m (MutArray a)
497392newArrayWith alloc alignSize count = do
498393 let size = max (count * SIZE_OF(a)) 0
499394 contents <- alloc size alignSize
@@ -504,34 +399,27 @@ newArrayWith alloc alignSize count = do
504399 , arrBound = size
505400 }
506401
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." #-}
520402nil ::
521403#ifdef DEVBUILD
522404 Unbox a =>
523405#endif
524406 MutArray a
525−nil = empty
407+nil = MutArray Unboxed.nil 0 0 0
526408
527−{-# INLINE newBytesAs #-}
528−newBytesAs :: MonadIO m =>
409+
410+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
411+-- the array is uninitialized and the allocation is aligned as per the
412+-- 'Unboxed' instance of the type.
413+--
414+-- /Pre-release/
415+{-# INLINE newPinnedBytes #-}
416+newPinnedBytes :: MonadIO m =>
529417#ifdef DEVBUILD
530418 Unbox a =>
531419#endif
532− PinnedState -> Int -> m (MutArray a)
533−newBytesAs ps bytes = do
534− contents <- liftIO $ Unboxed.newBytesAs ps bytes
420+ Int -> m (MutArray a)
421+newPinnedBytes bytes = do
422+ contents <- liftIO $ Unboxed.newPinnedBytes bytes
535423 return $ MutArray
536424 { arrContents = contents
537425 , arrStart = 0
@@ -539,62 +427,52 @@ newBytesAs ps bytes = do
539427 , arrBound = bytes
540428 }
541429
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.
545−--
546−-- /Pre-release/
547−{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549−pinnedNewBytes :: MonadIO m =>
550−#ifdef DEVBUILD
551− Unbox a =>
552−#endif
553− Int -> m (MutArray a)
554−pinnedNewBytes = newBytesAs Pinned
555−
556430-- | Like 'newArrayWith' but using an allocator is a pinned memory allocator and
557431-- the alignment is dictated by the 'Unboxed' instance of the type.
558432--
559433-- /Internal/
560−{-# INLINE pinnedNewAligned #-}
561−pinnedNewAligned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
562−pinnedNewAligned =
563− newArrayWith (\s a -> liftIO $ Unboxed.pinnedNewAlignedBytes s a)
564−
565−{-# INLINE newAs #-}
566−newAs :: (MonadIO m, Unbox a) => PinnedState -> Int -> m (MutArray a)
567−newAs ps =
568− newArrayWith
569− (\s _ -> liftIO $ Unboxed.newBytesAs ps s)
570− (error "new: alignment is not used in unpinned arrays.")
434+{-# INLINE newAlignedPinned #-}
435+newAlignedPinned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
436+newAlignedPinned =
437+ newArrayWith (\s a -> liftIO $ Unboxed.newAlignedPinnedBytes s a)
571438
572439-- XXX can unaligned allocation be more efficient when alignment is not needed?
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." #-}
582−{-# INLINE pinnedNew #-}
583−pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
585−
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
588440--
589−{-# INLINE emptyOf #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
441+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
442+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
443+-- instance of the type.
444+--
445+{-# INLINE newPinned #-}
446+newPinned :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
447+newPinned =
448+ newArrayWith
449+ (\s _ -> liftIO $ Unboxed.newPinnedBytes s)
450+ (error "newPinned: alignSize is not used")
592451
593−-- XXX Deprecate in major
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
452+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
453+-- of the array is uninitialized.
454+--
595455{-# INLINE new #-}
596456new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
457+new =
458+ newArrayWith
459+ (\s _ -> liftIO $ Unboxed.newUnpinnedBytes s)
460+ (error "new: alignment is not used in unpinned arrays.")
461+
462+-- XXX This should create a full length uninitialzed array so that the pointer
463+-- can be used.
464+
465+-- | Allocate a pinned MutArray of the given size and run an IO action passing
466+-- the array start pointer.
467+--
468+-- /Internal/
469+{-# INLINE withNewArrayUnsafe #-}
470+withNewArrayUnsafe ::
471+ (MonadIO m, Unbox a) => Int -> (Ptr a -> m ()) -> m (MutArray a)
472+withNewArrayUnsafe count f = do
473+ arr <- newPinned count
474+ asPtrUnsafe arr
475+ $ \p -> f p >> return arr
598476
599477-------------------------------------------------------------------------------
600478-- Random writes
@@ -610,7 +488,7 @@ putIndexUnsafe :: forall m a. (MonadIO m, Unbox a)
610488putIndexUnsafe i MutArray{..} x = do
611489 let index = INDEX_OF(arrStart, i, a)
612490 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
613− liftIO $ pokeAt index arrContents x
491+ liftIO $ pokeWith arrContents index x
614492
615493invalidIndex :: String -> Int -> a
616494invalidIndex label i =
@@ -628,7 +506,7 @@ putIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m ()
628506putIndex i MutArray{..} x = do
629507 let index = INDEX_OF(arrStart,i,a)
630508 if i >= 0 && INDEX_VALID(index,arrEnd,a)
631− then liftIO $ pokeAt index arrContents x
509+ then liftIO $ pokeWith arrContents index x
632510 else invalidIndex "putIndex" i
633511
634512-- | Write an input stream of (index, value) pairs to an array. Throws an
@@ -642,21 +520,19 @@ putIndices arr = FL.foldlM' step (return ())
642520
643521 where
644522
645− step () (i, x) = putIndex i arr x
523+ step () (i, x) = liftIO (putIndex i arr x)
646524
647525-- | Modify a given index of an array using a modifier function.
648526--
649−-- Unsafe because it does not check the bounds of the array.
650−--
651527-- /Pre-release/
652528modifyIndexUnsafe :: forall m a b. (MonadIO m, Unbox a) =>
653529 Int -> MutArray a -> (a -> (a, b)) -> m b
654530modifyIndexUnsafe i MutArray{..} f = liftIO $ do
655531 let index = INDEX_OF(arrStart,i,a)
656532 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
657− r <- peekAt index arrContents
533+ r <- peekWith arrContents index
658534 let (x, res) = f r
659− pokeAt index arrContents x
535+ pokeWith arrContents index x
660536 return res
661537
662538-- | Modify a given index of an array using a modifier function.
@@ -668,12 +544,13 @@ modifyIndex i MutArray{..} f = do
668544 let index = INDEX_OF(arrStart,i,a)
669545 if i >= 0 && INDEX_VALID(index,arrEnd,a)
670546 then liftIO $ do
671− r <- peekAt index arrContents
547+ r <- peekWith arrContents index
672548 let (x, res) = f r
673− pokeAt index arrContents x
549+ pokeWith arrContents index x
674550 return res
675551 else invalidIndex "modifyIndex" i
676552
553+
677554-- | Modify the array indices generated by the supplied stream.
678555--
679556-- /Pre-release/
@@ -692,8 +569,6 @@ modifyIndices arr f = FL.foldlM' step initial
692569
693570-- | Modify each element of an array using the supplied modifier function.
694571--
695−-- This is an in-place equivalent of an immutable map operation.
696−--
697572-- /Pre-release/
698573modify :: forall m a. (MonadIO m, Unbox a)
699574 => MutArray a -> (a -> a) -> m ()
@@ -704,8 +579,8 @@ modify MutArray{..} f = liftIO $
704579
705580 go i =
706581 when (INDEX_VALID(i,arrEnd,a)) $ do
707− r <- peekAt i arrContents
708− pokeAt i arrContents (f r)
582+ r <- peekWith arrContents i
583+ pokeWith arrContents i (f r)
709584 go (INDEX_NEXT(i,a))
710585
711586-- XXX We could specify the number of bytes to swap instead of Proxy. Need
@@ -714,15 +589,15 @@ modify MutArray{..} f = liftIO $
714589swapArrayByteIndices ::
715590 forall a. Unbox a
716591 => Proxy a
717− -> MutByteArray
592+ -> MutableByteArray
718593 -> Int
719594 -> Int
720595 -> IO ()
721596swapArrayByteIndices _ arrContents i1 i2 = do
722− r1 <- peekAt i1 arrContents
723− r2 <- peekAt i2 arrContents
724− pokeAt i1 arrContents (r2 :: a)
725− pokeAt i2 arrContents (r1 :: a)
597+ r1 <- peekWith arrContents i1
598+ r2 <- peekWith arrContents i2
599+ pokeWith arrContents i1 (r2 :: a)
600+ pokeWith arrContents i2 (r1 :: a)
726601
727602-- | Swap the elements at two indices without validating the indices.
728603--
@@ -838,23 +713,23 @@ arrayChunkBytes = 1024
838713roundDownTo :: Int -> Int -> Int
839714roundDownTo elemSize size = size - (size `mod` elemSize)
840715
716+-- XXX See if resizing can be implemented by reading the old array as a stream
717+-- and then using writeN to the new array.
718+--
841719-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842720-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843721-- which complicates some inspection tests.
844722--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
723+{-# NOINLINE reallocExplicit #-}
724+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
725+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848726 assertM(arrEnd <= arrBound)
849727
850728 -- Allocate new array
851729 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852− contents <-
853− if ps == Pinned
854− then Unboxed.pinnedNew newCapMaxInBytes
855− else Unboxed.new newCapMaxInBytes
856− let !(MutByteArray mbarrFrom#) = arrContents
857− !(MutByteArray mbarrTo#) = contents
730+ contents <- Unboxed.newPinnedBytes newCapMaxInBytes
731+ let !(MutableByteArray mbarrFrom#) = arrContents
732+ !(MutableByteArray mbarrTo#) = contents
858733
859734 -- Copy old data
860735 let oldStart = arrStart
@@ -875,10 +750,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875750 , arrBound = newCapInBytes
876751 }
877752
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−
882753-- | @realloc newCapacity array@ reallocates the array to the specified
883754-- capacity in bytes.
884755--
@@ -887,15 +758,9 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
887758-- down to multiples of array size. If the new size is more than
888759-- 'largeObjectThreshold' then it is rounded up to the block size (4K).
889760--
890−-- If the original array is pinned, the newly allocated array is also pinned.
891761{-# INLINABLE realloc #-}
892762realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
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
763+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899764
900765-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901766-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +783,14 @@ reallocWith label capSizer minIncrBytes arr = do
918783 where
919784
920785 badSize newSize =
921− Prelude.concat
786+ concat
922787 [ label
923788 , ": new array size (in bytes) is less than required size "
924789 , show newSize
925790 , ". Please check the sizing function passed."
926791 ]
927792
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
793+-- | @resize newCapacity array@ changes the total capacity of the array so that
929794-- it is enough to hold the specified number of elements. Nothing is done if
930795-- the specified capacity is less than the length of the array.
931796--
@@ -933,46 +798,34 @@ reallocWith label capSizer minIncrBytes arr = do
933798-- the block size (4K).
934799--
935800-- /Pre-release/
936−{-# INLINE grow #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
801+{-# INLINE resize #-}
802+resize :: forall m a. (MonadIO m, Unbox a) =>
938803 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
804+resize nElems arr@MutArray{..} = do
940805 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
942− if req < cap
806+ len = arrEnd - arrStart
807+ if req < len
943808 then return arr
944809 else realloc req arr
945810
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.
811+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
812+-- then it is rounded up to the closest power of 2.
954813--
955814-- /Pre-release/
956−{-# INLINE growExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
815+{-# INLINE resizeExp #-}
816+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958817 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
818+resizeExp nElems arr@MutArray{..} = do
960819 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
961820 req1 =
962821 if req > largeObjectThreshold
963822 then roundUpToPower2 req
964823 else req
965− cap = arrBound - arrStart
966− if req1 < cap
824+ len = arrEnd - arrStart
825+ if req1 < len
967826 then return arr
968827 else realloc req1 arr
969828
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−
976829-- | Resize the allocated memory to drop any reserved free space at the end of
977830-- the array and reallocate it to reduce wastage.
978831--
@@ -1017,7 +870,7 @@ rightSize arr@MutArray{..} = do
1017870snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
1018871snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1019872 assert (newEnd <= arrBound) (return ())
1020− pokeAt arrEnd arrContents x
873+ pokeWith arrContents arrEnd x
1021874 return $ arr {arrEnd = newEnd}
1022875
1023876-- | Really really unsafe, appends the element into the first array, may
@@ -1037,7 +890,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037890{-# INLINE snocMay #-}
1038891snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039892 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
893+snocMay arr@MutArray{..} x = liftIO $ do
1041894 let newEnd = INDEX_NEXT(arrEnd,a)
1042895 if newEnd <= arrBound
1043896 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +904,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1051904 -> a
1052905 -> m (MutArray a)
1053906snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
907+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055908 snocUnsafe arr1 x
1056909
1057910-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +926,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073926 -> MutArray a
1074927 -> a
1075928 -> m (MutArray a)
1076−snocWith allocSize arr x = do
929+snocWith allocSize arr x = liftIO $ do
1077930 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078931 if newEnd <= arrBound arr
1079932 then snocNewEnd newEnd arr x
@@ -1117,126 +970,6 @@ snoc = snocWith f
1117970 then oldSize * 2
1118971 else roundUpToPower2 oldSize * 2
1119972
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−
1240973-------------------------------------------------------------------------------
1241974-- Random reads
1242975-------------------------------------------------------------------------------
@@ -1251,17 +984,17 @@ getIndexUnsafe :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1251984getIndexUnsafe i MutArray{..} = do
1252985 let index = INDEX_OF(arrStart,i,a)
1253986 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
1254− liftIO $ peekAt index arrContents
987+ liftIO $ peekWith arrContents index
1255988
1256989-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
1257990--
1258991{-# INLINE getIndex #-}
1259−getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (Maybe a)
992+getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1260993getIndex i MutArray{..} = do
1261994 let index = INDEX_OF(arrStart,i,a)
1262995 if i >= 0 && INDEX_VALID(index,arrEnd,a)
1263− then liftIO $ Just <$> peekAt index arrContents
1264− else return Nothing
996+ then liftIO $ peekWith arrContents index
997+ else invalidIndex "getIndex" i
1265998
1266999-- | /O(1)/ Lookup the element at the given index from the end of the array.
12671000-- Index starts from 0.
@@ -1273,16 +1006,21 @@ getIndexRev :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
12731006getIndexRev i MutArray{..} = do
12741007 let index = RINDEX_OF(arrEnd,i,a)
12751008 if i >= 0 && index >= arrStart
1276− then liftIO $ peekAt index arrContents
1009+ then liftIO $ peekWith arrContents index
12771010 else invalidIndex "getIndexRev" i
12781011
12791012data GetIndicesState contents start end st =
12801013 GetIndicesState contents start end st
12811014
1282−{-# INLINE indexReaderWith #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1015+-- | Given an unfold that generates array indices, read the elements on those
1016+-- indices from the supplied MutArray. An error is thrown if an index is out of
1017+-- bounds.
1018+--
1019+-- /Pre-release/
1020+{-# INLINE getIndicesD #-}
1021+getIndicesD :: (Monad m, Unbox a) =>
12841022 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1285−indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1023+getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
12861024
12871025 where
12881026
@@ -1295,32 +1033,13 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
12951033 case r of
12961034 D.Yield i s -> do
12971035 x <- liftio $ getIndex i (MutArray contents start end undefined)
1298− case x of
1299− Just v -> return $ D.Yield v (GetIndicesState contents start end s)
1300− Nothing -> error "Invalid Index"
1036+ return $ D.Yield x (GetIndicesState contents start end s)
13011037 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
13021038 D.Stop -> return D.Stop
13031039
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." #-}
13211040{-# INLINE getIndices #-}
13221041getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1042+getIndices = getIndicesD liftIO
13241043
13251044-------------------------------------------------------------------------------
13261045-- Subarrays
@@ -1425,7 +1144,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
14251144
14261145 -- Invariant low < high on entry, and on return as well
14271146 moveHigh low high = do
1428− h <- peekAt high arrContents
1147+ h <- peekWith arrContents high
14291148 if f h
14301149 then
14311150 -- Correctly classified, continue the loop
@@ -1445,7 +1164,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
14451164 -- low <= high
14461165 -- Both low and high are valid locations within the array
14471166 go low high = do
1448− l <- peekAt low arrContents
1167+ l <- peekWith arrContents low
14491168 if f l
14501169 then
14511170 -- low is wrongly classified
@@ -1456,8 +1175,8 @@ partitionBy f arr@MutArray{..} = liftIO $ do
14561175 case r of
14571176 Nothing -> return low
14581177 Just (high1, h) -> do -- low < high1
1459− pokeAt low arrContents h
1460− pokeAt high1 arrContents l
1178+ pokeWith arrContents low h
1179+ pokeWith arrContents high1 l
14611180 let low1 = INDEX_NEXT(low,a)
14621181 high2 = INDEX_PREV(high1,a)
14631182 if low1 <= high2
@@ -1569,10 +1288,20 @@ data GroupState s contents start end bound
15691288 contents start end bound (GroupState s contents start end bound)
15701289 | GroupFinish
15711290
1572−{-# INLINE_NORMAL chunksOfAs #-}
1573−chunksOfAs :: forall m a. (MonadIO m, Unbox a)
1574− => PinnedState -> Int -> D.Stream m a -> D.Stream m (MutArray a)
1575−chunksOfAs ps n (D.Stream step state) =
1291+-- | @chunksOf n stream@ groups the input stream into a stream of
1292+-- arrays of size n.
1293+--
1294+-- @chunksOf n = StreamD.foldMany (MutArray.writeN n)@
1295+--
1296+-- /Pre-release/
1297+{-# INLINE_NORMAL chunksOf #-}
1298+chunksOf :: forall m a. (MonadIO m, Unbox a)
1299+ => Int -> D.Stream m a -> D.Stream m (MutArray a)
1300+-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1301+-- benchmark. It seems it has difficulty producing optimized code when
1302+-- converting to StreamK. Investigate GHC optimizations.
1303+-- chunksOf n = D.foldMany (writeN n)
1304+chunksOf n (D.Stream step state) =
15761305 D.Stream step' (GroupStart state)
15771306
15781307 where
@@ -1584,14 +1313,14 @@ chunksOfAs ps n (D.Stream step state) =
15841313 error $ "Streamly.Internal.Data.MutArray.Mut.Type.chunksOf: "
15851314 ++ "the size of arrays [" ++ show n
15861315 ++ "] must be a natural number"
1587− (MutArray contents start end bound :: MutArray a) <- newAs ps n
1316+ (MutArray contents start end bound :: MutArray a) <- liftIO $ newPinned n
15881317 return $ D.Skip (GroupBuffer st contents start end bound)
15891318
15901319 step' gst (GroupBuffer st contents start end bound) = do
15911320 r <- step (adaptState gst) st
15921321 case r of
15931322 D.Yield x s -> do
1594− liftIO $ pokeAt end contents x
1323+ liftIO $ pokeWith contents end x
15951324 let end1 = INDEX_NEXT(end,a)
15961325 return $
15971326 if end1 >= bound
@@ -1610,51 +1339,14 @@ chunksOfAs ps n (D.Stream step state) =
16101339
16111340 step' _ GroupFinish = return D.Stop
16121341
1613−-- | @chunksOf n stream@ groups the elements in the input stream into arrays of
1614−-- @n@ elements each.
1615−--
1616−-- Same as the following but may be more efficient:
1617−--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1619−--
1620−-- /Pre-release/
1621−{-# INLINE_NORMAL chunksOf #-}
1622−chunksOf :: forall m a. (MonadIO m, Unbox a)
1623− => Int -> D.Stream m a -> D.Stream m (MutArray a)
1624−-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1625−-- benchmark. It seems it has difficulty producing optimized code when
1626−-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1628−chunksOf = chunksOfAs Unpinned
1629−
1630−-- | Like 'chunksOf' but creates pinned arrays.
1631−{-# INLINE_NORMAL pinnedChunksOf #-}
1632−pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1633− => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1635−pinnedChunksOf = chunksOfAs Pinned
1636−
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−
16501342-- XXX buffer to a list instead?
16511343-- | Buffer the stream into arrays in memory.
1652−{-# INLINE arrayStreamKFromStreamDAs #-}
1653−arrayStreamKFromStreamDAs :: forall m a. (MonadIO m, Unbox a) =>
1654− PinnedState -> D.Stream m a -> m (StreamK m (MutArray a))
1655−arrayStreamKFromStreamDAs ps =
1344+{-# INLINE arrayStreamKFromStreamD #-}
1345+arrayStreamKFromStreamD :: forall m a. (MonadIO m, Unbox a) =>
1346+ D.Stream m a -> m (StreamK m (MutArray a))
1347+arrayStreamKFromStreamD =
16561348 let n = allocBytesToElemCount (undefined :: a) defaultChunkSize
1657− in D.foldr K.cons K.nil . chunksOfAs ps n
1349+ in D.foldr K.cons K.nil . chunksOf n
16581350
16591351-------------------------------------------------------------------------------
16601352-- Streams of arrays - Flattening
@@ -1664,10 +1356,16 @@ data FlattenState s contents a =
16641356 OuterLoop s
16651357 | InnerLoop s contents !Int !Int
16661358
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)
1359+-- | Use the "reader" unfold instead.
1360+--
1361+-- @flattenArrays = unfoldMany reader@
1362+--
1363+-- We can try this if there are any fusion issues in the unfold.
1364+--
1365+{-# INLINE_NORMAL flattenArrays #-}
1366+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1367+ => D.Stream m (MutArray a) -> D.Stream m a
1368+flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
16711369
16721370 where
16731371
@@ -1684,30 +1382,19 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841382 return $ D.Skip $ OuterLoop st
16851383
16861384 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1385+ x <- liftIO $ peekWith contents p
16881386 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891387
1690−-- | Use the "reader" unfold instead.
1388+-- | Use the "readerRev" unfold instead.
16911389--
1692−-- @concat = unfoldMany reader@
1390+-- @flattenArrays = unfoldMany readerRev@
16931391--
16941392-- We can try this if there are any fusion issues in the unfold.
16951393--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1698− => D.Stream m (MutArray a) -> D.Stream m a
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)
1394+{-# INLINE_NORMAL flattenArraysRev #-}
1395+flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17041396 => 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)
1397+flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111398
17121399 where
17131400
@@ -1725,33 +1412,16 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251412 return $ D.Skip $ OuterLoop st
17261413
17271414 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1415+ x <- liftIO $ peekWith contents p
17291416 let cur = INDEX_PREV(p,a)
17301417 return $ D.Yield x (InnerLoop st contents cur start)
17311418
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−
17491419-------------------------------------------------------------------------------
17501420-- Unfolds
17511421-------------------------------------------------------------------------------
17521422
17531423data ArrayUnsafe a = ArrayUnsafe
1754− {-# UNPACK #-} !MutByteArray -- contents
1424+ {-# UNPACK #-} !MutableByteArray -- contents
17551425 {-# UNPACK #-} !Int -- index 1
17561426 {-# UNPACK #-} !Int -- index 2
17571427
@@ -1781,7 +1451,7 @@ producerWith liftio = Producer step (return . toArrayUnsafe) extract
17811451 -- few actions for correctness and execution order sanity. We want
17821452 -- the peek to occur right here and not lazily at some later point
17831453 -- because we want the peek to be ordered with respect to the touch.
1784− !x <- liftio $ peekAt cur contents
1454+ !x <- liftio $ peekWith contents cur
17851455 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
17861456
17871457 extract = return . fromArrayUnsafe
@@ -1812,7 +1482,7 @@ readerRevWith liftio = Unfold step inject
18121482 {-# INLINE_LATE step #-}
18131483 step (ArrayUnsafe _ start p) | p < start = return D.Stop
18141484 step (ArrayUnsafe contents start p) = do
1815− !x <- liftio $ peekAt p contents
1485+ !x <- liftio $ peekWith contents p
18161486 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
18171487
18181488-- | Unfold an array into a stream in reverse order.
@@ -1843,15 +1513,14 @@ toListFB c n MutArray{..} = go arrStart
18431513 -- evaluated/written to before we peek at them.
18441514 -- XXX
18451515 let !x = unsafeInlineIO $ do
1846− r <- peekAt arrContents p
1516+ r <- peekWith arrContents p
18471517 return r
18481518 in c x (go (PTR_NEXT(p,a)))
18491519-}
18501520
18511521-- XXX Monadic foldr/build fusion?
18521522-- Reference: https://www.researchgate.net/publication/220676509_Monadic_augment_and_generalised_short_cut_fusion
1853−
1854−-- | Convert a 'MutArray' into a list.
1523+-- | Convert an 'MutArray' into a list.
18551524--
18561525{-# INLINE toList #-}
18571526toList :: forall m a. (MonadIO m, Unbox a) => MutArray a -> m [a]
@@ -1860,30 +1529,31 @@ toList MutArray{..} = liftIO $ go arrStart
18601529
18611530 go p | assert (p <= arrEnd) (p == arrEnd) = return []
18621531 go p = do
1863− x <- peekAt p arrContents
1532+ x <- peekWith arrContents p
18641533 (:) x <$> go (INDEX_NEXT(p,a))
18651534
1866−{-# INLINE_NORMAL toStreamWith #-}
1867−toStreamWith ::
1535+{-# INLINE_NORMAL toStreamDWith #-}
1536+toStreamDWith ::
18681537 forall m a. (Monad m, Unbox a)
18691538 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1870−toStreamWith liftio MutArray{..} = D.Stream step arrStart
1539+toStreamDWith liftio MutArray{..} = D.Stream step arrStart
18711540
18721541 where
18731542
18741543 {-# INLINE_LATE step #-}
18751544 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
18761545 step _ p = liftio $ do
1877− r <- peekAt p arrContents
1546+ r <- peekWith arrContents p
18781547 return $ D.Yield r (INDEX_NEXT(p,a))
18791548
1880−-- | Convert a 'MutArray' into a stream.
1549+-- | Use the 'reader' unfold instead.
18811550--
1882−-- >>> read = Stream.unfold MutArray.reader
1551+-- @toStreamD = D.unfold reader@
18831552--
1884−{-# INLINE_NORMAL read #-}
1885−read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1886−read = toStreamWith liftIO
1553+-- We can try this if the unfold has any performance issues.
1554+{-# INLINE_NORMAL toStreamD #-}
1555+toStreamD :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1556+toStreamD = toStreamDWith liftIO
18871557
18881558{-# INLINE toStreamKWith #-}
18891559toStreamKWith ::
@@ -1895,18 +1565,18 @@ toStreamKWith liftio MutArray{..} = go arrStart
18951565
18961566 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
18971567 | otherwise =
1898− let elemM = peekAt p arrContents
1568+ let elemM = peekWith arrContents p
18991569 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
19001570
19011571{-# INLINE toStreamK #-}
19021572toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
19031573toStreamK = toStreamKWith liftIO
19041574
1905−{-# INLINE_NORMAL toStreamRevWith #-}
1906−toStreamRevWith ::
1575+{-# INLINE_NORMAL toStreamDRevWith #-}
1576+toStreamDRevWith ::
19071577 forall m a. (Monad m, Unbox a)
19081578 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1909−toStreamRevWith liftio MutArray{..} =
1579+toStreamDRevWith liftio MutArray{..} =
19101580 let p = INDEX_PREV(arrEnd,a)
19111581 in D.Stream step p
19121582
@@ -1915,16 +1585,17 @@ toStreamRevWith liftio MutArray{..} =
19151585 {-# INLINE_LATE step #-}
19161586 step _ p | p < arrStart = return D.Stop
19171587 step _ p = liftio $ do
1918− r <- peekAt p arrContents
1588+ r <- peekWith arrContents p
19191589 return $ D.Yield r (INDEX_PREV(p,a))
19201590
1921−-- | Convert a 'MutArray' into a stream in reverse order.
1591+-- | Use the 'readerRev' unfold instead.
19221592--
1923−-- >>> readRev = Stream.unfold MutArray.readerRev
1593+-- @toStreamDRev = D.unfold readerRev@
19241594--
1925−{-# INLINE_NORMAL readRev #-}
1926−readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1927−readRev = toStreamRevWith liftIO
1595+-- We can try this if the unfold has any perf issues.
1596+{-# INLINE_NORMAL toStreamDRev #-}
1597+toStreamDRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1598+toStreamDRev = toStreamDRevWith liftIO
19281599
19291600{-# INLINE toStreamKRevWith #-}
19301601toStreamKRevWith ::
@@ -1938,7 +1609,7 @@ toStreamKRevWith liftio MutArray {..} =
19381609
19391610 go p | p < arrStart = K.nil
19401611 | otherwise =
1941− let elemM = peekAt p arrContents
1612+ let elemM = peekWith arrContents p
19421613 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
19431614
19441615{-# INLINE toStreamKRev #-}
@@ -1955,12 +1626,12 @@ toStreamKRev = toStreamKRevWith liftIO
19551626-- | Strict left fold of an array.
19561627{-# INLINE_NORMAL foldl' #-}
19571628foldl' :: (MonadIO m, Unbox a) => (b -> a -> b) -> b -> MutArray a -> m b
1958−foldl' f z arr = D.foldl' f z $ read arr
1629+foldl' f z arr = D.foldl' f z $ toStreamD arr
19591630
19601631-- | Right fold of an array.
19611632{-# INLINE_NORMAL foldr #-}
19621633foldr :: (MonadIO m, Unbox a) => (a -> b -> b) -> b -> MutArray a -> m b
1963−foldr f z arr = D.foldr f z $ read arr
1634+foldr f z arr = D.foldr f z $ toStreamD arr
19641635
19651636-------------------------------------------------------------------------------
19661637-- Folds
@@ -1973,7 +1644,7 @@ foldr f z arr = D.foldr f z $ read arr
19731644
19741645-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751646
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1647+-- | @writeAppendNUnsafe n alloc@ appends up to @n@ input items to the supplied
19771648-- array.
19781649--
19791650-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1653,13 @@ foldr f z arr = D.foldr f z $ read arr
19821653-- Any free space left in the array after appending @n@ elements is lost.
19831654--
19841655-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1656+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1657+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871658 Int
19881659 -> m (MutArray a)
19891660 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1661+writeAppendNUnsafe n action =
1662+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911663
19921664 where
19931665
@@ -2000,59 +1672,38 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001672 -- otherwise we lose that space.
20011673 arr1 <-
20021674 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1675+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041676 else return arr
20051677 return $ toArrayUnsafe arr1
20061678
20071679 step (ArrayUnsafe contents start end) x = do
2008− liftIO $ pokeAt end contents x
1680+ liftIO $ pokeWith contents end x
20091681 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101682
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−
20191683-- | Append @n@ elements to an existing array. Any free space left in the array
20201684-- after appending @n@ elements is lost.
20211685--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1686+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231687--
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 #-}
1688+{-# INLINE_NORMAL writeAppendN #-}
20321689writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331690 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1691+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351692
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1693+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371694-- append the input stream. If there is no reserved space available in the
20381695-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391696-- where @oldSize@ is the current size of the array in bytes.
20401697--
20411698-- Note that the returned array may be a mutated version of original array.
20421699--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1700+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441701--
20451702-- /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." #-}
20521703{-# INLINE writeAppendWith #-}
20531704writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541705 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1706+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561707
20571708-- | @append action@ mutates the array generated by @action@ to append the
20581709-- input stream. If there is no reserved space available in the array it is
@@ -2060,144 +1711,72 @@ writeAppendWith = appendWith
20601711--
20611712-- Note that the returned array may be a mutated version of original array.
20621713--
2063−-- >>> append = MutArray.appendWith (* 2)
1714+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641715--
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." #-}
20721716{-# INLINE writeAppend #-}
20731717writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741718 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1719+writeAppend = writeAppendWith (* 2)
20761720
20771721-- XXX We can carry bound as well in the state to make sure we do not lose the
20781722-- remaining capacity. Need to check perf impact.
20791723--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1724+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1725+-- as argument.
20821726--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1727+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841728--
20851729-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1730+{-# INLINE_NORMAL writeNWithUnsafe #-}
1731+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881732 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1733+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901734
20911735 where
20921736
20931737 initial = toArrayUnsafe <$> alloc (max n 0)
20941738
20951739 step (ArrayUnsafe contents start end) x = do
2096− liftIO $ pokeAt end contents x
1740+ liftIO $ pokeWith contents end x
20971741 return
20981742 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991743
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−
2106−{-# INLINE_NORMAL writeNUnsafeAs #-}
2107−writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
2108− => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
2110−
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1744+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121745-- driver must not call the step function more than 'n' times otherwise it will
21131746-- corrupt the memory and crash. This function exists mainly because any
21141747-- conditional in the step function blocks fusion causing 10x performance
21151748-- slowdown.
21161749--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1750+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.newPinned
21181751--
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 #-}
1752+{-# INLINE_NORMAL writeNUnsafe #-}
21261753writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271754 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1755+writeNUnsafe = writeNWithUnsafe newPinned
21291756
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 #-}
2138−pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
2139− => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
2141−
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1757+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431758-- allocated using the @alloc@ function.
21441759--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1760+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1761+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471762--
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 #-}
1763+{-# INLINE_NORMAL writeNWith #-}
21551764writeNWith :: forall m a. (MonadIO m, Unbox a)
21561765 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
2158−
2159−{-# INLINE_NORMAL writeNAs #-}
2160−writeNAs ::
2161− forall m a. (MonadIO m, Unbox a)
2162− => PinnedState
2163− -> Int
2164− -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1766+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21661767
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1768+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681769-- 'MutArray'.
21691770--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1771+-- >>> writeN = MutArray.writeNWith MutArray.newPinned
1772+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1773+-- >>> writeN n = MutArray.writeAppendN n (MutArray.newPinned n)
21731774--
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 #-}
1775+{-# INLINE_NORMAL writeN #-}
21811776writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
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
1777+writeN = writeNWith newPinned
21911778
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
2194−pinnedWriteN ::
2195− forall m a. (MonadIO m, Unbox a)
2196− => Int
2197− -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
2199−
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1779+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011780--
22021781-- /Internal/
22031782{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2214,11 +1793,11 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22141793
22151794 step (ArrayUnsafe contents start end) x = do
22161795 let ptr = INDEX_PREV(start,a)
2217− liftIO $ pokeAt ptr contents x
1796+ liftIO $ pokeWith contents ptr x
22181797 return
22191798 $ ArrayUnsafe contents ptr end
22201799
2221−-- | Like createOfWith but writes the array in reverse order.
1800+-- | Like writeNWith but writes the array in reverse order.
22221801--
22231802-- /Internal/
22241803{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1805,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261805 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271806writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281807
2229−-- | Like 'createOf' but writes the array in reverse order.
1808+-- | Like writeN but writes the array in reverse order.
22301809--
22311810-- /Pre-release/
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 #-}
1811+{-# INLINE_NORMAL writeRevN #-}
22381812writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1813+writeRevN = writeRevNWith newPinned
22401814
2241−-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
2242−-- input stream to a 'MutArray' aligned to the given size.
1815+-- | @writeNAligned align n@ folds a maximum of @n@ elements from the input
1816+-- stream to an 'MutArray' aligned to the given size.
22431817--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1818+-- >>> writeNAligned align = MutArray.writeNWith (MutArray.newAlignedPinned align)
1819+-- >>> writeNAligned align n = MutArray.writeAppendN n (MutArray.newAlignedPinned align n)
22461820--
22471821-- /Pre-release/
22481822--
2249−{-# INLINE_NORMAL pinnedWriteNAligned #-}
2250−pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1823+{-# INLINE_NORMAL writeNAligned #-}
1824+writeNAligned :: forall m a. (MonadIO m, Unbox a)
22511825 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1826+writeNAligned align = writeNWith (newAlignedPinned align)
22531827
22541828-- XXX Buffer to a list instead?
2255−
1829+--
22561830-- | Buffer a stream into a stream of arrays.
22571831--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1832+-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591833--
22601834-- Breaking an array into an array stream can be useful to consume a large
22611835-- array sequentially such that memory of the array is released incrementatlly.
@@ -2264,43 +1838,14 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22641838--
22651839-- /Unimplemented/
22661840--
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 #-}
1841+{-# INLINE_NORMAL writeChunks #-}
22741842writeChunks :: (MonadIO m, Unbox a) =>
22751843 Int -> Fold m a (StreamK n (MutArray a))
2276−writeChunks = buildChunks
2277−
2278−{-# INLINE_NORMAL writeWithAs #-}
2279−writeWithAs :: forall m a. (MonadIO m, Unbox a)
2280− => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
2282−writeWithAs ps elemCount =
2283− FL.rmapM extract $ FL.foldlM' step initial
2284−
2285− where
1844+writeChunks n = FL.many (writeN n) FL.toStreamK
22861845
2287− initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2289− newAs ps elemCount
2290−
2291− step arr@(MutArray _ start end bound) x
2292− | INDEX_NEXT(end,a) > bound = do
2293− let oldSize = end - start
2294− newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
2296− snocUnsafe arr1 x
2297− step arr x = snocUnsafe arr x
2298−
2299− extract = liftIO . rightSize
2300−
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
1846+-- XXX Compare writeWith with fromStreamD which uses an array of streams
1847+-- implementation. We can write this using writeChunks above if that is faster.
1848+-- If writeWith is faster then we should use that to implement
23041849-- fromStreamD.
23051850--
23061851-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,92 +1860,75 @@ writeWithAs ps elemCount =
23151860-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23161861-- malloc to compare against.
23171862
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
1863+-- | @writeWith minCount@ folds the whole input to a single array. The array
23191864-- starts at a size big enough to hold minCount elements, the size is doubled
23201865-- every time the array needs to be grown.
23211866--
23221867-- /Caution! Do not use this on infinite streams./
23231868--
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)
1869+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.newPinned n)
1870+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
1871+-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
23271872--
23281873-- /Pre-release/
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 #-}
1874+{-# INLINE_NORMAL writeWith #-}
23371875writeWith :: forall m a. (MonadIO m, Unbox a)
23381876 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
1877+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (newPinned n)
1878+writeWith elemCount =
1879+ FL.rmapM extract $ FL.foldlM' step initial
1880+
1881+ where
1882+
1883+ initial = do
1884+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1885+ liftIO $ newPinned elemCount
1886+
1887+ step arr@(MutArray _ start end bound) x
1888+ | INDEX_NEXT(end,a) > bound = do
1889+ let oldSize = end - start
1890+ newSize = max (oldSize * 2) 1
1891+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
1892+ snocUnsafe arr1 x
1893+ step arr x = snocUnsafe arr x
1894+
1895+ extract = liftIO . rightSize
23401896
23411897-- | Fold the whole input to a single array.
23421898--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
1899+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23441900-- rounded up to the element size.
23451901--
23461902-- /Caution! Do not use this on infinite streams./
23471903--
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." #-}
23541904{-# INLINE write #-}
23551905write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2357−
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." #-}
2365−{-# INLINE pinnedWrite #-}
2366−pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
1906+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23681907
23691908-------------------------------------------------------------------------------
23701909-- construct from streams, known size
23711910-------------------------------------------------------------------------------
23721911
2373−{-# INLINE_NORMAL fromStreamDNAs #-}
2374−fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
2375− => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
2376−fromStreamDNAs ps limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
1912+-- | Use the 'writeN' fold instead.
1913+--
1914+-- >>> fromStreamDN n = StreamD.fold (MutArray.writeN n)
1915+--
1916+{-# INLINE_NORMAL fromStreamDN #-}
1917+fromStreamDN :: forall m a. (MonadIO m, Unbox a)
1918+ => Int -> D.Stream m a -> m (MutArray a)
1919+-- fromStreamDN n = D.fold (writeN n)
1920+fromStreamDN limit str = do
1921+ (arr :: MutArray a) <- liftIO $ newPinned limit
23781922 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
23791923 return $ arr {arrEnd = end}
23801924
23811925 where
23821926
23831927 fwrite arrContents ptr x = do
2384− liftIO $ pokeAt ptr arrContents x
1928+ liftIO $ pokeWith arrContents ptr x
23851929 return $ INDEX_NEXT(ptr,a)
23861930
2387−-- | Use the 'createOf' fold instead.
2388−--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2390−--
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 #-}
2399−fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2400− => Int -> D.Stream m a -> m (MutArray a)
2401−fromStreamDN = fromStreamN
2402−
2403−-- | Create a 'MutArray' from the first N elements of a list. The array is
1931+-- | Create an 'MutArray' from the first N elements of a list. The array is
24041932-- allocated to size N, if the list terminates before N elements then the
24051933-- array may hold less than N elements.
24061934--
@@ -2408,80 +1936,15 @@ fromStreamDN = fromStreamN
24081936fromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
24091937fromListN n xs = fromStreamDN n $ D.fromList xs
24101938
2411−-- | Like 'fromListN' but creates a pinned array.
2412−{-# INLINABLE pinnedFromListN #-}
2413−pinnedFromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2414−pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
2415−
24161939-- | Like fromListN but writes the array in reverse order.
24171940--
24181941-- /Pre-release/
24191942{-# INLINE fromListRevN #-}
24201943fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
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
2429−
2430−-- | Convert a pure stream in Identity monad to a mutable array.
2431−{-# INLINABLE fromPureStream #-}
2432−fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2433−fromPureStream 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})
2461−
2462−-------------------------------------------------------------------------------
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
1944+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24821945
24831946-------------------------------------------------------------------------------
2484−-- convert a stream of arrays to a single array by buffering arrays first
1947+-- convert stream to a single array
24851948-------------------------------------------------------------------------------
24861949
24871950{-# INLINE arrayStreamKLength #-}
@@ -2491,84 +1954,36 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
24911954-- | Convert an array stream to an array. Note that this requires peak memory
24921955-- that is double the size of the array stream.
24931956--
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." #-}
25181957{-# INLINE fromArrayStreamK #-}
25191958fromArrayStreamK :: (Unbox a, MonadIO m) =>
25201959 StreamK m (MutArray a) -> m (MutArray a)
2521−fromArrayStreamK = fromChunksK
2522−
2523−{-# INLINE fromStreamDAs #-}
2524−fromStreamDAs ::
2525− (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
2526−fromStreamDAs ps m =
2527− arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2528−
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
1960+fromArrayStreamK as = do
1961+ len <- arrayStreamKLength as
1962+ fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
25411963
2542−-- fromStream (Stream m) = P.fold create m
25431964-- CAUTION: a very large number (millions) of arrays can degrade performance
25441965-- due to GC overhead because we need to buffer the arrays before we flatten
25451966-- all the arrays.
25461967--
2547−-- XXX Compare if this is faster or "fold create".
1968+-- XXX Compare if this is faster or "fold write".
25481969--
25491970-- | We could take the approach of doubling the memory allocation on each
25501971-- overflow. This would result in more or less the same amount of copying as in
25511972-- the chunking approach. However, if we have to shrink in the end then it may
25521973-- result in an extra copy of the entire data.
25531974--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
1975+-- >>> fromStreamD = StreamD.fold MutArray.write
25551976--
25561977{-# INLINE fromStreamD #-}
2557−{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
25581978fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2559−fromStreamD = fromStream
1979+fromStreamD m = arrayStreamKFromStreamD m >>= fromArrayStreamK
25601980
2561−-- | Create a 'MutArray' from a list. The list must be of finite size.
1981+-- | Create an 'MutArray' from a list. The list must be of finite size.
25621982--
25631983{-# INLINE fromList #-}
25641984fromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
25651985fromList xs = fromStreamD $ D.fromList xs
25661986
2567−-- | Like 'fromList' but creates a pinned array.
2568−{-# INLINE pinnedFromList #-}
2569−pinnedFromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2570−pinnedFromList xs = fromStreamDAs Pinned $ D.fromList xs
2571−
25721987-- XXX We are materializing the whole list first for getting the length. Check
25731988-- if the 'fromList' like chunked implementation would fare better.
25741989
@@ -2577,75 +1992,44 @@ pinnedFromList xs = fromStreamDAs Pinned $ D.fromList xs
25771992fromListRev :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
25781993fromListRev xs = fromListRevN (Prelude.length xs) xs
25791994
2580−-------------------------------------------------------------------------------
2581−-- Cloning
2582−-------------------------------------------------------------------------------
2583−
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−
2588−{-# INLINE cloneAs #-}
2589−cloneAs ::
2590− ( MonadIO m
2591−#ifdef DEVBUILD
2592− , Unbox a
2593−#endif
2594− )
2595− => PinnedState -> MutArray a -> m (MutArray a)
2596−cloneAs ps src =
2597− do
2598− let startSrc = arrStart src
2599− srcLen = arrEnd src - startSrc
2600− newArrContents <-
2601− Unboxed.cloneSliceUnsafeAs ps startSrc srcLen (arrContents src)
2602− return $ MutArray newArrContents 0 srcLen srcLen
2603−
2604−{-# INLINE clone #-}
2605−clone ::
2606− ( MonadIO m
2607−#ifdef DEVBUILD
2608− , Unbox a
2609−#endif
2610− )
2611− => MutArray a -> m (MutArray a)
2612−clone = cloneAs Unpinned
2613−
2614−{-# INLINE pinnedClone #-}
2615−pinnedClone ::
2616− ( MonadIO m
2617−#ifdef DEVBUILD
2618− , Unbox a
2619−#endif
2620− )
2621− => MutArray a -> m (MutArray a)
2622−pinnedClone = cloneAs Pinned
2623−
26241995-------------------------------------------------------------------------------
26251996-- Combining
26261997-------------------------------------------------------------------------------
26271998
2628−-- | Copy two arrays into a newly allocated array. If the first array is pinned
2629−-- the spliced array is also pinned.
1999+-- | Put a sub range of a source array into a subrange of a destination array.
2000+-- This is not safe as it does not check the bounds.
2001+{-# INLINE putSliceUnsafe #-}
2002+putSliceUnsafe :: MonadIO m => MutArray a -> Int -> MutArray a -> Int -> Int -> m ()
2003+putSliceUnsafe src srcStartBytes dst dstStartBytes lenBytes = liftIO $ do
2004+ assertM(lenBytes <= arrBound dst - dstStartBytes)
2005+ assertM(lenBytes <= arrEnd src - srcStartBytes)
2006+ let !(I# srcStartBytes#) = srcStartBytes
2007+ !(I# dstStartBytes#) = dstStartBytes
2008+ !(I# lenBytes#) = lenBytes
2009+ let arrS# = getMutableByteArray# (arrContents src)
2010+ arrD# = getMutableByteArray# (arrContents dst)
2011+ IO $ \s# -> (# copyMutableByteArray#
2012+ arrS# srcStartBytes# arrD# dstStartBytes# lenBytes# s#
2013+ , () #)
2014+
2015+-- | Copy two arrays into a newly allocated array.
26302016{-# INLINE spliceCopy #-}
26312017spliceCopy :: forall m a. MonadIO m =>
26322018#ifdef DEVBUILD
26332019 Unbox a =>
26342020#endif
26352021 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2022+spliceCopy arr1 arr2 = liftIO $ do
26372023 let start1 = arrStart arr1
26382024 start2 = arrStart arr2
26392025 len1 = arrEnd arr1 - start1
26402026 len2 = arrEnd arr2 - start2
2027+ newArrContents <- liftIO $ Unboxed.newPinnedBytes (len1 + len2)
26412028 let len = len1 + len2
2642− newArrContents <-
2643− if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2646− putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
2647− putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
2648− return $ MutArray newArrContents 0 len len
2029+ newArr = MutArray newArrContents 0 len len
2030+ putSliceUnsafe arr1 start1 newArr 0 len1
2031+ putSliceUnsafe arr2 start2 newArr len1 len2
2032+ return newArr
26492033
26502034-- | Really really unsafe, appends the second array into the first array. If
26512035-- the first array does not have enough space it may cause silent data
@@ -2654,13 +2038,12 @@ spliceCopy arr1 arr2 = do
26542038spliceUnsafe :: MonadIO m =>
26552039 MutArray a -> MutArray a -> m (MutArray a)
26562040spliceUnsafe dst src =
2657− do
2041+ liftIO $ do
26582042 let startSrc = arrStart src
26592043 srcLen = arrEnd src - startSrc
26602044 endDst = arrEnd dst
26612045 assertM(endDst + srcLen <= arrBound dst)
2662− putSliceUnsafe
2663− (arrContents src) startSrc (arrContents dst) endDst srcLen
2046+ putSliceUnsafe src startSrc dst endDst srcLen
26642047 return $ dst {arrEnd = endDst + srcLen}
26652048
26662049-- | @spliceWith sizer dst src@ mutates @dst@ to append @src@. If there is no
@@ -2676,7 +2059,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762059 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772060spliceWith sizer dst@(MutArray _ start end bound) src = do
26782061{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2062+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802063 in D.fold f (toStreamD src)
26812064-}
26822065 assert (end <= bound) (return ())
@@ -2692,7 +2075,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
26922075 $ "splice: newSize is less than the total size "
26932076 ++ "of arrays being appended. Please check the "
26942077 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2078+ liftIO $ realloc newSizeInBytes dst
26962079 else return dst
26972080 spliceUnsafe dst1 src
26982081
@@ -2704,8 +2087,6 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
27042087--
27052088-- >>> splice = MutArray.spliceWith (+)
27062089--
2707−-- If the original array is pinned the spliced array is also pinned.
2708−--
27092090-- /Pre-release/
27102091{-# INLINE splice #-}
27112092splice :: (MonadIO m, Unbox a) => MutArray a -> MutArray a -> m (MutArray a)
@@ -2729,24 +2110,14 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
27292110-- Splitting
27302111-------------------------------------------------------------------------------
27312112
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−
27432113-- | Drops the separator byte
27442114{-# INLINE breakOn #-}
27452115breakOn :: MonadIO m
27462116 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2117+breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2118+ -- XXX Instead of using asPtrUnsafe (pinning memory) we can pass unlifted
2119+ -- Addr# to memchr and it should be safe (from ghc 8.4).
27482120 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749− -- Need efficient stream based primitives that work on Word64.
27502121 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
27512122 let sepIndex = loc `minusPtr` p
27522123 return $
@@ -2767,41 +2138,32 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672138 }
27682139 )
27692140
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−
27922141-- | Create two slices of an array without copying the original array. The
27932142-- specified index @i@ is the first index of the second slice.
27942143--
2795−{-# INLINE splitAt #-}
27962144splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2145+splitAt i arr@MutArray{..} =
27982146 let maxIndex = length arr - 1
27992147 in if i < 0
28002148 then error "sliceAt: negative array index"
28012149 else if i > maxIndex
28022150 then error $ "sliceAt: specified array index " ++ show i
28032151 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2152+ else let off = i * SIZE_OF(a)
2153+ p = arrStart + off
2154+ in ( MutArray
2155+ { arrContents = arrContents
2156+ , arrStart = arrStart
2157+ , arrEnd = p
2158+ , arrBound = p
2159+ }
2160+ , MutArray
2161+ { arrContents = arrContents
2162+ , arrStart = p
2163+ , arrEnd = arrEnd
2164+ , arrBound = arrBound
2165+ }
2166+ )
28052167
28062168-------------------------------------------------------------------------------
28072169-- Casting
@@ -2851,16 +2213,13 @@ cast arr =
28512213-- guarantees that unsafe calls will be performed in the calling thread. Making
28522214-- it safe to pass heap-allocated objects to unsafe functions.
28532215
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2855−-- operations. And we are safe from Haskell perspective because we will be
2856−-- 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.
2216+-- Unsafe because of direct pointer operations. The user must ensure that they
2217+-- are writing within the legal bounds of the array. Should we just name it
2218+-- asPtr, the unsafety is implicit for any pointer operations. And we are safe
2219+-- from Haskell perspective because we will be pinning the memory.
28612220
2862−-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2863−-- array as a pointer to some operating system call or to a "safe" FFI call.
2221+-- | Use an @MutArray a@ as @Ptr a@. This is useful when we want to pass an array
2222+-- as a pointer to some operating system call or to a "safe" FFI call.
28642223--
28652224-- If the array is not pinned it is copied to pinned memory before passing it
28662225-- to the monadic action.
@@ -2870,382 +2229,57 @@ cast arr =
28702229-- opportunistically before this operation occurs, to avoid the cost of a copy
28712230-- if possible.
28722231--
2873−-- /Unsafe/ because of direct pointer operations. The user must ensure that
2874−-- they are writing within the legal bounds of the array.
2232+-- /Unsafe/
28752233--
28762234-- /Pre-release/
28772235--
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." #-}
2885−{-# INLINE asPtrUnsafe #-}
28862236asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
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
2893− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2237+asPtrUnsafe arr f = do
2238+ let contents = arrContents arr
2239+ !ptr = Ptr (byteArrayContents#
2240+ (unsafeCoerce# (getMutableByteArray# contents)))
2241+ -- XXX Check if the array is pinned, if not, copy it to a pinned array
2242+ -- XXX We should probably pass to the IO action the byte length of the array
2243+ -- as well so that bounds can be checked.
2244+ r <- f (ptr `plusPtr` arrStart arr)
2245+ liftIO $ touch contents
2246+ return r
28942247
28952248-------------------------------------------------------------------------------
28962249-- Equality
28972250-------------------------------------------------------------------------------
28982251
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.
2252+-- | Compare the length of the arrays. If the length is equal, compare the
2253+-- lexicographical ordering of two underlying byte arrays
29062254--
29072255-- /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−
29312256{-# INLINE cmp #-}
2932−{-# DEPRECATED cmp "Please use byteCmp instead." #-}
29332257cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2934−cmp = byteCmp
2935−
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
2258+cmp arr1 arr2 =
2259+ liftIO
2260+ $ do
2261+ let marr1 = getMutableByteArray# (arrContents arr1)
2262+ marr2 = getMutableByteArray# (arrContents arr2)
2263+ !(I# st1#) = arrStart arr1
2264+ !(I# st2#) = arrStart arr2
2265+ !(I# len#) = byteLength arr1
2266+ case compare (byteLength arr1) (byteLength arr2) of
2267+ EQ -> do
2268+ r <- liftIO $ IO $ \s# ->
2269+ let res =
2270+ I#
2271+ (compareByteArrays#
2272+ (unsafeCoerce# marr1)
2273+ st1#
2274+ (unsafeCoerce# marr2)
2275+ st2#
2276+ len#)
2277+ in (# s#, res #)
2278+ return $ compare r 0
2279+ x -> return x
29442280
29452281-------------------------------------------------------------------------------
2946−-- Compact
2947−-------------------------------------------------------------------------------
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
2282+-- NFData
32492283-------------------------------------------------------------------------------
32502284
32512285-- | Strip elements which match with predicate from both ends.
@@ -3274,7 +2308,7 @@ strip eq arr@MutArray{..} = liftIO $ do
32742308 getStart cur = do
32752309 if cur < arrEnd
32762310 then do
3277− r <- peekAt cur arrContents
2311+ r <- peekWith arrContents cur
32782312 if eq r
32792313 then getStart (INDEX_NEXT(cur,a))
32802314 else return cur
@@ -3284,7 +2318,7 @@ strip eq arr@MutArray{..} = liftIO $ do
32842318 if cur > low
32852319 then do
32862320 let prev = INDEX_PREV(cur,a)
3287− r <- peekAt prev arrContents
2321+ r <- peekWith arrContents prev
32882322 if eq r
32892323 then getLast prev low
32902324 else return cur