@@ -1,7 +1,7 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE UnboxedTuples #-}
2{-# LANGUAGE UnboxedTuples #-}
4−-- Module : Streamly.Internal.Data.MutArray.Type
4+-- Module : Streamly.Internal.Data.Array.Mut.Type
5-- Copyright : (c) 2020 Composewell Technologies
5-- Copyright : (c) 2020 Composewell Technologies
6-- License : BSD3-3-Clause
6-- License : BSD3-3-Clause
7-- Maintainer : streamly@composewell.com
7-- Maintainer : streamly@composewell.com
@@ -26,82 +26,55 @@
26-- strive to keep the API consistent for both. Ideally, you should be able to
26-- strive to keep the API consistent for both. Ideally, you should be able to
27-- replace one with another with little changes to the code.
27-- replace one with another with little changes to the code.
29−module Streamly.Internal.Data.MutArray.Type
29+module Streamly.Internal.Data.Array.Mut.Type
31− -- ** Type
31+ -- * Type
32 -- $arrayNotes
32 -- $arrayNotes
33 MutArray (..)
33 MutArray (..)
34−
34+ , MutableByteArray
35− -- ** Conversion
35+ , touch
36− -- *** Pinned and Unpinned
43− , castUnsafe -- XXX unsafeCast
39+ -- * Constructing and Writing
48 -- ** Construction
40 -- ** Construction
52− -- | New arrays are always empty arrays with some reserve capacity to
53− -- extend the length without reallocating.
55− , newArrayWith -- emptyAlignedWith
57− , pinnedNewAligned -- XXX not required
58− -- , new -- uninitialized array of specified length
65− -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
68− , splitAt -- XXX should be able to express using getSlice
71− -- *** Stream Folds
43+ -- *** Uninitialized Arrays
50+ -- *** Initialized Arrays
72 , ArrayUnsafe (..)
54 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
55+ , writeNWithUnsafe
74− , unsafeCreateOf
56+ , writeNWith
75− , unsafePinnedCreateOf
57+ , writeNUnsafe
76− , pinnedCreateOf
58+ , writeN
77− , createOfWith
59+ , writeNAligned
79− , revCreateOf
61+ , writeWith
82− , createWith
64+ , writeRevN
83− , create
65+ -- , writeRev
86− -- *** From containers
67+ -- ** From containers
87 , fromListN
68 , fromListN
89 , fromList
69 , fromList
91 , fromListRevN
70 , fromListRevN
92 , fromListRev
71 , fromListRev
93− , fromStreamN
72+ , fromStreamDN
94− , fromStream
73+ , fromStreamD
100− , fromChunksRealloced -- fromSmallChunks
102− -- ** Random writes
75+ -- * Random writes
103 , putIndex
76 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
77+ , putIndexUnsafe
105 , putIndices
78 , putIndices
106 -- , putFromThenTo
79 -- , putFromThenTo
107 -- , putFrom -- start writing at the given position
80 -- , putFrom -- start writing at the given position
@@ -109,71 +82,78 @@ module Streamly.Internal.Data.MutArray.Type
109 -- , putFromTo
82 -- , putFromTo
110 -- , putFromRev
83 -- , putFromRev
111 -- , putUptoRev
84 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
85+ , modifyIndexUnsafe
113 , modifyIndex
86 , modifyIndex
114 , modifyIndices
87 , modifyIndices
116 , swapIndices
89 , swapIndices
117 , unsafeSwapIndices
90 , unsafeSwapIndices
119− -- ** Reading
92+ -- * Growing and Shrinking
93+ -- Arrays grow only at the end, though it is possible to grow on both sides
94+ -- and therefore have a cons as well as snoc. But that will require two
95+ -- bounds in the array representation.
121− -- *** Indexing
97+ -- ** Appending elements
122− , getIndex
98+ , snocWith
123− , getIndexUnsafe -- XXX unsafeGetIndex
99+ , snoc
124− -- , getFromThenTo
100+ , snocLinear
125− , getIndexRev -- getRevIndex?
101+ , snocMay
126− , indexReader
102+ , snocUnsafe
139− -- *** To Containers
104+ -- ** Appending streams
140− , toList
105+ , writeAppendNUnsafe
142− -- *** Unfolds
110+ -- * Eliminating and Reading
148 , readerRevWith
114 , readerRevWith
149 , readerRev
115 , readerRev
151− -- ** Size and Capacity
117+ -- ** To containers
152− -- *** Size
118+ , toStreamDWith
153− , length
119+ , toStreamDRevWith
154− , byteLength
120+ , toStreamKWith
156− -- *** Capacity
128+ -- experimental
157− -- , capacity
129+ , producerWith
158− , byteCapacity
130+ , producer
161− -- *** Capacity Management
140+ -- * Memory Management
162 , blockSize
141 , blockSize
163 , arrayChunkBytes
142 , arrayChunkBytes
164 , allocBytesToElemCount
143 , allocBytesToElemCount
165− , realloc -- this is "resize"
144+ , realloc
167− , growExp
146+ , resizeExp
168 , rightSize
147 , rightSize
170− -- ** Folding
149+ -- * Size
171− , foldl'
150+ , length
172− , foldr
151+ , byteLength
173− , byteCmp
152+ -- , capacity
174− , byteEq
153+ , byteCapacity
176− -- ** In-place Mutation Algorithms
156+ -- * In-place Mutation Algorithms
178 , reverse
158 , reverse
179 , permute
159 , permute
@@ -183,121 +163,59 @@ module Streamly.Internal.Data.MutArray.Type
183 , mergeBy
163 , mergeBy
186− -- ** Growing and Shrinking
166+ -- * Casting
187− -- | Arrays grow only at the end, though it is possible to grow on both
167+ , cast
188− -- sides and therefore have a cons as well as snoc. But that will require
168+ , castUnsafe
189− -- both lower and upper bound in the array representation.
169+ , asBytes
191− -- *** Appending elements
172+ -- * Folding
192− , snocWith
173+ , foldl'
194− , snocLinear
175+ , cmp
196− , snocUnsafe -- XXX unsafeSnoc
177+ -- * Arrays of arrays
178+ -- We can add dimensionality parameter to the array type to get
179+ -- multidimensional arrays. Multidimensional arrays would just be a
180+ -- convenience wrapper on top of single dimensional arrays.
198− -- *** Appending streams
182+ -- | Operations dealing with multiple arrays, streams of arrays or
199− , unsafeAppendN
183+ -- multidimensional array representations.
185+ -- ** Construct from streams
187+ , arrayStreamKFromStreamD
190+ -- ** Eliminate to streams
195+ -- ** Construct from arrays
196+ -- get chunks without copying
199+ -- , getSlicesFromLenN
200+ , splitAt -- XXX should be able to express using getSlice
204− -- *** Appending arrays
203+ -- ** Appending arrays
205 , spliceCopy
204 , spliceCopy
206 , spliceWith
205 , spliceWith
208 , spliceExp
207 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
208+ , spliceUnsafe
210 -- , putSlice
210 -- , putSlice
211 -- , appendSlice
211 -- , appendSlice
212 -- , appendSliceFrom
212 -- , appendSliceFrom
214− -- ** Serialization using Unbox
217− , pokeSkipUnsafe -- unsafePokeSkip
219− -- ** Deserialization using Unbox
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
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.
229− -- ** Streams of Arrays
231− -- | Group a stream into arrays.
237− -- | Split an array into slices.
239− -- , getSlicesFromLenN
244− -- | Append the arrays in a stream to form a stream of elements.
251− -- | Append the arrays in a stream to form a stream of larger arrays.
263− -- ** Utilities
214+ -- * Utilities
264 , roundUpToPower2
215 , roundUpToPower2
267 , c_memchr
218 , c_memchr
286− , writeAppendNUnsafe
293− , pinnedWriteNUnsafe
296− , pinnedWriteNAligned -- XXX not required
@@ -308,52 +226,48 @@ where
309import Control.Monad (when, void)
227import Control.Monad (when, void)
310import Control.Monad.IO.Class (MonadIO(..))
228import Control.Monad.IO.Class (MonadIO(..))
311−import Data.Bifunctor (first)
312import Data.Bits (shiftR, (.|.), (.&.))
229import Data.Bits (shiftR, (.|.), (.&.))
313−import Data.Functor.Identity (Identity(..))
314import Data.Proxy (Proxy(..))
230import Data.Proxy (Proxy(..))
315import Data.Word (Word8)
231import Data.Word (Word8)
316import Foreign.C.Types (CSize(..), CInt(..))
232import Foreign.C.Types (CSize(..), CInt(..))
317import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
233import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
318−import Streamly.Internal.Data.MutByteArray.Type
234+import Streamly.Internal.Data.Unboxed
319− ( MutByteArray(..)
235+ ( MutableByteArray(..)
320− , PinnedState(..)
236+ , Unbox
321 , getMutableByteArray#
237 , getMutableByteArray#
322− , putSliceUnsafe
238+ , peekWith
324−import Streamly.Internal.Data.Unbox (Unbox(..))
325import GHC.Base
243import GHC.Base
327 , Int(..)
245 , Int(..)
246+ , byteArrayContents#
328 , compareByteArrays#
247 , compareByteArrays#
329 , copyMutableByteArray#
248 , copyMutableByteArray#
331import GHC.Base (noinline)
250import GHC.Base (noinline)
332−import GHC.Exts (unsafeCoerce#, Addr#)
251+import GHC.Exts (unsafeCoerce#)
333import GHC.Ptr (Ptr(..))
252import GHC.Ptr (Ptr(..))
335import Streamly.Internal.Data.Fold.Type (Fold(..))
254import Streamly.Internal.Data.Fold.Type (Fold(..))
336import Streamly.Internal.Data.Producer.Type (Producer (..))
255import Streamly.Internal.Data.Producer.Type (Producer (..))
337−import Streamly.Internal.Data.Stream.Type (Stream)
256+import Streamly.Internal.Data.Stream.StreamD.Type (Stream)
338−import Streamly.Internal.Data.Parser.Type (Parser (..))
257+import Streamly.Internal.Data.Stream.StreamK.Type (StreamK)
339−import Streamly.Internal.Data.StreamK.Type (StreamK)
340import Streamly.Internal.Data.SVar.Type (adaptState, defState)
258import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341−import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
342import Streamly.Internal.Data.Unfold.Type (Unfold(..))
259import Streamly.Internal.Data.Unfold.Type (Unfold(..))
343import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
260import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
345import qualified Streamly.Internal.Data.Fold.Type as FL
262import 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
349import qualified Streamly.Internal.Data.Producer as Producer
263import qualified Streamly.Internal.Data.Producer as Producer
350−import qualified Streamly.Internal.Data.Stream.Type as D
264+import qualified Streamly.Internal.Data.Stream.StreamD.Type as D
351−import qualified Streamly.Internal.Data.Stream.Lift as D
265+import qualified Streamly.Internal.Data.Stream.StreamK.Type as K
352−import qualified Streamly.Internal.Data.StreamK.Type as K
266+import qualified Streamly.Internal.Data.Unboxed as Unboxed
353import qualified Prelude
267import qualified Prelude
355import Prelude hiding
269import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
270+ (length, foldr, read, unlines, splitAt, reverse, truncate)
358#include "DocTestDataMutArray.hs"
272#include "DocTestDataMutArray.hs"
@@ -361,7 +275,6 @@ import Prelude hiding
361-- Foreign helpers
275-- Foreign helpers
362-------------------------------------------------------------------------------
276-------------------------------------------------------------------------------
364−-- NOTE: Have to be "ccall unsafe" so that we can pass unpinned memory to these
365foreign import ccall unsafe "string.h memcpy" c_memcpy
278foreign import ccall unsafe "string.h memcpy" c_memcpy
366 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
279 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
@@ -371,9 +284,6 @@ foreign import ccall unsafe "string.h memchr" c_memchr
371foreign import ccall unsafe "string.h memcmp" c_memcmp
284foreign import ccall unsafe "string.h memcmp" c_memcmp
372 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO CInt
285 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO CInt
374−foreign import ccall unsafe "string.h strlen" c_strlen
375− :: Ptr Word8 -> IO CSize
377-- | Given an 'Unboxed' type (unused first arg) and a number of bytes, return
287-- | Given an 'Unboxed' type (unused first arg) and a number of bytes, return
378-- how many elements of that type will completely fit in those bytes.
288-- how many elements of that type will completely fit in those bytes.
@@ -428,7 +338,7 @@ data MutArray a =
428 -- The array is a range into arrContents. arrContents may be a superset of
338 -- The array is a range into arrContents. arrContents may be a superset of
429 -- the slice represented by the array. All offsets are in bytes.
339 -- the slice represented by the array. All offsets are in bytes.
431− { arrContents :: {-# UNPACK #-} !MutByteArray
341+ { arrContents :: {-# UNPACK #-} !MutableByteArray
432 , arrStart :: {-# UNPACK #-} !Int -- ^ index into arrContents
342 , arrStart :: {-# UNPACK #-} !Int -- ^ index into arrContents
433 , arrEnd :: {-# UNPACK #-} !Int -- ^ index into arrContents
343 , arrEnd :: {-# UNPACK #-} !Int -- ^ index into arrContents
434 -- Represents the first invalid index of
344 -- Represents the first invalid index of
@@ -440,28 +350,17 @@ data MutArray a =
440-- Pinning & Unpinning
350-- Pinning & Unpinning
441-------------------------------------------------------------------------------
351-------------------------------------------------------------------------------
443−-- | Return a copy of the array in pinned memory if unpinned, else return the
445{-# INLINE pin #-}
353{-# INLINE pin #-}
446pin :: MutArray a -> IO (MutArray a)
354pin :: MutArray a -> IO (MutArray a)
447−pin arr@MutArray{..} =
355+pin arr@MutArray{..} = do
448− if Unboxed.isPinned arrContents
356+ contents <- Unboxed.pin arrContents
449− then pure arr
357+ return $ arr {arrContents = contents}
450− else pinnedClone arr
452−-- | Return a copy of the array in unpinned memory if pinned, else return the
454{-# INLINE unpin #-}
359{-# INLINE unpin #-}
455unpin :: MutArray a -> IO (MutArray a)
360unpin :: MutArray a -> IO (MutArray a)
456−unpin arr@MutArray{..} =
361+unpin arr@MutArray{..} = do
457− if Unboxed.isPinned arrContents
362+ contents <- Unboxed.unpin arrContents
458− then clone arr
363+ return $ arr {arrContents = contents}
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
466-------------------------------------------------------------------------------
365-------------------------------------------------------------------------------
467-- Construction
366-- Construction
@@ -476,11 +375,9 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
476-- files and arrays.
375-- files and arrays.
478-- GHC always guarantees word-aligned memory, alignment is important only when
377-- GHC always guarantees word-aligned memory, alignment is important only when
479−-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
378+-- we need more than that. See stg_newAlignedPinnedByteArrayzh and
480-- allocatePinned in GHC source.
379-- allocatePinned in GHC source.
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
484-- | @newArrayWith allocator alignment count@ allocates a new array of zero
381-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485-- length and with a capacity to hold @count@ elements, using @allocator
382-- length and with a capacity to hold @count@ elements, using @allocator
486-- size alignment@ as the memory allocator function.
383-- size alignment@ as the memory allocator function.
@@ -493,7 +390,7 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
493-- /Pre-release/
390-- /Pre-release/
494{-# INLINE newArrayWith #-}
391{-# INLINE newArrayWith #-}
495newArrayWith :: forall m a. (MonadIO m, Unbox a)
392newArrayWith :: forall m a. (MonadIO m, Unbox a)
496− => (Int -> Int -> m MutByteArray) -> Int -> Int -> m (MutArray a)
393+ => (Int -> Int -> m MutableByteArray) -> Int -> Int -> m (MutArray a)
497newArrayWith alloc alignSize count = do
394newArrayWith alloc alignSize count = do
498 let size = max (count * SIZE_OF(a)) 0
395 let size = max (count * SIZE_OF(a)) 0
499 contents <- alloc size alignSize
396 contents <- alloc size alignSize
@@ -504,34 +401,27 @@ newArrayWith alloc alignSize count = do
504 , arrBound = size
401 , arrBound = size
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.
511−-- | Create an empty array.
517−empty = MutArray Unboxed.empty 0 0 0
519−{-# DEPRECATED nil "Please use empty instead." #-}
521#ifdef DEVBUILD
405#ifdef DEVBUILD
522 Unbox a =>
406 Unbox a =>
524 MutArray a
408 MutArray a
525−nil = empty
409+nil = MutArray Unboxed.nil 0 0 0
527−{-# INLINE newBytesAs #-}
411+
412+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
413+-- the array is uninitialized and the allocation is aligned as per the
414+-- 'Unboxed' instance of the type.
417+{-# INLINE newPinnedBytes #-}
528−newBytesAs :: MonadIO m =>
418+newPinnedBytes :: MonadIO m =>
529#ifdef DEVBUILD
419#ifdef DEVBUILD
530 Unbox a =>
420 Unbox a =>
532− PinnedState -> Int -> m (MutArray a)
422+ Int -> m (MutArray a)
533−newBytesAs ps bytes = do
423+newPinnedBytes bytes = do
534− contents <- liftIO $ Unboxed.newBytesAs ps bytes
424+ contents <- liftIO $ Unboxed.newPinnedBytes bytes
535 return $ MutArray
425 return $ MutArray
536 { arrContents = contents
426 { arrContents = contents
537 , arrStart = 0
427 , arrStart = 0
@@ -539,62 +429,52 @@ newBytesAs ps bytes = do
539 , arrBound = bytes
429 , arrBound = bytes
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.
547−{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549−pinnedNewBytes :: MonadIO m =>
553− Int -> m (MutArray a)
554−pinnedNewBytes = newBytesAs Pinned
556-- | Like 'newArrayWith' but using an allocator is a pinned memory allocator and
432-- | Like 'newArrayWith' but using an allocator is a pinned memory allocator and
557-- the alignment is dictated by the 'Unboxed' instance of the type.
433-- the alignment is dictated by the 'Unboxed' instance of the type.
559-- /Internal/
435-- /Internal/
560−{-# INLINE pinnedNewAligned #-}
436+{-# INLINE newAlignedPinned #-}
561−pinnedNewAligned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
437+newAlignedPinned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
562−pinnedNewAligned =
438+newAlignedPinned =
563− newArrayWith (\s a -> liftIO $ Unboxed.pinnedNewAlignedBytes s a)
439+ newArrayWith (\s a -> liftIO $ Unboxed.newAlignedPinnedBytes s a)
566−newAs :: (MonadIO m, Unbox a) => PinnedState -> Int -> m (MutArray a)
569− (\s _ -> liftIO $ Unboxed.newBytesAs ps s)
570− (error "new: alignment is not used in unpinned arrays.")
572-- XXX can unaligned allocation be more efficient when alignment is not needed?
441-- XXX can unaligned allocation be more efficient when alignment is not needed?
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
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
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
443+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
444+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
445+-- instance of the type.
589−{-# INLINE emptyOf #-}
447+{-# INLINE newPinned #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
448+newPinned :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
449+newPinned =
451+ (\s _ -> liftIO $ Unboxed.newPinnedBytes s)
452+ (error "newPinned: alignSize is not used")
593−-- XXX Deprecate in major
454+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
455+-- of the array is uninitialized.
595{-# INLINE new #-}
457{-# INLINE new #-}
596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
458new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
459+new =
461+ (\s _ -> liftIO $ Unboxed.newUnpinnedBytes s)
462+ (error "new: alignment is not used in unpinned arrays.")
464+-- XXX This should create a full length uninitialzed array so that the pointer
467+-- | Allocate a pinned MutArray of the given size and run an IO action passing
468+-- the array start pointer.
471+{-# INLINE withNewArrayUnsafe #-}
472+withNewArrayUnsafe ::
473+ (MonadIO m, Unbox a) => Int -> (Ptr a -> m ()) -> m (MutArray a)
474+withNewArrayUnsafe count f = do
475+ arr <- newPinned count
477+ $ \p -> f p >> return arr
599-------------------------------------------------------------------------------
479-------------------------------------------------------------------------------
600-- Random writes
480-- Random writes
@@ -610,7 +490,7 @@ putIndexUnsafe :: forall m a. (MonadIO m, Unbox a)
610putIndexUnsafe i MutArray{..} x = do
490putIndexUnsafe i MutArray{..} x = do
611 let index = INDEX_OF(arrStart, i, a)
491 let index = INDEX_OF(arrStart, i, a)
612 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
492 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
613− liftIO $ pokeAt index arrContents x
493+ liftIO $ pokeWith arrContents index x
615invalidIndex :: String -> Int -> a
495invalidIndex :: String -> Int -> a
616invalidIndex label i =
496invalidIndex label i =
@@ -628,7 +508,7 @@ putIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m ()
628putIndex i MutArray{..} x = do
508putIndex i MutArray{..} x = do
629 let index = INDEX_OF(arrStart,i,a)
509 let index = INDEX_OF(arrStart,i,a)
630 if i >= 0 && INDEX_VALID(index,arrEnd,a)
510 if i >= 0 && INDEX_VALID(index,arrEnd,a)
631− then liftIO $ pokeAt index arrContents x
511+ then liftIO $ pokeWith arrContents index x
632 else invalidIndex "putIndex" i
512 else invalidIndex "putIndex" i
634-- | Write an input stream of (index, value) pairs to an array. Throws an
514-- | Write an input stream of (index, value) pairs to an array. Throws an
@@ -642,21 +522,19 @@ putIndices arr = FL.foldlM' step (return ())
645− step () (i, x) = putIndex i arr x
525+ step () (i, x) = liftIO (putIndex i arr x)
647-- | Modify a given index of an array using a modifier function.
527-- | Modify a given index of an array using a modifier function.
649−-- Unsafe because it does not check the bounds of the array.
651-- /Pre-release/
529-- /Pre-release/
652modifyIndexUnsafe :: forall m a b. (MonadIO m, Unbox a) =>
530modifyIndexUnsafe :: forall m a b. (MonadIO m, Unbox a) =>
653 Int -> MutArray a -> (a -> (a, b)) -> m b
531 Int -> MutArray a -> (a -> (a, b)) -> m b
654modifyIndexUnsafe i MutArray{..} f = liftIO $ do
532modifyIndexUnsafe i MutArray{..} f = liftIO $ do
655 let index = INDEX_OF(arrStart,i,a)
533 let index = INDEX_OF(arrStart,i,a)
656 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
534 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
657− r <- peekAt index arrContents
535+ r <- peekWith arrContents index
658 let (x, res) = f r
536 let (x, res) = f r
659− pokeAt index arrContents x
537+ pokeWith arrContents index x
660 return res
538 return res
662-- | Modify a given index of an array using a modifier function.
540-- | Modify a given index of an array using a modifier function.
@@ -668,12 +546,13 @@ modifyIndex i MutArray{..} f = do
668 let index = INDEX_OF(arrStart,i,a)
546 let index = INDEX_OF(arrStart,i,a)
669 if i >= 0 && INDEX_VALID(index,arrEnd,a)
547 if i >= 0 && INDEX_VALID(index,arrEnd,a)
670 then liftIO $ do
548 then liftIO $ do
671− r <- peekAt index arrContents
549+ r <- peekWith arrContents index
672 let (x, res) = f r
550 let (x, res) = f r
673− pokeAt index arrContents x
551+ pokeWith arrContents index x
674 return res
552 return res
675 else invalidIndex "modifyIndex" i
553 else invalidIndex "modifyIndex" i
677-- | Modify the array indices generated by the supplied stream.
556-- | Modify the array indices generated by the supplied stream.
679-- /Pre-release/
558-- /Pre-release/
@@ -692,8 +571,6 @@ modifyIndices arr f = FL.foldlM' step initial
693-- | Modify each element of an array using the supplied modifier function.
572-- | Modify each element of an array using the supplied modifier function.
695−-- This is an in-place equivalent of an immutable map operation.
697-- /Pre-release/
574-- /Pre-release/
698modify :: forall m a. (MonadIO m, Unbox a)
575modify :: forall m a. (MonadIO m, Unbox a)
699 => MutArray a -> (a -> a) -> m ()
576 => MutArray a -> (a -> a) -> m ()
@@ -704,8 +581,8 @@ modify MutArray{..} f = liftIO $
706 when (INDEX_VALID(i,arrEnd,a)) $ do
583 when (INDEX_VALID(i,arrEnd,a)) $ do
707− r <- peekAt i arrContents
584+ r <- peekWith arrContents i
708− pokeAt i arrContents (f r)
585+ pokeWith arrContents i (f r)
709 go (INDEX_NEXT(i,a))
586 go (INDEX_NEXT(i,a))
711-- XXX We could specify the number of bytes to swap instead of Proxy. Need
588-- XXX We could specify the number of bytes to swap instead of Proxy. Need
@@ -714,15 +591,15 @@ modify MutArray{..} f = liftIO $
714swapArrayByteIndices ::
591swapArrayByteIndices ::
715 forall a. Unbox a
592 forall a. Unbox a
716 => Proxy a
593 => Proxy a
717− -> MutByteArray
594+ -> MutableByteArray
721swapArrayByteIndices _ arrContents i1 i2 = do
598swapArrayByteIndices _ arrContents i1 i2 = do
722− r1 <- peekAt i1 arrContents
599+ r1 <- peekWith arrContents i1
600+ r2 <- peekWith arrContents i2
723− r2 <- peekAt i2 arrContents
601+ pokeWith arrContents i1 (r2 :: a)
724− pokeAt i1 arrContents (r2 :: a)
602+ pokeWith arrContents i2 (r1 :: a)
725− pokeAt i2 arrContents (r1 :: a)
727-- | Swap the elements at two indices without validating the indices.
604-- | Swap the elements at two indices without validating the indices.
@@ -838,23 +715,23 @@ arrayChunkBytes = 1024
838roundDownTo :: Int -> Int -> Int
715roundDownTo :: Int -> Int -> Int
839roundDownTo elemSize size = size - (size `mod` elemSize)
716roundDownTo elemSize size = size - (size `mod` elemSize)
718+-- XXX See if resizing can be implemented by reading the old array as a stream
719+-- and then using writeN to the new array.
841-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
721-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
722-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843-- which complicates some inspection tests.
723-- which complicates some inspection tests.
845−{-# NOINLINE reallocExplicitAs #-}
725+{-# NOINLINE reallocExplicit #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
726+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
727+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848 assertM(arrEnd <= arrBound)
728 assertM(arrEnd <= arrBound)
850 -- Allocate new array
730 -- Allocate new array
851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
731 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
854− then Unboxed.pinnedNew newCapMaxInBytes
855− else Unboxed.new newCapMaxInBytes
732+ contents <- Unboxed.newPinnedBytes newCapMaxInBytes
856− let !(MutByteArray mbarrFrom#) = arrContents
733+ let !(MutableByteArray mbarrFrom#) = arrContents
857− !(MutByteArray mbarrTo#) = contents
734+ !(MutableByteArray mbarrTo#) = contents
859 -- Copy old data
736 -- Copy old data
860 let oldStart = arrStart
737 let oldStart = arrStart
@@ -875,10 +752,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875 , arrBound = newCapInBytes
752 , arrBound = newCapInBytes
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.
882-- | @realloc newCapacity array@ reallocates the array to the specified
755-- | @realloc newCapacity array@ reallocates the array to the specified
883-- capacity in bytes.
756-- capacity in bytes.
@@ -887,15 +760,9 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
887-- down to multiples of array size. If the new size is more than
760-- down to multiples of array size. If the new size is more than
888-- 'largeObjectThreshold' then it is rounded up to the block size (4K).
761-- 'largeObjectThreshold' then it is rounded up to the block size (4K).
890−-- If the original array is pinned, the newly allocated array is also pinned.
891{-# INLINABLE realloc #-}
763{-# INLINABLE realloc #-}
892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
764realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
765+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
767-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901-- in error messages and the capSizer is used to determine the capacity of the
768-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +785,14 @@ reallocWith label capSizer minIncrBytes arr = do
920 badSize newSize =
787 badSize newSize =
921− Prelude.concat
788+ concat
923 , ": new array size (in bytes) is less than required size "
790 , ": new array size (in bytes) is less than required size "
924 , show newSize
791 , show newSize
925 , ". Please check the sizing function passed."
792 , ". Please check the sizing function passed."
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
795+-- | @resize newCapacity array@ changes the total capacity of the array so that
929-- it is enough to hold the specified number of elements. Nothing is done if
796-- it is enough to hold the specified number of elements. Nothing is done if
930-- the specified capacity is less than the length of the array.
797-- the specified capacity is less than the length of the array.
@@ -933,46 +800,34 @@ reallocWith label capSizer minIncrBytes arr = do
933-- the block size (4K).
800-- the block size (4K).
935-- /Pre-release/
802-- /Pre-release/
936−{-# INLINE grow #-}
803+{-# INLINE resize #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
804+resize :: forall m a. (MonadIO m, Unbox a) =>
938 Int -> MutArray a -> m (MutArray a)
805 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
806+resize nElems arr@MutArray{..} = do
940 let req = SIZE_OF(a) * nElems
807 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
808+ len = arrEnd - arrStart
942− if req < cap
809+ if req < len
943 then return arr
810 then return arr
944 else realloc req arr
811 else realloc req arr
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)
952−-- | Like 'grow' but if the requested byte capacity is more than
813+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
953−-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
814+-- then it is rounded up to the closest power of 2.
955-- /Pre-release/
816-- /Pre-release/
956−{-# INLINE growExp #-}
817+{-# INLINE resizeExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
818+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958 Int -> MutArray a -> m (MutArray a)
819 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
820+resizeExp nElems arr@MutArray{..} = do
960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
821 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
962 if req > largeObjectThreshold
823 if req > largeObjectThreshold
963 then roundUpToPower2 req
824 then roundUpToPower2 req
965− cap = arrBound - arrStart
826+ len = arrEnd - arrStart
966− if req1 < cap
827+ if req1 < len
967 then return arr
828 then return arr
968 else realloc req1 arr
829 else realloc req1 arr
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)
976-- | Resize the allocated memory to drop any reserved free space at the end of
831-- | Resize the allocated memory to drop any reserved free space at the end of
977-- the array and reallocate it to reduce wastage.
832-- the array and reallocate it to reduce wastage.
@@ -1017,7 +872,7 @@ rightSize arr@MutArray{..} = do
1017snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
872snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
1018snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
873snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1019 assert (newEnd <= arrBound) (return ())
874 assert (newEnd <= arrBound) (return ())
1020− pokeAt arrEnd arrContents x
875+ pokeWith arrContents arrEnd x
1021 return $ arr {arrEnd = newEnd}
876 return $ arr {arrEnd = newEnd}
1023-- | Really really unsafe, appends the element into the first array, may
878-- | Really really unsafe, appends the element into the first array, may
@@ -1037,7 +892,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037{-# INLINE snocMay #-}
892{-# INLINE snocMay #-}
1038snocMay :: forall m a. (MonadIO m, Unbox a) =>
893snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039 MutArray a -> a -> m (Maybe (MutArray a))
894 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
895+snocMay arr@MutArray{..} x = liftIO $ do
1041 let newEnd = INDEX_NEXT(arrEnd,a)
896 let newEnd = INDEX_NEXT(arrEnd,a)
1042 if newEnd <= arrBound
897 if newEnd <= arrBound
1043 then Just <$> snocNewEnd newEnd arr x
898 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +906,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1052 -> m (MutArray a)
907 -> m (MutArray a)
1053snocWithRealloc sizer arr x = do
908snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
909+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055 snocUnsafe arr1 x
910 snocUnsafe arr1 x
1057-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
912-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +928,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073 -> MutArray a
928 -> MutArray a
1075 -> m (MutArray a)
930 -> m (MutArray a)
1076−snocWith allocSize arr x = do
931+snocWith allocSize arr x = liftIO $ do
1077 let newEnd = INDEX_NEXT(arrEnd arr,a)
932 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078 if newEnd <= arrBound arr
933 if newEnd <= arrBound arr
1079 then snocNewEnd newEnd arr x
934 then snocNewEnd newEnd arr x
@@ -1117,126 +972,6 @@ snoc = snocWith f
1117 then oldSize * 2
972 then oldSize * 2
1118 else roundUpToPower2 oldSize * 2
973 else roundUpToPower2 oldSize * 2
1120−-------------------------------------------------------------------------------
1121−-- Serialization/Deserialization
1122−-------------------------------------------------------------------------------
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}
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
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
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})
1151−-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152−-- capacity becomes full.
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
1164−{-# NOINLINE pokeWithRealloc #-}
1165−pokeWithRealloc :: forall m a. (MonadIO m, Unbox 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
1174−{-# INLINE pokeAppendWith #-}
1175−pokeAppendWith :: forall m a. (MonadIO m, Unbox 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
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.
1191−-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1193−{-# INLINE pokeAppend #-}
1194−pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195− MutArray Word8 -> a -> m (MutArray Word8)
1196−pokeAppend = pokeAppendWith f
1201− if isPower2 oldSize
1203− else roundUpToPower2 oldSize * 2
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.
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 ())
1217− r <- peekAt arrStart arrContents
1218− return (r, MutArray arrContents start1 arrEnd arrBound)
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)
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)
1235− then return (Nothing, arr)
1237− r <- peekAt arrStart arrContents
1238− return (Just r, MutArray arrContents start1 arrEnd arrBound)
1240-------------------------------------------------------------------------------
975-------------------------------------------------------------------------------
1241-- Random reads
976-- Random reads
1242-------------------------------------------------------------------------------
977-------------------------------------------------------------------------------
@@ -1251,17 +986,17 @@ getIndexUnsafe :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1251getIndexUnsafe i MutArray{..} = do
986getIndexUnsafe i MutArray{..} = do
1252 let index = INDEX_OF(arrStart,i,a)
987 let index = INDEX_OF(arrStart,i,a)
1253 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
988 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
1254− liftIO $ peekAt index arrContents
989+ liftIO $ peekWith arrContents index
1256-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
991-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
1258{-# INLINE getIndex #-}
993{-# INLINE getIndex #-}
1259−getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (Maybe a)
994+getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1260getIndex i MutArray{..} = do
995getIndex i MutArray{..} = do
1261 let index = INDEX_OF(arrStart,i,a)
996 let index = INDEX_OF(arrStart,i,a)
1262 if i >= 0 && INDEX_VALID(index,arrEnd,a)
997 if i >= 0 && INDEX_VALID(index,arrEnd,a)
1263− then liftIO $ Just <$> peekAt index arrContents
998+ then liftIO $ peekWith arrContents index
1264− else return Nothing
999+ else invalidIndex "getIndex" i
1266-- | /O(1)/ Lookup the element at the given index from the end of the array.
1001-- | /O(1)/ Lookup the element at the given index from the end of the array.
1267-- Index starts from 0.
1002-- Index starts from 0.
@@ -1273,16 +1008,21 @@ getIndexRev :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1273getIndexRev i MutArray{..} = do
1008getIndexRev i MutArray{..} = do
1274 let index = RINDEX_OF(arrEnd,i,a)
1009 let index = RINDEX_OF(arrEnd,i,a)
1275 if i >= 0 && index >= arrStart
1010 if i >= 0 && index >= arrStart
1276− then liftIO $ peekAt index arrContents
1011+ then liftIO $ peekWith arrContents index
1277 else invalidIndex "getIndexRev" i
1012 else invalidIndex "getIndexRev" i
1279data GetIndicesState contents start end st =
1014data GetIndicesState contents start end st =
1280 GetIndicesState contents start end st
1015 GetIndicesState contents start end st
1282−{-# INLINE indexReaderWith #-}
1017+-- | Given an unfold that generates array indices, read the elements on those
1018+-- indices from the supplied MutArray. An error is thrown if an index is out of
1022+{-# INLINE getIndicesD #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1023+getIndicesD :: (Monad m, Unbox a) =>
1284 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1024 (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
1025+getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
@@ -1295,32 +1035,13 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1295 case r of
1035 case r of
1296 D.Yield i s -> do
1036 D.Yield i s -> do
1297 x <- liftio $ getIndex i (MutArray contents start end undefined)
1037 x <- liftio $ getIndex i (MutArray contents start end undefined)
1298− case x of
1038+ return $ D.Yield x (GetIndicesState contents start end s)
1299− Just v -> return $ D.Yield v (GetIndicesState contents start end s)
1300− Nothing -> error "Invalid Index"
1301 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1039 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1302 D.Stop -> return D.Stop
1040 D.Stop -> return D.Stop
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
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
1315−{-# INLINE indexReader #-}
1316−indexReader :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1317−indexReader = indexReaderWith liftIO
1319−-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320−{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1321{-# INLINE getIndices #-}
1042{-# INLINE getIndices #-}
1322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1043getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1044+getIndices = getIndicesD liftIO
1325-------------------------------------------------------------------------------
1046-------------------------------------------------------------------------------
1326-- Subarrays
1047-- Subarrays
@@ -1425,7 +1146,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1426 -- Invariant low < high on entry, and on return as well
1147 -- Invariant low < high on entry, and on return as well
1427 moveHigh low high = do
1148 moveHigh low high = do
1428− h <- peekAt high arrContents
1149+ h <- peekWith arrContents high
1431 -- Correctly classified, continue the loop
1152 -- Correctly classified, continue the loop
@@ -1445,7 +1166,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1445 -- low <= high
1166 -- low <= high
1446 -- Both low and high are valid locations within the array
1167 -- Both low and high are valid locations within the array
1447 go low high = do
1168 go low high = do
1448− l <- peekAt low arrContents
1169+ l <- peekWith arrContents low
1451 -- low is wrongly classified
1172 -- low is wrongly classified
@@ -1456,8 +1177,8 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1456 case r of
1177 case r of
1457 Nothing -> return low
1178 Nothing -> return low
1458 Just (high1, h) -> do -- low < high1
1179 Just (high1, h) -> do -- low < high1
1459− pokeAt low arrContents h
1180+ pokeWith arrContents low h
1460− pokeAt high1 arrContents l
1181+ pokeWith arrContents high1 l
1461 let low1 = INDEX_NEXT(low,a)
1182 let low1 = INDEX_NEXT(low,a)
1462 high2 = INDEX_PREV(high1,a)
1183 high2 = INDEX_PREV(high1,a)
1463 if low1 <= high2
1184 if low1 <= high2
@@ -1569,10 +1290,20 @@ data GroupState s contents start end bound
1569 contents start end bound (GroupState s contents start end bound)
1290 contents start end bound (GroupState s contents start end bound)
1570 | GroupFinish
1291 | GroupFinish
1572−{-# INLINE_NORMAL chunksOfAs #-}
1293+-- | @chunksOf n stream@ groups the input stream into a stream of
1573−chunksOfAs :: forall m a. (MonadIO m, Unbox a)
1294+-- arrays of size n.
1574− => PinnedState -> Int -> D.Stream m a -> D.Stream m (MutArray a)
1295+--
1575−chunksOfAs ps n (D.Stream step state) =
1296+-- @chunksOf n = StreamD.foldMany (MutArray.writeN n)@
1299+{-# INLINE_NORMAL chunksOf #-}
1300+chunksOf :: forall m a. (MonadIO m, Unbox a)
1301+ => Int -> D.Stream m a -> D.Stream m (MutArray a)
1302+-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1303+-- benchmark. It seems it has difficulty producing optimized code when
1304+-- converting to StreamK. Investigate GHC optimizations.
1305+-- chunksOf n = D.foldMany (writeN n)
1306+chunksOf n (D.Stream step state) =
1576 D.Stream step' (GroupStart state)
1307 D.Stream step' (GroupStart state)
@@ -1584,14 +1315,14 @@ chunksOfAs ps n (D.Stream step state) =
1584 error $ "Streamly.Internal.Data.MutArray.Mut.Type.chunksOf: "
1315 error $ "Streamly.Internal.Data.MutArray.Mut.Type.chunksOf: "
1585 ++ "the size of arrays [" ++ show n
1316 ++ "the size of arrays [" ++ show n
1586 ++ "] must be a natural number"
1317 ++ "] must be a natural number"
1587− (MutArray contents start end bound :: MutArray a) <- newAs ps n
1318+ (MutArray contents start end bound :: MutArray a) <- liftIO $ newPinned n
1588 return $ D.Skip (GroupBuffer st contents start end bound)
1319 return $ D.Skip (GroupBuffer st contents start end bound)
1590 step' gst (GroupBuffer st contents start end bound) = do
1321 step' gst (GroupBuffer st contents start end bound) = do
1591 r <- step (adaptState gst) st
1322 r <- step (adaptState gst) st
1592 case r of
1323 case r of
1593 D.Yield x s -> do
1324 D.Yield x s -> do
1594− liftIO $ pokeAt end contents x
1325+ liftIO $ pokeWith contents end x
1595 let end1 = INDEX_NEXT(end,a)
1326 let end1 = INDEX_NEXT(end,a)
1596 return $
1327 return $
1597 if end1 >= bound
1328 if end1 >= bound
@@ -1610,51 +1341,14 @@ chunksOfAs ps n (D.Stream step state) =
1611 step' _ GroupFinish = return D.Stop
1342 step' _ GroupFinish = return D.Stop
1613−-- | @chunksOf n stream@ groups the elements in the input stream into arrays of
1614−-- @n@ elements each.
1616−-- Same as the following but may be more efficient:
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
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
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
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.
1642−-- We can incorporate this in chunksOfAs if the additional size parameter does
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
1650-- XXX buffer to a list instead?
1344-- XXX buffer to a list instead?
1651-- | Buffer the stream into arrays in memory.
1345-- | Buffer the stream into arrays in memory.
1652−{-# INLINE arrayStreamKFromStreamDAs #-}
1346+{-# INLINE arrayStreamKFromStreamD #-}
1653−arrayStreamKFromStreamDAs :: forall m a. (MonadIO m, Unbox a) =>
1347+arrayStreamKFromStreamD :: forall m a. (MonadIO m, Unbox a) =>
1654− PinnedState -> D.Stream m a -> m (StreamK m (MutArray a))
1348+ D.Stream m a -> m (StreamK m (MutArray a))
1655−arrayStreamKFromStreamDAs ps =
1349+arrayStreamKFromStreamD =
1656 let n = allocBytesToElemCount (undefined :: a) defaultChunkSize
1350 let n = allocBytesToElemCount (undefined :: a) defaultChunkSize
1657− in D.foldr K.cons K.nil . chunksOfAs ps n
1351+ in D.foldr K.cons K.nil . chunksOf n
1659-------------------------------------------------------------------------------
1353-------------------------------------------------------------------------------
1660-- Streams of arrays - Flattening
1354-- Streams of arrays - Flattening
@@ -1664,10 +1358,16 @@ data FlattenState s contents a =
1664 OuterLoop s
1358 OuterLoop s
1665 | InnerLoop s contents !Int !Int
1359 | InnerLoop s contents !Int !Int
1667−{-# INLINE_NORMAL concatWith #-}
1361+-- | Use the "reader" unfold instead.
1668−concatWith :: forall m a. (Monad m, Unbox a)
1362+--
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1363+-- @flattenArrays = unfoldMany reader@
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1364+--
1365+-- We can try this if there are any fusion issues in the unfold.
1367+{-# INLINE_NORMAL flattenArrays #-}
1368+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1369+ => D.Stream m (MutArray a) -> D.Stream m a
1370+flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1684,30 +1384,19 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1684 return $ D.Skip $ OuterLoop st
1384 return $ D.Skip $ OuterLoop st
1686 step' _ (InnerLoop st contents p end) = do
1386 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1387+ x <- liftIO $ peekWith contents p
1688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1388 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1690−-- | Use the "reader" unfold instead.
1390+-- | Use the "readerRev" unfold instead.
1692−-- @concat = unfoldMany reader@
1392+-- @flattenArrays = unfoldMany readerRev@
1694-- We can try this if there are any fusion issues in the unfold.
1394-- We can try this if there are any fusion issues in the unfold.
1696−{-# INLINE_NORMAL concat #-}
1396+{-# INLINE_NORMAL flattenArraysRev #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1397+flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1698− => D.Stream m (MutArray a) -> D.Stream m a
1699−concat = concatWith liftIO
1701−{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704 => D.Stream m (MutArray a) -> D.Stream m a
1398 => D.Stream m (MutArray a) -> D.Stream m a
1705−flattenArrays = concat
1399+flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
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)
@@ -1725,33 +1414,16 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1725 return $ D.Skip $ OuterLoop st
1414 return $ D.Skip $ OuterLoop st
1727 step' _ (InnerLoop st contents p start) = do
1416 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1417+ x <- liftIO $ peekWith contents p
1729 let cur = INDEX_PREV(p,a)
1418 let cur = INDEX_PREV(p,a)
1730 return $ D.Yield x (InnerLoop st contents cur start)
1419 return $ D.Yield x (InnerLoop st contents cur start)
1732−-- | Use the "readerRev" unfold instead.
1734−-- @concat = unfoldMany readerRev@
1736−-- We can try this if there are any fusion issues in the unfold.
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
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
1749-------------------------------------------------------------------------------
1421-------------------------------------------------------------------------------
1750-- Unfolds
1422-- Unfolds
1751-------------------------------------------------------------------------------
1423-------------------------------------------------------------------------------
1753data ArrayUnsafe a = ArrayUnsafe
1425data ArrayUnsafe a = ArrayUnsafe
1754− {-# UNPACK #-} !MutByteArray -- contents
1426+ {-# UNPACK #-} !MutableByteArray -- contents
1755 {-# UNPACK #-} !Int -- index 1
1427 {-# UNPACK #-} !Int -- index 1
1756 {-# UNPACK #-} !Int -- index 2
1428 {-# UNPACK #-} !Int -- index 2
@@ -1781,7 +1453,7 @@ producerWith liftio = Producer step (return . toArrayUnsafe) extract
1781 -- few actions for correctness and execution order sanity. We want
1453 -- few actions for correctness and execution order sanity. We want
1782 -- the peek to occur right here and not lazily at some later point
1454 -- the peek to occur right here and not lazily at some later point
1783 -- because we want the peek to be ordered with respect to the touch.
1455 -- because we want the peek to be ordered with respect to the touch.
1784− !x <- liftio $ peekAt cur contents
1456+ !x <- liftio $ peekWith contents cur
1785 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
1457 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
1787 extract = return . fromArrayUnsafe
1459 extract = return . fromArrayUnsafe
@@ -1812,7 +1484,7 @@ readerRevWith liftio = Unfold step inject
1812 {-# INLINE_LATE step #-}
1484 {-# INLINE_LATE step #-}
1813 step (ArrayUnsafe _ start p) | p < start = return D.Stop
1485 step (ArrayUnsafe _ start p) | p < start = return D.Stop
1814 step (ArrayUnsafe contents start p) = do
1486 step (ArrayUnsafe contents start p) = do
1815− !x <- liftio $ peekAt p contents
1487+ !x <- liftio $ peekWith contents p
1816 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
1488 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
1818-- | Unfold an array into a stream in reverse order.
1490-- | Unfold an array into a stream in reverse order.
@@ -1843,7 +1515,7 @@ toListFB c n MutArray{..} = go arrStart
1843 -- evaluated/written to before we peek at them.
1515 -- evaluated/written to before we peek at them.
1845 let !x = unsafeInlineIO $ do
1517 let !x = unsafeInlineIO $ do
1846− r <- peekAt arrContents p
1518+ r <- peekWith arrContents p
1847 return r
1519 return r
1848 in c x (go (PTR_NEXT(p,a)))
1520 in c x (go (PTR_NEXT(p,a)))
@@ -1860,30 +1532,31 @@ toList MutArray{..} = liftIO $ go arrStart
1861 go p | assert (p <= arrEnd) (p == arrEnd) = return []
1533 go p | assert (p <= arrEnd) (p == arrEnd) = return []
1862 go p = do
1534 go p = do
1863− x <- peekAt p arrContents
1535+ x <- peekWith arrContents p
1864 (:) x <$> go (INDEX_NEXT(p,a))
1536 (:) x <$> go (INDEX_NEXT(p,a))
1866−{-# INLINE_NORMAL toStreamWith #-}
1538+{-# INLINE_NORMAL toStreamDWith #-}
1867−toStreamWith ::
1539+toStreamDWith ::
1868 forall m a. (Monad m, Unbox a)
1540 forall m a. (Monad m, Unbox a)
1869 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1541 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1870−toStreamWith liftio MutArray{..} = D.Stream step arrStart
1542+toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1874 {-# INLINE_LATE step #-}
1546 {-# INLINE_LATE step #-}
1875 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
1547 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
1876 step _ p = liftio $ do
1548 step _ p = liftio $ do
1877− r <- peekAt p arrContents
1549+ r <- peekWith arrContents p
1878 return $ D.Yield r (INDEX_NEXT(p,a))
1550 return $ D.Yield r (INDEX_NEXT(p,a))
1880−-- | Convert a 'MutArray' into a stream.
1552+-- | Use the 'reader' unfold instead.
1882−-- >>> read = Stream.unfold MutArray.reader
1554+-- @toStreamD = D.unfold reader@
1884−{-# INLINE_NORMAL read #-}
1556+-- We can try this if the unfold has any performance issues.
1885−read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1557+{-# INLINE_NORMAL toStreamD #-}
1886−read = toStreamWith liftIO
1558+toStreamD :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1559+toStreamD = toStreamDWith liftIO
1888{-# INLINE toStreamKWith #-}
1561{-# INLINE toStreamKWith #-}
1889toStreamKWith ::
1562toStreamKWith ::
@@ -1895,18 +1568,18 @@ toStreamKWith liftio MutArray{..} = go arrStart
1896 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
1569 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
1897 | otherwise =
1570 | otherwise =
1898− let elemM = peekAt p arrContents
1571+ let elemM = peekWith arrContents p
1899 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
1572 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
1901{-# INLINE toStreamK #-}
1574{-# INLINE toStreamK #-}
1902toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1575toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1903toStreamK = toStreamKWith liftIO
1576toStreamK = toStreamKWith liftIO
1905−{-# INLINE_NORMAL toStreamRevWith #-}
1578+{-# INLINE_NORMAL toStreamDRevWith #-}
1906−toStreamRevWith ::
1579+toStreamDRevWith ::
1907 forall m a. (Monad m, Unbox a)
1580 forall m a. (Monad m, Unbox a)
1908 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1581 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1909−toStreamRevWith liftio MutArray{..} =
1582+toStreamDRevWith liftio MutArray{..} =
1910 let p = INDEX_PREV(arrEnd,a)
1583 let p = INDEX_PREV(arrEnd,a)
1911 in D.Stream step p
1584 in D.Stream step p
@@ -1915,16 +1588,17 @@ toStreamRevWith liftio MutArray{..} =
1915 {-# INLINE_LATE step #-}
1588 {-# INLINE_LATE step #-}
1916 step _ p | p < arrStart = return D.Stop
1589 step _ p | p < arrStart = return D.Stop
1917 step _ p = liftio $ do
1590 step _ p = liftio $ do
1918− r <- peekAt p arrContents
1591+ r <- peekWith arrContents p
1919 return $ D.Yield r (INDEX_PREV(p,a))
1592 return $ D.Yield r (INDEX_PREV(p,a))
1921−-- | Convert a 'MutArray' into a stream in reverse order.
1594+-- | Use the 'readerRev' unfold instead.
1923−-- >>> readRev = Stream.unfold MutArray.readerRev
1596+-- @toStreamDRev = D.unfold readerRev@
1925−{-# INLINE_NORMAL readRev #-}
1598+-- We can try this if the unfold has any perf issues.
1926−readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1599+{-# INLINE_NORMAL toStreamDRev #-}
1927−readRev = toStreamRevWith liftIO
1600+toStreamDRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1601+toStreamDRev = toStreamDRevWith liftIO
1929{-# INLINE toStreamKRevWith #-}
1603{-# INLINE toStreamKRevWith #-}
1930toStreamKRevWith ::
1604toStreamKRevWith ::
@@ -1938,7 +1612,7 @@ toStreamKRevWith liftio MutArray {..} =
1939 go p | p < arrStart = K.nil
1613 go p | p < arrStart = K.nil
1940 | otherwise =
1614 | otherwise =
1941− let elemM = peekAt p arrContents
1615+ let elemM = peekWith arrContents p
1942 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
1616 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
1944{-# INLINE toStreamKRev #-}
1618{-# INLINE toStreamKRev #-}
@@ -1955,12 +1629,12 @@ toStreamKRev = toStreamKRevWith liftIO
1955-- | Strict left fold of an array.
1629-- | Strict left fold of an array.
1956{-# INLINE_NORMAL foldl' #-}
1630{-# INLINE_NORMAL foldl' #-}
1957foldl' :: (MonadIO m, Unbox a) => (b -> a -> b) -> b -> MutArray a -> m b
1631foldl' :: (MonadIO m, Unbox a) => (b -> a -> b) -> b -> MutArray a -> m b
1958−foldl' f z arr = D.foldl' f z $ read arr
1632+foldl' f z arr = D.foldl' f z $ toStreamD arr
1960-- | Right fold of an array.
1634-- | Right fold of an array.
1961{-# INLINE_NORMAL foldr #-}
1635{-# INLINE_NORMAL foldr #-}
1962foldr :: (MonadIO m, Unbox a) => (a -> b -> b) -> b -> MutArray a -> m b
1636foldr :: (MonadIO m, Unbox a) => (a -> b -> b) -> b -> MutArray a -> m b
1963−foldr f z arr = D.foldr f z $ read arr
1637+foldr f z arr = D.foldr f z $ toStreamD arr
1965-------------------------------------------------------------------------------
1639-------------------------------------------------------------------------------
@@ -1973,7 +1647,7 @@ foldr f z arr = D.foldr f z $ read arr
1974-- XXX Keep the bound intact to not lose any free space? Perf impact?
1648-- XXX Keep the bound intact to not lose any free space? Perf impact?
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1650+-- | @writeAppendNUnsafe n alloc@ appends up to @n@ input items to the supplied
1977-- array.
1651-- array.
1979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
1653-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1656,13 @@ foldr f z arr = D.foldr f z $ read arr
1982-- Any free space left in the array after appending @n@ elements is lost.
1656-- Any free space left in the array after appending @n@ elements is lost.
1984-- /Internal/
1658-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1659+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1660+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1988 -> m (MutArray a)
1662 -> m (MutArray a)
1989 -> Fold m a (MutArray a)
1663 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1664+writeAppendNUnsafe n action =
1665+ fmap fromArrayUnsafe $ FL.foldlM' step initial
@@ -2000,59 +1675,38 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2000 -- otherwise we lose that space.
1675 -- otherwise we lose that space.
2002 if free < needed
1677 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1678+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2004 else return arr
1679 else return arr
2005 return $ toArrayUnsafe arr1
1680 return $ toArrayUnsafe arr1
2007 step (ArrayUnsafe contents start end) x = do
1682 step (ArrayUnsafe contents start end) x = do
2008− liftIO $ pokeAt end contents x
1683+ liftIO $ pokeWith contents end x
2009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1684 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2011−{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012−{-# INLINE writeAppendNUnsafe #-}
2013−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2016− -> Fold m a (MutArray a)
2017−writeAppendNUnsafe = unsafeAppendN
2019-- | Append @n@ elements to an existing array. Any free space left in the array
1686-- | Append @n@ elements to an existing array. Any free space left in the array
2020-- after appending @n@ elements is lost.
1687-- after appending @n@ elements is lost.
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1689+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2024−{-# INLINE_NORMAL appendN #-}
1691+{-# INLINE_NORMAL writeAppendN #-}
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)
2029−-- XXX Deprecate in major
2030−-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031−{-# INLINE writeAppendN #-}
2032writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1692writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
2033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1693 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1694+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1696+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2037-- append the input stream. If there is no reserved space available in the
1697-- append the input stream. If there is no reserved space available in the
2038-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
1698-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
2039-- where @oldSize@ is the current size of the array in bytes.
1699-- where @oldSize@ is the current size of the array in bytes.
2041-- Note that the returned array may be a mutated version of original array.
1701-- Note that the returned array may be a mutated version of original array.
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1703+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2045-- /Pre-release/
1705-- /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)
2051−{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
2052{-# INLINE writeAppendWith #-}
1706{-# INLINE writeAppendWith #-}
2053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1707writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
2054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1708 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1709+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2057-- | @append action@ mutates the array generated by @action@ to append the
1711-- | @append action@ mutates the array generated by @action@ to append the
2058-- input stream. If there is no reserved space available in the array it is
1712-- input stream. If there is no reserved space available in the array it is
@@ -2060,144 +1714,72 @@ writeAppendWith = appendWith
2061-- Note that the returned array may be a mutated version of original array.
1715-- Note that the returned array may be a mutated version of original array.
2063−-- >>> append = MutArray.appendWith (* 2)
1717+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
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)
2070−-- XXX Deprecate in major
2071−-- {-# DEPRECATED writeAppend "Please use append instead." #-}
2072{-# INLINE writeAppend #-}
1719{-# INLINE writeAppend #-}
2073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
1720writeAppend :: forall m a. (MonadIO m, Unbox a) =>
2074 m (MutArray a) -> Fold m a (MutArray a)
1721 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1722+writeAppend = writeAppendWith (* 2)
2077-- XXX We can carry bound as well in the state to make sure we do not lose the
1724-- XXX We can carry bound as well in the state to make sure we do not lose the
2078-- remaining capacity. Need to check perf impact.
1725-- remaining capacity. Need to check perf impact.
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
1727+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
2081−-- function as argument.
1728+-- as argument.
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1730+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2085-- /Pre-release/
1732-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
1733+{-# INLINE_NORMAL writeNWithUnsafe #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1734+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1735 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1736+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2093 initial = toArrayUnsafe <$> alloc (max n 0)
1740 initial = toArrayUnsafe <$> alloc (max n 0)
2095 step (ArrayUnsafe contents start end) x = do
1742 step (ArrayUnsafe contents start end) x = do
2096− liftIO $ pokeAt end contents x
1743+ liftIO $ pokeWith contents end x
2098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1745 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2100−{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
1747+-- | Like 'writeN' but does not check the array bounds when writing. The fold
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
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)
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
2112-- driver must not call the step function more than 'n' times otherwise it will
1748-- driver must not call the step function more than 'n' times otherwise it will
2113-- corrupt the memory and crash. This function exists mainly because any
1749-- corrupt the memory and crash. This function exists mainly because any
2114-- conditional in the step function blocks fusion causing 10x performance
1750-- conditional in the step function blocks fusion causing 10x performance
2115-- slowdown.
1751-- slowdown.
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1753+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.newPinned
2119−{-# INLINE_NORMAL unsafeCreateOf #-}
1755+{-# INLINE_NORMAL writeNUnsafe #-}
2120−unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121− => Int -> Fold m a (MutArray a)
2122−unsafeCreateOf = writeNUnsafeAs Unpinned
2124−{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
2125−{-# INLINE writeNUnsafe #-}
2126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
1756writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
2127 => Int -> Fold m a (MutArray a)
1757 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1758+writeNUnsafe = writeNWithUnsafe newPinned
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
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
1760+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
2137−{-# INLINE pinnedWriteNUnsafe #-}
2138−pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
2139− => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
2143-- allocated using the @alloc@ function.
1761-- allocated using the @alloc@ function.
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
1763+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1764+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2148−{-# INLINE_NORMAL createOfWith #-}
1766+{-# INLINE_NORMAL writeNWith #-}
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)
2153−-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154−{-# INLINE writeNWith #-}
2155writeNWith :: forall m a. (MonadIO m, Unbox a)
1767writeNWith :: forall m a. (MonadIO m, Unbox a)
2156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1768 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1769+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2159−{-# INLINE_NORMAL writeNAs #-}
1771+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
2161− forall m a. (MonadIO m, Unbox a)
2164− -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
2168-- 'MutArray'.
1772-- 'MutArray'.
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
1774+-- >>> writeN = MutArray.writeNWith MutArray.newPinned
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
1775+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1776+-- >>> writeN n = MutArray.writeAppendN n (MutArray.newPinned n)
2174−{-# INLINE_NORMAL createOf #-}
1778+{-# INLINE_NORMAL writeN #-}
2175−createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176−createOf = writeNAs Unpinned
2178−-- XXX Deprecate in major
2179−-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180−{-# INLINE writeN #-}
2181writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1779writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1780+writeN = writeNWith newPinned
2184−-- | Like 'createOf' but creates a pinned array.
2185−{-# INLINE_NORMAL pinnedCreateOf #-}
2187− forall m a. (MonadIO m, Unbox a)
2189− -> Fold m a (MutArray a)
2190−pinnedCreateOf = writeNAs Pinned
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
2195− forall m a. (MonadIO m, Unbox a)
2197− -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1782+-- | Like writeNWithUnsafe but writes the array in reverse order.
2202-- /Internal/
1784-- /Internal/
2203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
1785{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2214,11 +1796,11 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2215 step (ArrayUnsafe contents start end) x = do
1797 step (ArrayUnsafe contents start end) x = do
2216 let ptr = INDEX_PREV(start,a)
1798 let ptr = INDEX_PREV(start,a)
2217− liftIO $ pokeAt ptr contents x
1799+ liftIO $ pokeWith contents ptr x
2219 $ ArrayUnsafe contents ptr end
1801 $ ArrayUnsafe contents ptr end
2221−-- | Like createOfWith but writes the array in reverse order.
1803+-- | Like writeNWith but writes the array in reverse order.
2223-- /Internal/
1805-- /Internal/
2224{-# INLINE_NORMAL writeRevNWith #-}
1806{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1808,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
2226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1808 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
1809writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
2229−-- | Like 'createOf' but writes the array in reverse order.
1811+-- | Like writeN but writes the array in reverse order.
2231-- /Pre-release/
1813-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
1814+{-# INLINE_NORMAL writeRevN #-}
2233−revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234−revCreateOf = writeRevNWith new
2236−{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237−{-# INLINE writeRevN #-}
2238writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1815writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1816+writeRevN = writeRevNWith newPinned
2241−-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
1818+-- | @writeNAligned align n@ folds a maximum of @n@ elements from the input
2242−-- input stream to a 'MutArray' aligned to the given size.
1819+-- stream to a 'MutArray' aligned to the given size.
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
1821+-- >>> writeNAligned align = MutArray.writeNWith (MutArray.newAlignedPinned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1822+-- >>> writeNAligned align n = MutArray.writeAppendN n (MutArray.newAlignedPinned align n)
2247-- /Pre-release/
1824-- /Pre-release/
2249−{-# INLINE_NORMAL pinnedWriteNAligned #-}
1826+{-# INLINE_NORMAL writeNAligned #-}
2250−pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1827+writeNAligned :: forall m a. (MonadIO m, Unbox a)
2251 => Int -> Int -> Fold m a (MutArray a)
1828 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1829+writeNAligned align = writeNWith (newAlignedPinned align)
2254-- XXX Buffer to a list instead?
1831-- XXX Buffer to a list instead?
2256-- | Buffer a stream into a stream of arrays.
1833-- | Buffer a stream into a stream of arrays.
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1835+-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2260-- Breaking an array into an array stream can be useful to consume a large
1837-- Breaking an array into an array stream can be useful to consume a large
2261-- array sequentially such that memory of the array is released incrementatlly.
1838-- array sequentially such that memory of the array is released incrementatlly.
@@ -2264,43 +1841,14 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
2265-- /Unimplemented/
1842-- /Unimplemented/
2267−{-# INLINE_NORMAL buildChunks #-}
1844+{-# INLINE_NORMAL writeChunks #-}
2268−buildChunks :: (MonadIO m, Unbox a) =>
2269− Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
2272−{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
2274writeChunks :: (MonadIO m, Unbox a) =>
1845writeChunks :: (MonadIO m, Unbox a) =>
2275 Int -> Fold m a (StreamK n (MutArray a))
1846 Int -> Fold m a (StreamK n (MutArray a))
2276−writeChunks = buildChunks
1847+writeChunks n = FL.many (writeN n) FL.toStreamK
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
2285− where
1849+-- XXX Compare writeWith with fromStreamD which uses an array of streams
2286−
1850+-- implementation. We can write this using writeChunks above if that is faster.
2287− initial = do
1851+-- If writeWith is faster then we should use that to implement
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
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
2297− step arr x = snocUnsafe arr x
2299− extract = liftIO . rightSize
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
2304-- fromStreamD.
1852-- fromStreamD.
2306-- XXX The realloc based implementation needs to make one extra copy if we use
1854-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,91 +1863,74 @@ writeWithAs ps elemCount =
2315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
1863-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2316-- malloc to compare against.
1864-- malloc to compare against.
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
1866+-- | @writeWith minCount@ folds the whole input to a single array. The array
2319-- starts at a size big enough to hold minCount elements, the size is doubled
1867-- starts at a size big enough to hold minCount elements, the size is doubled
2320-- every time the array needs to be grown.
1868-- every time the array needs to be grown.
2322-- /Caution! Do not use this on infinite streams./
1870-- /Caution! Do not use this on infinite streams./
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
1872+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.newPinned n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
1873+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
1874+-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
2328-- /Pre-release/
1876-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
1877+{-# INLINE_NORMAL writeWith #-}
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
2335−{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336−{-# INLINE writeWith #-}
2337writeWith :: forall m a. (MonadIO m, Unbox a)
1878writeWith :: forall m a. (MonadIO m, Unbox a)
2338 => Int -> Fold m a (MutArray a)
1879 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
1880+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (newPinned n)
1881+writeWith elemCount =
1882+ FL.rmapM extract $ FL.foldlM' step initial
1887+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1888+ liftIO $ newPinned elemCount
1890+ step arr@(MutArray _ start end bound) x
1891+ | INDEX_NEXT(end,a) > bound = do
1892+ let oldSize = end - start
1893+ newSize = max (oldSize * 2) 1
1894+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
1896+ step arr x = snocUnsafe arr x
1898+ extract = liftIO . rightSize
2341-- | Fold the whole input to a single array.
1900-- | Fold the whole input to a single array.
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
1902+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2344-- rounded up to the element size.
1903-- rounded up to the element size.
2346-- /Caution! Do not use this on infinite streams./
1905-- /Caution! Do not use this on infinite streams./
2348−{-# INLINE create #-}
2349−create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350−create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2352−-- XXX Deprecate in major
2353−-- {-# DEPRECATED write "Please use create instead." #-}
2354{-# INLINE write #-}
1907{-# INLINE write #-}
2355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1908write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
1909+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
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)
2362− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
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
2369-------------------------------------------------------------------------------
1911-------------------------------------------------------------------------------
2370-- construct from streams, known size
1912-- construct from streams, known size
2371-------------------------------------------------------------------------------
1913-------------------------------------------------------------------------------
2373−{-# INLINE_NORMAL fromStreamDNAs #-}
1915+-- | Use the 'writeN' fold instead.
2374−fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
1916+--
2375− => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
1917+-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
2376−fromStreamDNAs ps limit str = do
1918+--
2377− (arr :: MutArray a) <- newAs ps limit
1919+{-# INLINE_NORMAL fromStreamDN #-}
1920+fromStreamDN :: forall m a. (MonadIO m, Unbox a)
1921+ => Int -> D.Stream m a -> m (MutArray a)
1922+-- fromStreamDN n = D.fold (writeN n)
1923+fromStreamDN limit str = do
1924+ (arr :: MutArray a) <- liftIO $ newPinned limit
2378 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
1925 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
2379 return $ arr {arrEnd = end}
1926 return $ arr {arrEnd = end}
2383 fwrite arrContents ptr x = do
1930 fwrite arrContents ptr x = do
2384− liftIO $ pokeAt ptr arrContents x
1931+ liftIO $ pokeWith arrContents ptr x
2385 return $ INDEX_NEXT(ptr,a)
1932 return $ INDEX_NEXT(ptr,a)
2387−-- | Use the 'createOf' fold instead.
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
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
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
2403-- | Create a 'MutArray' from the first N elements of a list. The array is
1934-- | Create a 'MutArray' from the first N elements of a list. The array is
2404-- allocated to size N, if the list terminates before N elements then the
1935-- allocated to size N, if the list terminates before N elements then the
2405-- array may hold less than N elements.
1936-- array may hold less than N elements.
@@ -2408,80 +1939,15 @@ fromStreamDN = fromStreamN
2408fromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
1939fromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2409fromListN n xs = fromStreamDN n $ D.fromList xs
1940fromListN n xs = fromStreamDN n $ D.fromList xs
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
2416-- | Like fromListN but writes the array in reverse order.
1942-- | Like fromListN but writes the array in reverse order.
2418-- /Pre-release/
1944-- /Pre-release/
2419{-# INLINE fromListRevN #-}
1945{-# INLINE fromListRevN #-}
2420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
1946fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
1947+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
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
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)
2434− D.fold create $ D.morphInner (return . runIdentity) xs
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.
2443− _ <- unsafeAsPtr arr
2444− (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2445− return (arr {arrEnd = len})
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
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2460− return (arr {arrEnd = lenInt})
2462-------------------------------------------------------------------------------
1949-------------------------------------------------------------------------------
2463−-- convert a stream of arrays to a single array by reallocating and copying
1950+-- convert stream to a single array
2464−-------------------------------------------------------------------------------
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.
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
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.
2481− Nothing -> pure nil
2483−-------------------------------------------------------------------------------
2484−-- convert a stream of arrays to a single array by buffering arrays first
2485-------------------------------------------------------------------------------
1951-------------------------------------------------------------------------------
2487{-# INLINE arrayStreamKLength #-}
1953{-# INLINE arrayStreamKLength #-}
@@ -2491,72 +1957,29 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
2491-- | Convert an array stream to an array. Note that this requires peak memory
1957-- | Convert an array stream to an array. Note that this requires peak memory
2492-- that is double the size of the array stream.
1958-- that is double the size of the array stream.
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
2504−-- XXX Need to compare this with fromChunks and fromChunkList and keep the
2505−-- fastest or simplest one if all are equally fast.
2507−-- | Convert an array stream to an array. Note that this requires peak memory
2508−-- that is double the size of the array stream.
2510−-- Also see 'fromChunksRealloced'.
2512−{-# INLINE fromChunksK #-}
2513−fromChunksK :: (Unbox a, MonadIO m) =>
2514− StreamK m (MutArray a) -> m (MutArray a)
2515−fromChunksK = fromChunkskAs Unpinned
2517−{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518{-# INLINE fromArrayStreamK #-}
1960{-# INLINE fromArrayStreamK #-}
2519fromArrayStreamK :: (Unbox a, MonadIO m) =>
1961fromArrayStreamK :: (Unbox a, MonadIO m) =>
2520 StreamK m (MutArray a) -> m (MutArray a)
1962 StreamK m (MutArray a) -> m (MutArray a)
2521−fromArrayStreamK = fromChunksK
1963+fromArrayStreamK as = do
2522−
1964+ len <- arrayStreamKLength as
2523−{-# INLINE fromStreamDAs #-}
1965+ fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
2525− (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
2526−fromStreamDAs ps m =
2527− arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
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.
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.
2538−{-# INLINE fromStream #-}
2539−fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540−fromStream = fromStreamDAs Unpinned
2542−-- fromStream (Stream m) = P.fold create m
2543-- CAUTION: a very large number (millions) of arrays can degrade performance
1967-- CAUTION: a very large number (millions) of arrays can degrade performance
2544-- due to GC overhead because we need to buffer the arrays before we flatten
1968-- due to GC overhead because we need to buffer the arrays before we flatten
2545-- all the arrays.
1969-- all the arrays.
2547−-- XXX Compare if this is faster or "fold create".
1971+-- XXX Compare if this is faster or "fold write".
2549-- | We could take the approach of doubling the memory allocation on each
1973-- | We could take the approach of doubling the memory allocation on each
2550-- overflow. This would result in more or less the same amount of copying as in
1974-- overflow. This would result in more or less the same amount of copying as in
2551-- the chunking approach. However, if we have to shrink in the end then it may
1975-- the chunking approach. However, if we have to shrink in the end then it may
2552-- result in an extra copy of the entire data.
1976-- result in an extra copy of the entire data.
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
1978+-- >>> fromStreamD = StreamD.fold MutArray.write
2556{-# INLINE fromStreamD #-}
1980{-# INLINE fromStreamD #-}
2557−{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
2558fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
1981fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2559−fromStreamD = fromStream
1982+fromStreamD m = arrayStreamKFromStreamD m >>= fromArrayStreamK
2561-- | Create a 'MutArray' from a list. The list must be of finite size.
1984-- | Create a 'MutArray' from a list. The list must be of finite size.
@@ -2564,11 +1987,6 @@ fromStreamD = fromStream
2564fromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
1987fromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2565fromList xs = fromStreamD $ D.fromList xs
1988fromList xs = fromStreamD $ D.fromList xs
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
2572-- XXX We are materializing the whole list first for getting the length. Check
1990-- XXX We are materializing the whole list first for getting the length. Check
2573-- if the 'fromList' like chunked implementation would fare better.
1991-- if the 'fromList' like chunked implementation would fare better.
@@ -2577,75 +1995,44 @@ pinnedFromList xs = fromStreamDAs Pinned $ D.fromList xs
2577fromListRev :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
1995fromListRev :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2578fromListRev xs = fromListRevN (Prelude.length xs) xs
1996fromListRev xs = fromListRevN (Prelude.length xs) xs
2580−-------------------------------------------------------------------------------
2582−-------------------------------------------------------------------------------
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.
2588−{-# INLINE cloneAs #-}
2595− => PinnedState -> MutArray a -> m (MutArray a)
2598− let startSrc = arrStart src
2599− srcLen = arrEnd src - startSrc
2601− Unboxed.cloneSliceUnsafeAs ps startSrc srcLen (arrContents src)
2602− return $ MutArray newArrContents 0 srcLen srcLen
2604−{-# INLINE clone #-}
2611− => MutArray a -> m (MutArray a)
2612−clone = cloneAs Unpinned
2614−{-# INLINE pinnedClone #-}
2621− => MutArray a -> m (MutArray a)
2622−pinnedClone = cloneAs Pinned
2624-------------------------------------------------------------------------------
1998-------------------------------------------------------------------------------
2625-- Combining
1999-- Combining
2626-------------------------------------------------------------------------------
2000-------------------------------------------------------------------------------
2628−-- | Copy two arrays into a newly allocated array. If the first array is pinned
2002+-- | Put a sub range of a source array into a subrange of a destination array.
2629−-- the spliced array is also pinned.
2003+-- This is not safe as it does not check the bounds.
2004+{-# INLINE putSliceUnsafe #-}
2005+putSliceUnsafe :: MonadIO m => MutArray a -> Int -> MutArray a -> Int -> Int -> m ()
2006+putSliceUnsafe src srcStartBytes dst dstStartBytes lenBytes = liftIO $ do
2007+ assertM(lenBytes <= arrBound dst - dstStartBytes)
2008+ assertM(lenBytes <= arrEnd src - srcStartBytes)
2009+ let !(I# srcStartBytes#) = srcStartBytes
2010+ !(I# dstStartBytes#) = dstStartBytes
2011+ !(I# lenBytes#) = lenBytes
2012+ let arrS# = getMutableByteArray# (arrContents src)
2013+ arrD# = getMutableByteArray# (arrContents dst)
2014+ IO $ \s# -> (# copyMutableByteArray#
2015+ arrS# srcStartBytes# arrD# dstStartBytes# lenBytes# s#
2018+-- | Copy two arrays into a newly allocated array.
2630{-# INLINE spliceCopy #-}
2019{-# INLINE spliceCopy #-}
2631spliceCopy :: forall m a. MonadIO m =>
2020spliceCopy :: forall m a. MonadIO m =>
2632#ifdef DEVBUILD
2021#ifdef DEVBUILD
2633 Unbox a =>
2022 Unbox a =>
2635 MutArray a -> MutArray a -> m (MutArray a)
2024 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2025+spliceCopy arr1 arr2 = liftIO $ do
2637 let start1 = arrStart arr1
2026 let start1 = arrStart arr1
2638 start2 = arrStart arr2
2027 start2 = arrStart arr2
2639 len1 = arrEnd arr1 - start1
2028 len1 = arrEnd arr1 - start1
2640 len2 = arrEnd arr2 - start2
2029 len2 = arrEnd arr2 - start2
2030+ newArrContents <- liftIO $ Unboxed.newPinnedBytes (len1 + len2)
2641 let len = len1 + len2
2031 let len = len1 + len2
2642− newArrContents <-
2032+ newArr = MutArray newArrContents 0 len len
2643− if Unboxed.isPinned (arrContents arr1)
2033+ putSliceUnsafe arr1 start1 newArr 0 len1
2644− then liftIO $ Unboxed.pinnedNew len
2034+ putSliceUnsafe arr2 start2 newArr len1 len2
2645− else liftIO $ Unboxed.new len
2035+ return newArr
2646− putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
2647− putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
2648− return $ MutArray newArrContents 0 len len
2650-- | Really really unsafe, appends the second array into the first array. If
2037-- | Really really unsafe, appends the second array into the first array. If
2651-- the first array does not have enough space it may cause silent data
2038-- the first array does not have enough space it may cause silent data
@@ -2654,13 +2041,12 @@ spliceCopy arr1 arr2 = do
2654spliceUnsafe :: MonadIO m =>
2041spliceUnsafe :: MonadIO m =>
2655 MutArray a -> MutArray a -> m (MutArray a)
2042 MutArray a -> MutArray a -> m (MutArray a)
2656spliceUnsafe dst src =
2043spliceUnsafe dst src =
2657− do
2044+ liftIO $ do
2658 let startSrc = arrStart src
2045 let startSrc = arrStart src
2659 srcLen = arrEnd src - startSrc
2046 srcLen = arrEnd src - startSrc
2660 endDst = arrEnd dst
2047 endDst = arrEnd dst
2661 assertM(endDst + srcLen <= arrBound dst)
2048 assertM(endDst + srcLen <= arrBound dst)
2662− putSliceUnsafe
2049+ putSliceUnsafe src startSrc dst endDst srcLen
2663− (arrContents src) startSrc (arrContents dst) endDst srcLen
2664 return $ dst {arrEnd = endDst + srcLen}
2050 return $ dst {arrEnd = endDst + srcLen}
2666-- | @spliceWith sizer dst src@ mutates @dst@ to append @src@. If there is no
2052-- | @spliceWith sizer dst src@ mutates @dst@ to append @src@. If there is no
@@ -2676,7 +2062,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
2676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2062 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2677spliceWith sizer dst@(MutArray _ start end bound) src = do
2063spliceWith sizer dst@(MutArray _ start end bound) src = do
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2065+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
2680 in D.fold f (toStreamD src)
2066 in D.fold f (toStreamD src)
2682 assert (end <= bound) (return ())
2068 assert (end <= bound) (return ())
@@ -2692,7 +2078,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
2692 $ "splice: newSize is less than the total size "
2078 $ "splice: newSize is less than the total size "
2693 ++ "of arrays being appended. Please check the "
2079 ++ "of arrays being appended. Please check the "
2694 ++ "sizer function passed."
2080 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2081+ liftIO $ realloc newSizeInBytes dst
2696 else return dst
2082 else return dst
2697 spliceUnsafe dst1 src
2083 spliceUnsafe dst1 src
@@ -2704,8 +2090,6 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
2705-- >>> splice = MutArray.spliceWith (+)
2091-- >>> splice = MutArray.spliceWith (+)
2707−-- If the original array is pinned the spliced array is also pinned.
2709-- /Pre-release/
2093-- /Pre-release/
2710{-# INLINE splice #-}
2094{-# INLINE splice #-}
2711splice :: (MonadIO m, Unbox a) => MutArray a -> MutArray a -> m (MutArray a)
2095splice :: (MonadIO m, Unbox a) => MutArray a -> MutArray a -> m (MutArray a)
@@ -2729,24 +2113,14 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
2729-- Splitting
2113-- Splitting
2730-------------------------------------------------------------------------------
2114-------------------------------------------------------------------------------
2732−-- | Generate a stream of array slices using a predicate. The array element
2733−-- matching the predicate is dropped.
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)
2743-- | Drops the separator byte
2116-- | Drops the separator byte
2744{-# INLINE breakOn #-}
2117{-# INLINE breakOn #-}
2745breakOn :: MonadIO m
2118breakOn :: MonadIO m
2746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2119 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2120+breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2121+ -- XXX Instead of using asPtrUnsafe (pinning memory) we can pass unlifted
2122+ -- Addr# to memchr and it should be safe (from ghc 8.4).
2748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2123 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749− -- Need efficient stream based primitives that work on Word64.
2750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2124 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2751 let sepIndex = loc `minusPtr` p
2125 let sepIndex = loc `minusPtr` p
2752 return $
2126 return $
@@ -2767,41 +2141,32 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2770−-- | Like 'splitAt' but does not check whether the index is valid.
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)
2779− { arrContents = arrContents
2780− , arrStart = arrStart
2785− { arrContents = arrContents
2788− , arrBound = arrBound
2792-- | Create two slices of an array without copying the original array. The
2144-- | Create two slices of an array without copying the original array. The
2793-- specified index @i@ is the first index of the second slice.
2145-- specified index @i@ is the first index of the second slice.
2795−{-# INLINE splitAt #-}
2796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2147splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2148+splitAt i arr@MutArray{..} =
2798 let maxIndex = length arr - 1
2149 let maxIndex = length arr - 1
2799 in if i < 0
2150 in if i < 0
2800 then error "sliceAt: negative array index"
2151 then error "sliceAt: negative array index"
2801 else if i > maxIndex
2152 else if i > maxIndex
2802 then error $ "sliceAt: specified array index " ++ show i
2153 then error $ "sliceAt: specified array index " ++ show i
2803 ++ " is beyond the maximum index " ++ show maxIndex
2154 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2155+ else let off = i * SIZE_OF(a)
2158+ { arrContents = arrContents
2159+ , arrStart = arrStart
2164+ { arrContents = arrContents
2167+ , arrBound = arrBound
2806-------------------------------------------------------------------------------
2171-------------------------------------------------------------------------------
2807-- Casting
2172-- Casting
@@ -2851,16 +2216,13 @@ cast arr =
2851-- guarantees that unsafe calls will be performed in the calling thread. Making
2216-- guarantees that unsafe calls will be performed in the calling thread. Making
2852-- it safe to pass heap-allocated objects to unsafe functions.
2217-- it safe to pass heap-allocated objects to unsafe functions.
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2219+-- Unsafe because of direct pointer operations. The user must ensure that they
2855−-- operations. And we are safe from Haskell perspective because we will be
2220+-- are writing within the legal bounds of the array. Should we just name it
2856−-- pinning the memory.
2221+-- asPtr, the unsafety is implicit for any pointer operations. And we are safe
2857−--
2222+-- from Haskell perspective because we will be pinning the memory.
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.
2862−-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2224+-- | Use an @MutArray a@ as @Ptr a@. This is useful when we want to pass an array
2863−-- array as a pointer to some operating system call or to a "safe" FFI call.
2225+-- as a pointer to some operating system call or to a "safe" FFI call.
2865-- If the array is not pinned it is copied to pinned memory before passing it
2227-- If the array is not pinned it is copied to pinned memory before passing it
2866-- to the monadic action.
2228-- to the monadic action.
@@ -2870,382 +2232,58 @@ cast arr =
2870-- opportunistically before this operation occurs, to avoid the cost of a copy
2232-- opportunistically before this operation occurs, to avoid the cost of a copy
2871-- if possible.
2233-- if possible.
2873−-- /Unsafe/ because of direct pointer operations. The user must ensure that
2235+-- /Unsafe/
2874−-- they are writing within the legal bounds of the array.
2876-- /Pre-release/
2237-- /Pre-release/
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))
2884−{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
2885−{-# INLINE asPtrUnsafe #-}
2886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2239asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2240+asPtrUnsafe arr f = do
2888−
2241+ let contents = arrContents arr
2889−{-# INLINE unsafeAsPtr #-}
2242+ !ptr = Ptr (byteArrayContents#
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2243+ (unsafeCoerce# (getMutableByteArray# contents)))
2891−unsafeAsPtr arr f =
2244+ -- XXX Check if the array is pinned, if not, copy it to a pinned array
2892− Unboxed.unsafeAsPtr
2245+ -- XXX We should probably pass to the IO action the byte length of the array
2893− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2246+ -- as well so that bounds can be checked.
2247+ r <- f (ptr `plusPtr` arrStart arr)
2248+ liftIO $ touch contents
2895-------------------------------------------------------------------------------
2251-------------------------------------------------------------------------------
2896-- Equality
2252-- Equality
2897-------------------------------------------------------------------------------
2253-------------------------------------------------------------------------------
2899−-- | Byte compare two arrays. Compare the length of the arrays. If the length
2255+-- | Compare the length of the arrays. If the length is equal, compare the
2900−-- is equal, compare the lexicographical ordering of two underlying byte arrays
2256+-- lexicographical ordering of two underlying byte arrays otherwise return the
2901−-- otherwise return the result of length comparison.
2257+-- result of length comparison.
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.
2907-- /Pre-release/
2259-- /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
2918− r <- liftIO $ IO $ \s# ->
2921− (compareByteArrays#
2922− (unsafeCoerce# marr1)
2924− (unsafeCoerce# marr2)
2928− return $ compare r 0
2931{-# INLINE cmp #-}
2260{-# INLINE cmp #-}
2932−{-# DEPRECATED cmp "Please use byteCmp instead." #-}
2933cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2261cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2934−cmp = byteCmp
2262+cmp arr1 arr2 =
2936−-- | Byte equality of two arrays.
2264+ $ do
2937−--
2265+ let marr1 = getMutableByteArray# (arrContents arr1)
2938−-- >>> byteEq arr1 arr2 = (==) EQ $ MArray.byteCmp arr1 arr2
2266+ marr2 = getMutableByteArray# (arrContents arr2)
2939−--
2267+ !(I# st1#) = arrStart arr1
2940−-- /Unsafe/: See 'byteCmp'.
2268+ !(I# st2#) = arrStart arr2
2941−{-# INLINE byteEq #-}
2269+ !(I# len#) = byteLength arr1
2942−byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
2270+ case compare (byteLength arr1) (byteLength arr2) of
2943−byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2271+ EQ -> do
2944−
2272+ r <- liftIO $ IO $ \s# ->
2945−-------------------------------------------------------------------------------
2273+ let res =
2947−-------------------------------------------------------------------------------
2275+ (compareByteArrays#
2948−
2276+ (unsafeCoerce# marr1)
2949−-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2277+ st1#
2950−-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2278+ (unsafeCoerce# marr2)
2951−-- can leave some memory unused. They can split the last array to fit it
2279+ st2#
2952−-- exactly in the space.
2280+ len#)
2953−
2281+ in (# s#, res #)
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2282+ return $ compare r 0
2955−pCompactLeAs ::
2283+ x -> return x
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
2962− maxBytes = maxElems * SIZE_OF(a)
2964− functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2971− ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2973− else Parser.IPartial Nothing
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
2988− if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2992− buf2 <- spliceUnsafe buf1 arr
2993− return $ Parser.Partial 0 (Just buf2)
2995− extract Nothing = return $ Parser.Done 0 nil
2996− extract (Just buf) = return $ Parser.Done 0 buf
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.
3003−-- @maxElems@ must be greater than 0.
3005−-- Generates unpinned arrays irrespective of the pinning status of input
3009−{-# INLINE pCompactLE #-}
3011− forall m a. (MonadIO m, Unbox a)
3012− => Int -> Parser (MutArray a) m (MutArray a)
3013−pCompactLE = pCompactLeAs Unpinned
3015−-- | Pinned version of 'pCompactLE'.
3016−{-# INLINE pPinnedCompactLE #-}
3018− forall m a. (MonadIO m, Unbox a)
3019− => Int -> Parser (MutArray a) m (MutArray a)
3020−pPinnedCompactLE = pCompactLeAs Pinned
3022−data SpliceState s arr
3024− | SpliceBuffering s arr
3025− | SpliceYielding arr (SpliceState s arr)
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.
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)
3041− maxBytes = maxElems * SIZE_OF(a)
3043− functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
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"
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
3061− -- XXX Split the last array to use the space more compactly.
3062− step' gst (SpliceBuffering st buf) = do
3065− D.Yield arr s -> do
3066− let len = byteLength buf + byteLength arr
3069− D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3071− buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes 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)
3080− step' _ SpliceFinish = return D.Stop
3082− step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3085−{-# INLINE_NORMAL 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
3093− minBytes = minElems * SIZE_OF(a)
3095− functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3102− ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
3104− else FL.Partial Nothing
3108− $ let len = byteLength arr
3109− in if len >= minBytes
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
3116− if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
3120− buf2 <- spliceUnsafe buf1 arr
3122− then return $ FL.Done buf2
3123− else return $ FL.Partial (Just buf2)
3125− extract Nothing = return nil
3126− extract (Just buf) = return buf
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
3131−-- Generates unpinned arrays irrespective of the pinning status of input
3133−{-# INLINE fCompactGE #-}
3135− forall m a. (MonadIO m, Unbox a)
3136− => Int -> FL.Fold m (MutArray a) (MutArray a)
3137−fCompactGE = fCompactGeAs Unpinned
3139−-- | Pinned version of 'fCompactGE'.
3140−{-# INLINE fPinnedCompactGE #-}
3142− forall m a. (MonadIO m, Unbox a)
3143− => Int -> FL.Fold m (MutArray a) (MutArray a)
3144−fPinnedCompactGE = fCompactGeAs Pinned
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
3156− minBytes = minElems * SIZE_OF(a)
3158− functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
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"
3167− return $ first (Tuple' Nothing) r
3169− {-# INLINE runInner #-}
3170− runInner len acc buf =
3175− FL.Done _ -> return $ FL.Done ()
3179− return $ first (Tuple' Nothing) res
3180− else return $ FL.Partial $ Tuple' (Just buf) acc
3182− step (Tuple' Nothing r1) arr =
3183− runInner (byteLength arr) r1 arr
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
3192− buf2 <- spliceUnsafe buf1 arr
3193− runInner len r1 buf2
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
3199− -- extract forces the pending buffer to be sent to the fold which is not
3201− extract _ = error "lCompactGE: not designed for scanning"
3203− final (Tuple' Nothing r1) = final1 r1
3204− final (Tuple' (Just buf) r1) = do
3207− FL.Partial rr -> final1 rr
3208− FL.Done _ -> return ()
3210−-- | Like 'compactGE' but for transforming folds instead of stream.
3212−-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3214−-- Generates unpinned arrays irrespective of the pinning status of input
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
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
3227−-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228−-- the size becomes greater than or equal to @n@.
3230−-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
3232−{-# INLINE compactGE #-}
3234− (MonadIO m, Unbox a)
3235− => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236−compactGE n = D.foldMany (fCompactGE n)
3238−-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
3239−-- arrays of exact size @n@.
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)
3247-------------------------------------------------------------------------------
2285-------------------------------------------------------------------------------
3248−-- In-place mutation algorithms
2286+-- NFData
3249-------------------------------------------------------------------------------
2287-------------------------------------------------------------------------------
3251-- | Strip elements which match with predicate from both ends.
2289-- | Strip elements which match with predicate from both ends.
@@ -3274,7 +2312,7 @@ strip eq arr@MutArray{..} = liftIO $ do
3274 getStart cur = do
2312 getStart cur = do
3275 if cur < arrEnd
2313 if cur < arrEnd
3277− r <- peekAt cur arrContents
2315+ r <- peekWith arrContents cur
3279 then getStart (INDEX_NEXT(cur,a))
2317 then getStart (INDEX_NEXT(cur,a))
3280 else return cur
2318 else return cur
@@ -3284,7 +2322,7 @@ strip eq arr@MutArray{..} = liftIO $ do
3284 if cur > low
2322 if cur > low
3286 let prev = INDEX_PREV(cur,a)
2324 let prev = INDEX_PREV(cur,a)
3287− r <- peekAt prev arrContents
2325+ r <- peekWith arrContents prev
3289 then getLast prev low
2327 then getLast prev low
3290 else return cur
2328 else return cur