@@ -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,59 @@
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
39 , isPinned
38 , isPinned
41− -- ** Casting
40+ -- * Constructing and Writing
43− , castUnsafe -- XXX unsafeCast
48 -- ** Construction
41 -- ** Construction
51− -- *** New
44+ -- *** Uninitialized Arrays
52− -- | New arrays are always empty arrays with some reserve capacity to
45+ , newPinned
53− -- extend the length without reallocating.
46+ , newPinnedBytes
54− , emptyOf
47+ , newAlignedPinned
55− , newArrayWith -- emptyAlignedWith
49+ , newArrayWith
57− , pinnedNewAligned -- XXX not required
51+ -- *** Initialized Arrays
58− -- , new -- uninitialized array of specified length
52+ , withNewArrayUnsafePinned
65− -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
68− , splitAt -- XXX should be able to express using getSlice
71− -- *** Stream Folds
54+ -- *** From streams
72 , ArrayUnsafe (..)
55 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
56+ , writeNWithUnsafe
74− , unsafeCreateOf
57+ , writeNWith
75− , unsafePinnedCreateOf
58+ , writeNUnsafe
76− , pinnedCreateOf
59+ , writeNUnsafeAs
77− , createOfWith
60+ , writeN
78− , createOf
61+ , writeNAs
79− , revCreateOf
62+ , pinnedWriteNAligned
81− , pinnedCreate
64+ , writeWith
82− , createWith
65+ , write
84− -- , revCreate
67+ , writeRevN
86− -- *** From containers
70+ -- ** From containers
87 , fromListN
71 , fromListN
89 , fromList
72 , fromList
91 , fromListRevN
73 , fromListRevN
92 , fromListRev
74 , fromListRev
93− , fromStreamN
75+ , fromStreamDN
94− , fromStream
76+ , fromStreamD
96 , fromPureStream
77 , fromPureStream
100− , fromChunksRealloced -- fromSmallChunks
102− -- ** Random writes
79+ -- * Random writes
103 , putIndex
80 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
81+ , putIndexUnsafe
105 , putIndices
82 , putIndices
106 -- , putFromThenTo
83 -- , putFromThenTo
107 -- , putFrom -- start writing at the given position
84 -- , putFrom -- start writing at the given position
@@ -109,71 +86,78 @@ module Streamly.Internal.Data.MutArray.Type
109 -- , putFromTo
86 -- , putFromTo
110 -- , putFromRev
87 -- , putFromRev
111 -- , putUptoRev
88 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
89+ , modifyIndexUnsafe
113 , modifyIndex
90 , modifyIndex
114 , modifyIndices
91 , modifyIndices
116 , swapIndices
93 , swapIndices
117 , unsafeSwapIndices
94 , unsafeSwapIndices
119− -- ** Reading
96+ -- * Growing and Shrinking
97+ -- Arrays grow only at the end, though it is possible to grow on both sides
98+ -- and therefore have a cons as well as snoc. But that will require two
99+ -- bounds in the array representation.
121− -- *** Indexing
101+ -- ** Appending elements
122− , getIndex
102+ , snocWith
123− , getIndexUnsafe -- XXX unsafeGetIndex
103+ , snoc
124− -- , getFromThenTo
104+ , snocLinear
125− , getIndexRev -- getRevIndex?
105+ , snocMay
126− , indexReader
106+ , snocUnsafe
127− , indexReaderWith
107+
108+ -- ** Appending streams
109+ , writeAppendNUnsafe
114+ -- * Eliminating and Reading
129− -- *** To Streams
116+ -- ** To streams
131 , readRev
127 , readRev
134 , toStreamK
128 , toStreamK
136 , toStreamKRev
129 , toStreamKRev
139− -- *** To Containers
143 -- experimental
132 -- experimental
144 , producerWith
133 , producerWith
145 , producer
134 , producer
147− , reader
136+ -- ** Random reads
148− , readerRevWith
137+ , getIndex
149− , readerRev
138+ , getIndexUnsafe
151− -- ** Size and Capacity
140+ , getIndicesD
152− -- *** Size
141+ -- , getFromThenTo
153− , length
142+ , getIndexRev
161− -- *** Capacity Management
144+ -- * Memory Management
162 , blockSize
145 , blockSize
163 , arrayChunkBytes
146 , arrayChunkBytes
164 , allocBytesToElemCount
147 , allocBytesToElemCount
165− , realloc -- this is "resize"
148+ , realloc
167− , growExp
150+ , resizeExp
168 , rightSize
151 , rightSize
170− -- ** Folding
153+ -- * Size
171− , foldl'
154+ , length
172− , foldr
155+ , byteLength
173− , byteCmp
156+ -- , capacity
174− , byteEq
157+ , byteCapacity
176− -- ** In-place Mutation Algorithms
160+ -- * In-place Mutation Algorithms
178 , reverse
162 , reverse
179 , permute
163 , permute
@@ -183,121 +167,60 @@ module Streamly.Internal.Data.MutArray.Type
183 , mergeBy
167 , mergeBy
186− -- ** Growing and Shrinking
170+ -- * Casting
187− -- | Arrays grow only at the end, though it is possible to grow on both
171+ , cast
188− -- sides and therefore have a cons as well as snoc. But that will require
172+ , castUnsafe
189− -- both lower and upper bound in the array representation.
173+ , asBytes
191− -- *** Appending elements
176+ -- * Folding
192− , snocWith
177+ , foldl'
194− , snocLinear
179+ , cmp
196− , snocUnsafe -- XXX unsafeSnoc
181+ -- * Arrays of arrays
182+ -- We can add dimensionality parameter to the array type to get
183+ -- multidimensional arrays. Multidimensional arrays would just be a
184+ -- convenience wrapper on top of single dimensional arrays.
198− -- *** Appending streams
186+ -- | Operations dealing with multiple arrays, streams of arrays or
199− , unsafeAppendN
187+ -- multidimensional array representations.
189+ -- ** Construct from streams
192+ , arrayStreamKFromStreamD
195+ -- ** Eliminate to streams
200+ -- ** Construct from arrays
201+ -- get chunks without copying
204+ -- , getSlicesFromLenN
205+ , splitAt -- XXX should be able to express using getSlice
204− -- *** Appending arrays
208+ -- ** Appending arrays
205 , spliceCopy
209 , spliceCopy
206 , spliceWith
210 , spliceWith
208 , spliceExp
212 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
213+ , spliceUnsafe
210 -- , putSlice
215 -- , putSlice
211 -- , appendSlice
216 -- , appendSlice
212 -- , appendSliceFrom
217 -- , 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
219+ -- * Utilities
264 , roundUpToPower2
220 , roundUpToPower2
267 , c_memchr
223 , c_memchr
286− , writeAppendNUnsafe
293− , pinnedWriteNUnsafe
296− , pinnedWriteNAligned -- XXX not required
@@ -308,52 +231,48 @@ where
309import Control.Monad (when, void)
232import Control.Monad (when, void)
310import Control.Monad.IO.Class (MonadIO(..))
233import Control.Monad.IO.Class (MonadIO(..))
311−import Data.Bifunctor (first)
312import Data.Bits (shiftR, (.|.), (.&.))
234import Data.Bits (shiftR, (.|.), (.&.))
313import Data.Functor.Identity (Identity(..))
235import Data.Functor.Identity (Identity(..))
314import Data.Proxy (Proxy(..))
236import Data.Proxy (Proxy(..))
315import Data.Word (Word8)
237import Data.Word (Word8)
316import Foreign.C.Types (CSize(..), CInt(..))
238import Foreign.C.Types (CSize(..), CInt(..))
317import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
239import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
318−import Streamly.Internal.Data.MutByteArray.Type
240+import Streamly.Internal.Data.Unbox
319− ( MutByteArray(..)
241+ ( MutableByteArray(..)
320 , PinnedState(..)
243 , PinnedState(..)
321 , getMutableByteArray#
244 , getMutableByteArray#
322− , putSliceUnsafe
245+ , touch
324−import Streamly.Internal.Data.Unbox (Unbox(..))
325import GHC.Base
247import GHC.Base
327 , Int(..)
249 , Int(..)
250+ , byteArrayContents#
328 , compareByteArrays#
251 , compareByteArrays#
329 , copyMutableByteArray#
252 , copyMutableByteArray#
331import GHC.Base (noinline)
254import GHC.Base (noinline)
332−import GHC.Exts (unsafeCoerce#, Addr#)
255+import GHC.Exts (unsafeCoerce#)
333import GHC.Ptr (Ptr(..))
256import GHC.Ptr (Ptr(..))
335import Streamly.Internal.Data.Fold.Type (Fold(..))
258import Streamly.Internal.Data.Fold.Type (Fold(..))
336import Streamly.Internal.Data.Producer.Type (Producer (..))
259import Streamly.Internal.Data.Producer.Type (Producer (..))
337−import Streamly.Internal.Data.Stream.Type (Stream)
260+import Streamly.Internal.Data.Stream.StreamD.Type (Stream)
338−import Streamly.Internal.Data.Parser.Type (Parser (..))
261+import Streamly.Internal.Data.Stream.StreamK.Type (StreamK)
339−import Streamly.Internal.Data.StreamK.Type (StreamK)
340import Streamly.Internal.Data.SVar.Type (adaptState, defState)
262import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341−import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
342import Streamly.Internal.Data.Unfold.Type (Unfold(..))
263import Streamly.Internal.Data.Unfold.Type (Unfold(..))
343import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
264import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
345import qualified Streamly.Internal.Data.Fold.Type as FL
266import 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
267import qualified Streamly.Internal.Data.Producer as Producer
350−import qualified Streamly.Internal.Data.Stream.Type as D
268+import qualified Streamly.Internal.Data.Stream.StreamD.Type as D
351−import qualified Streamly.Internal.Data.Stream.Lift as D
269+import qualified Streamly.Internal.Data.Stream.StreamD.Lift as D
352−import qualified Streamly.Internal.Data.StreamK.Type as K
270+import qualified Streamly.Internal.Data.Stream.StreamK.Type as K
271+import qualified Streamly.Internal.Data.Unbox as Unboxed
353import qualified Prelude
272import qualified Prelude
355import Prelude hiding
274import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
275+ (Foldable(..), read, unlines, splitAt, reverse, truncate)
358#include "DocTestDataMutArray.hs"
277#include "DocTestDataMutArray.hs"
@@ -361,7 +280,6 @@ import Prelude hiding
361-- Foreign helpers
280-- Foreign helpers
362-------------------------------------------------------------------------------
281-------------------------------------------------------------------------------
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
283foreign import ccall unsafe "string.h memcpy" c_memcpy
366 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
284 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
@@ -371,9 +289,6 @@ foreign import ccall unsafe "string.h memchr" c_memchr
371foreign import ccall unsafe "string.h memcmp" c_memcmp
289foreign import ccall unsafe "string.h memcmp" c_memcmp
372 :: Ptr Word8 -> Ptr Word8 -> CSize -> IO CInt
290 :: 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
292-- | 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.
293-- how many elements of that type will completely fit in those bytes.
@@ -428,7 +343,7 @@ data MutArray a =
428 -- The array is a range into arrContents. arrContents may be a superset of
343 -- 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.
344 -- the slice represented by the array. All offsets are in bytes.
431− { arrContents :: {-# UNPACK #-} !MutByteArray
346+ { arrContents :: {-# UNPACK #-} !MutableByteArray
432 , arrStart :: {-# UNPACK #-} !Int -- ^ index into arrContents
347 , arrStart :: {-# UNPACK #-} !Int -- ^ index into arrContents
433 , arrEnd :: {-# UNPACK #-} !Int -- ^ index into arrContents
348 , arrEnd :: {-# UNPACK #-} !Int -- ^ index into arrContents
434 -- Represents the first invalid index of
349 -- Represents the first invalid index of
@@ -440,25 +355,22 @@ data MutArray a =
440-- Pinning & Unpinning
355-- Pinning & Unpinning
441-------------------------------------------------------------------------------
356-------------------------------------------------------------------------------
443−-- | Return a copy of the array in pinned memory if unpinned, else return the
358+-- | Copy the 'MutArray' to pinned memory if unpinned, else do nothing. The
444−-- original array.
359+-- overhead is a copy if the input array is unpinned.
445{-# INLINE pin #-}
360{-# INLINE pin #-}
446pin :: MutArray a -> IO (MutArray a)
361pin :: MutArray a -> IO (MutArray a)
447−pin arr@MutArray{..} =
362+pin arr@MutArray{..} = do
448− if Unboxed.isPinned arrContents
363+ contents <- Unboxed.pin arrContents
449− then pure arr
364+ return $ arr {arrContents = contents}
450− else pinnedClone arr
452−-- | Return a copy of the array in unpinned memory if pinned, else return the
366+-- | Copy the 'MutArray' to unpinned memory if pinned, else do nothing. The
453−-- original array.
367+-- overhead is a copy if the input array is pinned.
454{-# INLINE unpin #-}
368{-# INLINE unpin #-}
455unpin :: MutArray a -> IO (MutArray a)
369unpin :: MutArray a -> IO (MutArray a)
456−unpin arr@MutArray{..} =
370+unpin arr@MutArray{..} = do
457− if Unboxed.isPinned arrContents
371+ contents <- Unboxed.unpin arrContents
458− then clone arr
372+ return $ arr {arrContents = contents}
461−-- | Return 'True' if the array is allocated in pinned memory.
462{-# INLINE isPinned #-}
374{-# INLINE isPinned #-}
463isPinned :: MutArray a -> Bool
375isPinned :: MutArray a -> Bool
464isPinned MutArray{..} = Unboxed.isPinned arrContents
376isPinned MutArray{..} = Unboxed.isPinned arrContents
@@ -476,11 +388,9 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
476-- files and arrays.
388-- files and arrays.
478-- GHC always guarantees word-aligned memory, alignment is important only when
390-- GHC always guarantees word-aligned memory, alignment is important only when
479−-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
391+-- we need more than that. See stg_newAlignedPinnedByteArrayzh and
480-- allocatePinned in GHC source.
392-- 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
394-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485-- length and with a capacity to hold @count@ elements, using @allocator
395-- length and with a capacity to hold @count@ elements, using @allocator
486-- size alignment@ as the memory allocator function.
396-- size alignment@ as the memory allocator function.
@@ -493,7 +403,7 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
493-- /Pre-release/
403-- /Pre-release/
494{-# INLINE newArrayWith #-}
404{-# INLINE newArrayWith #-}
495newArrayWith :: forall m a. (MonadIO m, Unbox a)
405newArrayWith :: forall m a. (MonadIO m, Unbox a)
496− => (Int -> Int -> m MutByteArray) -> Int -> Int -> m (MutArray a)
406+ => (Int -> Int -> m MutableByteArray) -> Int -> Int -> m (MutArray a)
497newArrayWith alloc alignSize count = do
407newArrayWith alloc alignSize count = do
498 let size = max (count * SIZE_OF(a)) 0
408 let size = max (count * SIZE_OF(a)) 0
499 contents <- alloc size alignSize
409 contents <- alloc size alignSize
@@ -504,25 +414,12 @@ newArrayWith alloc alignSize count = do
504 , arrBound = size
414 , 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
418#ifdef DEVBUILD
522 Unbox a =>
419 Unbox a =>
524 MutArray a
421 MutArray a
525−nil = empty
422+nil = MutArray Unboxed.nil 0 0 0
527{-# INLINE newBytesAs #-}
424{-# INLINE newBytesAs #-}
528newBytesAs :: MonadIO m =>
425newBytesAs :: MonadIO m =>
@@ -531,7 +428,7 @@ newBytesAs :: MonadIO m =>
532 PinnedState -> Int -> m (MutArray a)
429 PinnedState -> Int -> m (MutArray a)
533newBytesAs ps bytes = do
430newBytesAs ps bytes = do
534− contents <- liftIO $ Unboxed.newBytesAs ps bytes
431+ contents <- liftIO $ Unboxed.newBytes ps bytes
535 return $ MutArray
432 return $ MutArray
536 { arrContents = contents
433 { arrContents = contents
537 , arrStart = 0
434 , arrStart = 0
@@ -539,62 +436,66 @@ newBytesAs ps bytes = do
539 , arrBound = bytes
436 , arrBound = bytes
542−-- | Allocates a pinned empty array that with a reserved capacity of bytes.
439+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
543−-- The memory of the array is uninitialized and the allocation is aligned as
440+-- the array is uninitialized and the allocation is aligned as per the
544−-- per the 'Unboxed' instance of the type.
441+-- 'Unboxed' instance of the type.
546-- /Pre-release/
443-- /Pre-release/
547−{-# INLINE pinnedNewBytes #-}
444+{-# INLINE newPinnedBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
445+newPinnedBytes :: MonadIO m =>
549−pinnedNewBytes :: MonadIO m =>
550#ifdef DEVBUILD
446#ifdef DEVBUILD
551 Unbox a =>
447 Unbox a =>
553 Int -> m (MutArray a)
449 Int -> m (MutArray a)
554−pinnedNewBytes = newBytesAs Pinned
450+newPinnedBytes = newBytesAs Pinned
556-- | Like 'newArrayWith' but using an allocator is a pinned memory allocator and
452-- | Like 'newArrayWith' but using an allocator is a pinned memory allocator and
557-- the alignment is dictated by the 'Unboxed' instance of the type.
453-- the alignment is dictated by the 'Unboxed' instance of the type.
559-- /Internal/
455-- /Internal/
560−{-# INLINE pinnedNewAligned #-}
456+{-# INLINE newAlignedPinned #-}
561−pinnedNewAligned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
457+newAlignedPinned :: (MonadIO m, Unbox a) => Int -> Int -> m (MutArray a)
562−pinnedNewAligned =
458+newAlignedPinned =
563− newArrayWith (\s a -> liftIO $ Unboxed.pinnedNewAlignedBytes s a)
459+ newArrayWith (\s a -> liftIO $ Unboxed.newAlignedPinnedBytes s a)
565{-# INLINE newAs #-}
461{-# INLINE newAs #-}
566newAs :: (MonadIO m, Unbox a) => PinnedState -> Int -> m (MutArray a)
462newAs :: (MonadIO m, Unbox a) => PinnedState -> Int -> m (MutArray a)
567newAs ps =
463newAs ps =
568 newArrayWith
464 newArrayWith
569− (\s _ -> liftIO $ Unboxed.newBytesAs ps s)
465+ (\s _ -> liftIO $ Unboxed.newBytes ps s)
570 (error "new: alignment is not used in unpinned arrays.")
466 (error "new: alignment is not used in unpinned arrays.")
572-- XXX can unaligned allocation be more efficient when alignment is not needed?
468-- 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.
470+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
471+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
472+-- instance of the type.
589−{-# INLINE emptyOf #-}
474+{-# INLINE newPinned #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
475+newPinned :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
476+newPinned = newAs Pinned
593−-- XXX Deprecate in major
478+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
479+-- of the array is uninitialized.
595{-# INLINE new #-}
481{-# INLINE new #-}
596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
482new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
483+new = newAs Unpinned
485+-- XXX This should create a full length uninitialzed array so that the pointer
488+-- | Allocate a pinned MutArray of the given size and run an IO action passing
489+-- the array start pointer.
492+{-# INLINE withNewArrayUnsafePinned #-}
493+withNewArrayUnsafePinned ::
494+ (MonadIO m, Unbox a) => Int -> (Ptr a -> m ()) -> m (MutArray a)
495+withNewArrayUnsafePinned count f = do
496+ arr <- newPinned count
498+ $ \p -> f p >> return arr
599-------------------------------------------------------------------------------
500-------------------------------------------------------------------------------
600-- Random writes
501-- Random writes
@@ -610,7 +511,7 @@ putIndexUnsafe :: forall m a. (MonadIO m, Unbox a)
610putIndexUnsafe i MutArray{..} x = do
511putIndexUnsafe i MutArray{..} x = do
611 let index = INDEX_OF(arrStart, i, a)
512 let index = INDEX_OF(arrStart, i, a)
612 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
513 assert (i >= 0 && INDEX_VALID(index, arrEnd, a)) (return ())
613− liftIO $ pokeAt index arrContents x
514+ liftIO $ pokeByteIndex index arrContents x
615invalidIndex :: String -> Int -> a
516invalidIndex :: String -> Int -> a
616invalidIndex label i =
517invalidIndex label i =
@@ -628,7 +529,7 @@ putIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m ()
628putIndex i MutArray{..} x = do
529putIndex i MutArray{..} x = do
629 let index = INDEX_OF(arrStart,i,a)
530 let index = INDEX_OF(arrStart,i,a)
630 if i >= 0 && INDEX_VALID(index,arrEnd,a)
531 if i >= 0 && INDEX_VALID(index,arrEnd,a)
631− then liftIO $ pokeAt index arrContents x
532+ then liftIO $ pokeByteIndex index arrContents x
632 else invalidIndex "putIndex" i
533 else invalidIndex "putIndex" i
634-- | Write an input stream of (index, value) pairs to an array. Throws an
535-- | Write an input stream of (index, value) pairs to an array. Throws an
@@ -642,7 +543,7 @@ putIndices arr = FL.foldlM' step (return ())
645− step () (i, x) = putIndex i arr x
546+ step () (i, x) = liftIO (putIndex i arr x)
647-- | Modify a given index of an array using a modifier function.
548-- | Modify a given index of an array using a modifier function.
@@ -654,9 +555,9 @@ modifyIndexUnsafe :: forall m a b. (MonadIO m, Unbox a) =>
654modifyIndexUnsafe i MutArray{..} f = liftIO $ do
555modifyIndexUnsafe i MutArray{..} f = liftIO $ do
655 let index = INDEX_OF(arrStart,i,a)
556 let index = INDEX_OF(arrStart,i,a)
656 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
557 assert (i >= 0 && INDEX_NEXT(index,a) <= arrEnd) (return ())
657− r <- peekAt index arrContents
558+ r <- peekByteIndex index arrContents
658 let (x, res) = f r
559 let (x, res) = f r
659− pokeAt index arrContents x
560+ pokeByteIndex index arrContents x
660 return res
561 return res
662-- | Modify a given index of an array using a modifier function.
563-- | Modify a given index of an array using a modifier function.
@@ -668,9 +569,9 @@ modifyIndex i MutArray{..} f = do
668 let index = INDEX_OF(arrStart,i,a)
569 let index = INDEX_OF(arrStart,i,a)
669 if i >= 0 && INDEX_VALID(index,arrEnd,a)
570 if i >= 0 && INDEX_VALID(index,arrEnd,a)
670 then liftIO $ do
571 then liftIO $ do
671− r <- peekAt index arrContents
572+ r <- peekByteIndex index arrContents
672 let (x, res) = f r
573 let (x, res) = f r
673− pokeAt index arrContents x
574+ pokeByteIndex index arrContents x
674 return res
575 return res
675 else invalidIndex "modifyIndex" i
576 else invalidIndex "modifyIndex" i
@@ -704,8 +605,8 @@ modify MutArray{..} f = liftIO $
706 when (INDEX_VALID(i,arrEnd,a)) $ do
607 when (INDEX_VALID(i,arrEnd,a)) $ do
707− r <- peekAt i arrContents
608+ r <- peekByteIndex i arrContents
708− pokeAt i arrContents (f r)
609+ pokeByteIndex i arrContents (f r)
709 go (INDEX_NEXT(i,a))
610 go (INDEX_NEXT(i,a))
711-- XXX We could specify the number of bytes to swap instead of Proxy. Need
612-- XXX We could specify the number of bytes to swap instead of Proxy. Need
@@ -714,15 +615,15 @@ modify MutArray{..} f = liftIO $
714swapArrayByteIndices ::
615swapArrayByteIndices ::
715 forall a. Unbox a
616 forall a. Unbox a
716 => Proxy a
617 => Proxy a
717− -> MutByteArray
618+ -> MutableByteArray
721swapArrayByteIndices _ arrContents i1 i2 = do
622swapArrayByteIndices _ arrContents i1 i2 = do
722− r1 <- peekAt i1 arrContents
623+ r1 <- peekByteIndex i1 arrContents
723− r2 <- peekAt i2 arrContents
624+ r2 <- peekByteIndex i2 arrContents
724− pokeAt i1 arrContents (r2 :: a)
625+ pokeByteIndex i1 arrContents (r2 :: a)
725− pokeAt i2 arrContents (r1 :: a)
626+ pokeByteIndex i2 arrContents (r1 :: a)
727-- | Swap the elements at two indices without validating the indices.
628-- | Swap the elements at two indices without validating the indices.
@@ -838,23 +739,26 @@ arrayChunkBytes = 1024
838roundDownTo :: Int -> Int -> Int
739roundDownTo :: Int -> Int -> Int
839roundDownTo elemSize size = size - (size `mod` elemSize)
740roundDownTo elemSize size = size - (size `mod` elemSize)
742+-- XXX See if resizing can be implemented by reading the old array as a stream
743+-- and then using writeN to the new array.
841-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
745-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
746-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843-- which complicates some inspection tests.
747-- which complicates some inspection tests.
845−{-# NOINLINE reallocExplicitAs #-}
749+{-# NOINLINE reallocExplicit #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
750+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
751+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848 assertM(arrEnd <= arrBound)
752 assertM(arrEnd <= arrBound)
850 -- Allocate new array
754 -- Allocate new array
851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
755 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852 contents <-
756 contents <-
853− if ps == Pinned
757+ if Unboxed.isPinned arrContents
854− then Unboxed.pinnedNew newCapMaxInBytes
758+ then Unboxed.newPinnedBytes newCapMaxInBytes
855− else Unboxed.new newCapMaxInBytes
759+ else Unboxed.newUnpinnedBytes newCapMaxInBytes
856− let !(MutByteArray mbarrFrom#) = arrContents
760+ let !(MutableByteArray mbarrFrom#) = arrContents
857− !(MutByteArray mbarrTo#) = contents
761+ !(MutableByteArray mbarrTo#) = contents
859 -- Copy old data
763 -- Copy old data
860 let oldStart = arrStart
764 let oldStart = arrStart
@@ -875,10 +779,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875 , arrBound = newCapInBytes
779 , 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
782-- | @realloc newCapacity array@ reallocates the array to the specified
883-- capacity in bytes.
783-- capacity in bytes.
@@ -887,15 +787,9 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
887-- down to multiples of array size. If the new size is more than
787-- 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).
788-- '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 #-}
790{-# INLINABLE realloc #-}
892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
791realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
792+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
794-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901-- in error messages and the capSizer is used to determine the capacity of the
795-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +812,14 @@ reallocWith label capSizer minIncrBytes arr = do
920 badSize newSize =
814 badSize newSize =
921− Prelude.concat
815+ concat
923 , ": new array size (in bytes) is less than required size "
817 , ": new array size (in bytes) is less than required size "
924 , show newSize
818 , show newSize
925 , ". Please check the sizing function passed."
819 , ". Please check the sizing function passed."
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
822+-- | @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
823-- 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.
824-- the specified capacity is less than the length of the array.
@@ -933,46 +827,34 @@ reallocWith label capSizer minIncrBytes arr = do
933-- the block size (4K).
827-- the block size (4K).
935-- /Pre-release/
829-- /Pre-release/
936−{-# INLINE grow #-}
830+{-# INLINE resize #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
831+resize :: forall m a. (MonadIO m, Unbox a) =>
938 Int -> MutArray a -> m (MutArray a)
832 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
833+resize nElems arr@MutArray{..} = do
940 let req = SIZE_OF(a) * nElems
834 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
835+ len = arrEnd - arrStart
942− if req < cap
836+ if req < len
943 then return arr
837 then return arr
944 else realloc req arr
838 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
840+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
953−-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
841+-- then it is rounded up to the closest power of 2.
955-- /Pre-release/
843-- /Pre-release/
956−{-# INLINE growExp #-}
844+{-# INLINE resizeExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
845+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958 Int -> MutArray a -> m (MutArray a)
846 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
847+resizeExp nElems arr@MutArray{..} = do
960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
848 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
962 if req > largeObjectThreshold
850 if req > largeObjectThreshold
963 then roundUpToPower2 req
851 then roundUpToPower2 req
965− cap = arrBound - arrStart
853+ len = arrEnd - arrStart
966− if req1 < cap
854+ if req1 < len
967 then return arr
855 then return arr
968 else realloc req1 arr
856 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
858-- | Resize the allocated memory to drop any reserved free space at the end of
977-- the array and reallocate it to reduce wastage.
859-- the array and reallocate it to reduce wastage.
@@ -1017,7 +899,7 @@ rightSize arr@MutArray{..} = do
1017snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
899snocNewEnd :: (MonadIO m, Unbox a) => Int -> MutArray a -> a -> m (MutArray a)
1018snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
900snocNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1019 assert (newEnd <= arrBound) (return ())
901 assert (newEnd <= arrBound) (return ())
1020− pokeAt arrEnd arrContents x
902+ pokeByteIndex arrEnd arrContents x
1021 return $ arr {arrEnd = newEnd}
903 return $ arr {arrEnd = newEnd}
1023-- | Really really unsafe, appends the element into the first array, may
905-- | Really really unsafe, appends the element into the first array, may
@@ -1037,7 +919,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037{-# INLINE snocMay #-}
919{-# INLINE snocMay #-}
1038snocMay :: forall m a. (MonadIO m, Unbox a) =>
920snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039 MutArray a -> a -> m (Maybe (MutArray a))
921 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
922+snocMay arr@MutArray{..} x = liftIO $ do
1041 let newEnd = INDEX_NEXT(arrEnd,a)
923 let newEnd = INDEX_NEXT(arrEnd,a)
1042 if newEnd <= arrBound
924 if newEnd <= arrBound
1043 then Just <$> snocNewEnd newEnd arr x
925 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +933,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1052 -> m (MutArray a)
934 -> m (MutArray a)
1053snocWithRealloc sizer arr x = do
935snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
936+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055 snocUnsafe arr1 x
937 snocUnsafe arr1 x
1057-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
939-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +955,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073 -> MutArray a
955 -> MutArray a
1075 -> m (MutArray a)
957 -> m (MutArray a)
1076−snocWith allocSize arr x = do
958+snocWith allocSize arr x = liftIO $ do
1077 let newEnd = INDEX_NEXT(arrEnd arr,a)
959 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078 if newEnd <= arrBound arr
960 if newEnd <= arrBound arr
1079 then snocNewEnd newEnd arr x
961 then snocNewEnd newEnd arr x
@@ -1117,126 +999,6 @@ snoc = snocWith f
1117 then oldSize * 2
999 then oldSize * 2
1118 else roundUpToPower2 oldSize * 2
1000 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-------------------------------------------------------------------------------
1002-------------------------------------------------------------------------------
1241-- Random reads
1003-- Random reads
1242-------------------------------------------------------------------------------
1004-------------------------------------------------------------------------------
@@ -1251,7 +1013,7 @@ getIndexUnsafe :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1251getIndexUnsafe i MutArray{..} = do
1013getIndexUnsafe i MutArray{..} = do
1252 let index = INDEX_OF(arrStart,i,a)
1014 let index = INDEX_OF(arrStart,i,a)
1253 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
1015 assert (i >= 0 && INDEX_VALID(index,arrEnd,a)) (return ())
1254− liftIO $ peekAt index arrContents
1016+ liftIO $ peekByteIndex index arrContents
1256-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
1018-- | /O(1)/ Lookup the element at the given index. Index starts from 0.
@@ -1260,7 +1022,7 @@ getIndex :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (Maybe a)
1260getIndex i MutArray{..} = do
1022getIndex i MutArray{..} = do
1261 let index = INDEX_OF(arrStart,i,a)
1023 let index = INDEX_OF(arrStart,i,a)
1262 if i >= 0 && INDEX_VALID(index,arrEnd,a)
1024 if i >= 0 && INDEX_VALID(index,arrEnd,a)
1263− then liftIO $ Just <$> peekAt index arrContents
1025+ then liftIO $ Just <$> peekByteIndex index arrContents
1264 else return Nothing
1026 else return Nothing
1266-- | /O(1)/ Lookup the element at the given index from the end of the array.
1028-- | /O(1)/ Lookup the element at the given index from the end of the array.
@@ -1273,16 +1035,21 @@ getIndexRev :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m a
1273getIndexRev i MutArray{..} = do
1035getIndexRev i MutArray{..} = do
1274 let index = RINDEX_OF(arrEnd,i,a)
1036 let index = RINDEX_OF(arrEnd,i,a)
1275 if i >= 0 && index >= arrStart
1037 if i >= 0 && index >= arrStart
1276− then liftIO $ peekAt index arrContents
1038+ then liftIO $ peekByteIndex index arrContents
1277 else invalidIndex "getIndexRev" i
1039 else invalidIndex "getIndexRev" i
1279data GetIndicesState contents start end st =
1041data GetIndicesState contents start end st =
1280 GetIndicesState contents start end st
1042 GetIndicesState contents start end st
1282−{-# INLINE indexReaderWith #-}
1044+-- | Given an unfold that generates array indices, read the elements on those
1045+-- indices from the supplied MutArray. An error is thrown if an index is out of
1049+{-# INLINE getIndicesD #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1050+getIndicesD :: (Monad m, Unbox a) =>
1284 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1051 (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
1052+getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
@@ -1301,26 +1068,9 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1301 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1068 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1302 D.Stop -> return D.Stop
1069 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 #-}
1071{-# INLINE getIndices #-}
1322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1072getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1073+getIndices = getIndicesD liftIO
1325-------------------------------------------------------------------------------
1075-------------------------------------------------------------------------------
1326-- Subarrays
1076-- Subarrays
@@ -1425,7 +1175,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1426 -- Invariant low < high on entry, and on return as well
1176 -- Invariant low < high on entry, and on return as well
1427 moveHigh low high = do
1177 moveHigh low high = do
1428− h <- peekAt high arrContents
1178+ h <- peekByteIndex high arrContents
1431 -- Correctly classified, continue the loop
1181 -- Correctly classified, continue the loop
@@ -1445,7 +1195,7 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1445 -- low <= high
1195 -- low <= high
1446 -- Both low and high are valid locations within the array
1196 -- Both low and high are valid locations within the array
1447 go low high = do
1197 go low high = do
1448− l <- peekAt low arrContents
1198+ l <- peekByteIndex low arrContents
1451 -- low is wrongly classified
1201 -- low is wrongly classified
@@ -1456,8 +1206,8 @@ partitionBy f arr@MutArray{..} = liftIO $ do
1456 case r of
1206 case r of
1457 Nothing -> return low
1207 Nothing -> return low
1458 Just (high1, h) -> do -- low < high1
1208 Just (high1, h) -> do -- low < high1
1459− pokeAt low arrContents h
1209+ pokeByteIndex low arrContents h
1460− pokeAt high1 arrContents l
1210+ pokeByteIndex high1 arrContents l
1461 let low1 = INDEX_NEXT(low,a)
1211 let low1 = INDEX_NEXT(low,a)
1462 high2 = INDEX_PREV(high1,a)
1212 high2 = INDEX_PREV(high1,a)
1463 if low1 <= high2
1213 if low1 <= high2
@@ -1591,7 +1341,7 @@ chunksOfAs ps n (D.Stream step state) =
1591 r <- step (adaptState gst) st
1341 r <- step (adaptState gst) st
1592 case r of
1342 case r of
1593 D.Yield x s -> do
1343 D.Yield x s -> do
1594− liftIO $ pokeAt end contents x
1344+ liftIO $ pokeByteIndex end contents x
1595 let end1 = INDEX_NEXT(end,a)
1345 let end1 = INDEX_NEXT(end,a)
1596 return $
1346 return $
1597 if end1 >= bound
1347 if end1 >= bound
@@ -1610,12 +1360,10 @@ chunksOfAs ps n (D.Stream step state) =
1611 step' _ GroupFinish = return D.Stop
1361 step' _ GroupFinish = return D.Stop
1613−-- | @chunksOf n stream@ groups the elements in the input stream into arrays of
1363+-- | @chunksOf n stream@ groups the input stream into a stream of
1614−-- @n@ elements each.
1364+-- arrays of size n.
1616−-- Same as the following but may be more efficient:
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1366+-- @chunksOf n = StreamD.foldMany (MutArray.writeN n)@
1620-- /Pre-release/
1368-- /Pre-release/
1621{-# INLINE_NORMAL chunksOf #-}
1369{-# INLINE_NORMAL chunksOf #-}
@@ -1624,37 +1372,18 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
1624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1372-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1625-- benchmark. It seems it has difficulty producing optimized code when
1373-- benchmark. It seems it has difficulty producing optimized code when
1626-- converting to StreamK. Investigate GHC optimizations.
1374-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1375+-- chunksOf n = D.foldMany (writeN n)
1628chunksOf = chunksOfAs Unpinned
1376chunksOf = chunksOfAs Unpinned
1630−-- | Like 'chunksOf' but creates pinned arrays.
1378+-- XXX This should take a PinnedState
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?
1379-- XXX buffer to a list instead?
1651-- | Buffer the stream into arrays in memory.
1380-- | Buffer the stream into arrays in memory.
1652−{-# INLINE arrayStreamKFromStreamDAs #-}
1381+{-# INLINE arrayStreamKFromStreamD #-}
1653−arrayStreamKFromStreamDAs :: forall m a. (MonadIO m, Unbox a) =>
1382+arrayStreamKFromStreamD :: forall m a. (MonadIO m, Unbox a) =>
1654− PinnedState -> D.Stream m a -> m (StreamK m (MutArray a))
1383+ D.Stream m a -> m (StreamK m (MutArray a))
1655−arrayStreamKFromStreamDAs ps =
1384+arrayStreamKFromStreamD =
1656 let n = allocBytesToElemCount (undefined :: a) defaultChunkSize
1385 let n = allocBytesToElemCount (undefined :: a) defaultChunkSize
1657− in D.foldr K.cons K.nil . chunksOfAs ps n
1386+ in D.foldr K.cons K.nil . chunksOf n
1659-------------------------------------------------------------------------------
1388-------------------------------------------------------------------------------
1660-- Streams of arrays - Flattening
1389-- Streams of arrays - Flattening
@@ -1664,10 +1393,16 @@ data FlattenState s contents a =
1664 OuterLoop s
1393 OuterLoop s
1665 | InnerLoop s contents !Int !Int
1394 | InnerLoop s contents !Int !Int
1396+-- | Use the "reader" unfold instead.
1398+-- @flattenArrays = unfoldMany reader@
1400+-- We can try this if there are any fusion issues in the unfold.
1667−{-# INLINE_NORMAL concatWith #-}
1402+{-# INLINE_NORMAL flattenArrays #-}
1668−concatWith :: forall m a. (Monad m, Unbox a)
1403+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1404+ => D.Stream m (MutArray a) -> D.Stream m a
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1405+flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1684,30 +1419,19 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1684 return $ D.Skip $ OuterLoop st
1419 return $ D.Skip $ OuterLoop st
1686 step' _ (InnerLoop st contents p end) = do
1421 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1422+ x <- liftIO $ peekByteIndex p contents
1688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1423 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1690−-- | Use the "reader" unfold instead.
1425+-- | Use the "readerRev" unfold instead.
1692−-- @concat = unfoldMany reader@
1427+-- @flattenArrays = unfoldMany readerRev@
1694-- We can try this if there are any fusion issues in the unfold.
1429-- We can try this if there are any fusion issues in the unfold.
1696−{-# INLINE_NORMAL concat #-}
1431+{-# INLINE_NORMAL flattenArraysRev #-}
1697−concat :: 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)
1432+flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1704 => D.Stream m (MutArray a) -> D.Stream m a
1433 => D.Stream m (MutArray a) -> D.Stream m a
1705−flattenArrays = concat
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)
1434+flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1725,33 +1449,16 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1725 return $ D.Skip $ OuterLoop st
1449 return $ D.Skip $ OuterLoop st
1727 step' _ (InnerLoop st contents p start) = do
1451 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1452+ x <- liftIO $ peekByteIndex p contents
1729 let cur = INDEX_PREV(p,a)
1453 let cur = INDEX_PREV(p,a)
1730 return $ D.Yield x (InnerLoop st contents cur start)
1454 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-------------------------------------------------------------------------------
1456-------------------------------------------------------------------------------
1750-- Unfolds
1457-- Unfolds
1751-------------------------------------------------------------------------------
1458-------------------------------------------------------------------------------
1753data ArrayUnsafe a = ArrayUnsafe
1460data ArrayUnsafe a = ArrayUnsafe
1754− {-# UNPACK #-} !MutByteArray -- contents
1461+ {-# UNPACK #-} !MutableByteArray -- contents
1755 {-# UNPACK #-} !Int -- index 1
1462 {-# UNPACK #-} !Int -- index 1
1756 {-# UNPACK #-} !Int -- index 2
1463 {-# UNPACK #-} !Int -- index 2
@@ -1781,7 +1488,7 @@ producerWith liftio = Producer step (return . toArrayUnsafe) extract
1781 -- few actions for correctness and execution order sanity. We want
1488 -- few actions for correctness and execution order sanity. We want
1782 -- the peek to occur right here and not lazily at some later point
1489 -- 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.
1490 -- because we want the peek to be ordered with respect to the touch.
1784− !x <- liftio $ peekAt cur contents
1491+ !x <- liftio $ peekByteIndex cur contents
1785 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
1492 return $ D.Yield x (ArrayUnsafe contents (INDEX_NEXT(cur,a)) end)
1787 extract = return . fromArrayUnsafe
1494 extract = return . fromArrayUnsafe
@@ -1812,7 +1519,7 @@ readerRevWith liftio = Unfold step inject
1812 {-# INLINE_LATE step #-}
1519 {-# INLINE_LATE step #-}
1813 step (ArrayUnsafe _ start p) | p < start = return D.Stop
1520 step (ArrayUnsafe _ start p) | p < start = return D.Stop
1814 step (ArrayUnsafe contents start p) = do
1521 step (ArrayUnsafe contents start p) = do
1815− !x <- liftio $ peekAt p contents
1522+ !x <- liftio $ peekByteIndex p contents
1816 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
1523 return $ D.Yield x (ArrayUnsafe contents start (INDEX_PREV(p,a)))
1818-- | Unfold an array into a stream in reverse order.
1525-- | Unfold an array into a stream in reverse order.
@@ -1843,7 +1550,7 @@ toListFB c n MutArray{..} = go arrStart
1843 -- evaluated/written to before we peek at them.
1550 -- evaluated/written to before we peek at them.
1845 let !x = unsafeInlineIO $ do
1552 let !x = unsafeInlineIO $ do
1846− r <- peekAt arrContents p
1553+ r <- peekByteIndex arrContents p
1847 return r
1554 return r
1848 in c x (go (PTR_NEXT(p,a)))
1555 in c x (go (PTR_NEXT(p,a)))
@@ -1860,21 +1567,21 @@ toList MutArray{..} = liftIO $ go arrStart
1861 go p | assert (p <= arrEnd) (p == arrEnd) = return []
1568 go p | assert (p <= arrEnd) (p == arrEnd) = return []
1862 go p = do
1569 go p = do
1863− x <- peekAt p arrContents
1570+ x <- peekByteIndex p arrContents
1864 (:) x <$> go (INDEX_NEXT(p,a))
1571 (:) x <$> go (INDEX_NEXT(p,a))
1866−{-# INLINE_NORMAL toStreamWith #-}
1573+{-# INLINE_NORMAL toStreamDWith #-}
1867−toStreamWith ::
1574+toStreamDWith ::
1868 forall m a. (Monad m, Unbox a)
1575 forall m a. (Monad m, Unbox a)
1869 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1576 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1870−toStreamWith liftio MutArray{..} = D.Stream step arrStart
1577+toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1874 {-# INLINE_LATE step #-}
1581 {-# INLINE_LATE step #-}
1875 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
1582 step _ p | assert (p <= arrEnd) (p == arrEnd) = return D.Stop
1876 step _ p = liftio $ do
1583 step _ p = liftio $ do
1877− r <- peekAt p arrContents
1584+ r <- peekByteIndex p arrContents
1878 return $ D.Yield r (INDEX_NEXT(p,a))
1585 return $ D.Yield r (INDEX_NEXT(p,a))
1880-- | Convert a 'MutArray' into a stream.
1587-- | Convert a 'MutArray' into a stream.
@@ -1883,7 +1590,7 @@ toStreamWith liftio MutArray{..} = D.Stream step arrStart
1884{-# INLINE_NORMAL read #-}
1591{-# INLINE_NORMAL read #-}
1885read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1592read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1886−read = toStreamWith liftIO
1593+read = toStreamDWith liftIO
1888{-# INLINE toStreamKWith #-}
1595{-# INLINE toStreamKWith #-}
1889toStreamKWith ::
1596toStreamKWith ::
@@ -1895,18 +1602,18 @@ toStreamKWith liftio MutArray{..} = go arrStart
1896 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
1603 go p | assert (p <= arrEnd) (p == arrEnd) = K.nil
1897 | otherwise =
1604 | otherwise =
1898− let elemM = peekAt p arrContents
1605+ let elemM = peekByteIndex p arrContents
1899 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
1606 in liftio elemM `K.consM` go (INDEX_NEXT(p,a))
1901{-# INLINE toStreamK #-}
1608{-# INLINE toStreamK #-}
1902toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1609toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1903toStreamK = toStreamKWith liftIO
1610toStreamK = toStreamKWith liftIO
1905−{-# INLINE_NORMAL toStreamRevWith #-}
1612+{-# INLINE_NORMAL toStreamDRevWith #-}
1906−toStreamRevWith ::
1613+toStreamDRevWith ::
1907 forall m a. (Monad m, Unbox a)
1614 forall m a. (Monad m, Unbox a)
1908 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1615 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1909−toStreamRevWith liftio MutArray{..} =
1616+toStreamDRevWith liftio MutArray{..} =
1910 let p = INDEX_PREV(arrEnd,a)
1617 let p = INDEX_PREV(arrEnd,a)
1911 in D.Stream step p
1618 in D.Stream step p
@@ -1915,7 +1622,7 @@ toStreamRevWith liftio MutArray{..} =
1915 {-# INLINE_LATE step #-}
1622 {-# INLINE_LATE step #-}
1916 step _ p | p < arrStart = return D.Stop
1623 step _ p | p < arrStart = return D.Stop
1917 step _ p = liftio $ do
1624 step _ p = liftio $ do
1918− r <- peekAt p arrContents
1625+ r <- peekByteIndex p arrContents
1919 return $ D.Yield r (INDEX_PREV(p,a))
1626 return $ D.Yield r (INDEX_PREV(p,a))
1921-- | Convert a 'MutArray' into a stream in reverse order.
1628-- | Convert a 'MutArray' into a stream in reverse order.
@@ -1924,7 +1631,7 @@ toStreamRevWith liftio MutArray{..} =
1925{-# INLINE_NORMAL readRev #-}
1632{-# INLINE_NORMAL readRev #-}
1926readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1633readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1927−readRev = toStreamRevWith liftIO
1634+readRev = toStreamDRevWith liftIO
1929{-# INLINE toStreamKRevWith #-}
1636{-# INLINE toStreamKRevWith #-}
1930toStreamKRevWith ::
1637toStreamKRevWith ::
@@ -1938,7 +1645,7 @@ toStreamKRevWith liftio MutArray {..} =
1939 go p | p < arrStart = K.nil
1646 go p | p < arrStart = K.nil
1940 | otherwise =
1647 | otherwise =
1941− let elemM = peekAt p arrContents
1648+ let elemM = peekByteIndex p arrContents
1942 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
1649 in liftio elemM `K.consM` go (INDEX_PREV(p,a))
1944{-# INLINE toStreamKRev #-}
1651{-# INLINE toStreamKRev #-}
@@ -1973,7 +1680,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?
1681-- 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
1683+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
1977-- array.
1684-- array.
1979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
1686-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1689,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.
1689-- Any free space left in the array after appending @n@ elements is lost.
1984-- /Internal/
1691-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1692+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1693+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1988 -> m (MutArray a)
1695 -> m (MutArray a)
1989 -> Fold m a (MutArray a)
1696 -> Fold m a (MutArray a)
1697+writeAppendNUnsafe n action =
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1698+ fmap fromArrayUnsafe $ FL.foldlM' step initial
@@ -2000,59 +1708,38 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2000 -- otherwise we lose that space.
1708 -- otherwise we lose that space.
2002 if free < needed
1710 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1711+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2004 else return arr
1712 else return arr
2005 return $ toArrayUnsafe arr1
1713 return $ toArrayUnsafe arr1
2007 step (ArrayUnsafe contents start end) x = do
1715 step (ArrayUnsafe contents start end) x = do
2008− liftIO $ pokeAt end contents x
1716+ liftIO $ pokeByteIndex end contents x
2009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1717 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
1719-- | Append @n@ elements to an existing array. Any free space left in the array
2020-- after appending @n@ elements is lost.
1720-- after appending @n@ elements is lost.
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1722+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2024−{-# INLINE_NORMAL appendN #-}
1724+{-# 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) =>
1725writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
2033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1726 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1727+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1729+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2037-- append the input stream. If there is no reserved space available in the
1730-- 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@,
1731-- 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.
1732-- 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.
1734-- Note that the returned array may be a mutated version of original array.
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1736+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2045-- /Pre-release/
1738-- /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 #-}
1739{-# INLINE writeAppendWith #-}
2053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1740writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
2054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1741 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1742+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2057-- | @append action@ mutates the array generated by @action@ to append the
1744-- | @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
1745-- input stream. If there is no reserved space available in the array it is
@@ -2060,101 +1747,64 @@ writeAppendWith = appendWith
2061-- Note that the returned array may be a mutated version of original array.
1748-- Note that the returned array may be a mutated version of original array.
2063−-- >>> append = MutArray.appendWith (* 2)
1750+-- >>> 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 #-}
1752{-# INLINE writeAppend #-}
2073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
1753writeAppend :: forall m a. (MonadIO m, Unbox a) =>
2074 m (MutArray a) -> Fold m a (MutArray a)
1754 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1755+writeAppend = writeAppendWith (* 2)
2077-- XXX We can carry bound as well in the state to make sure we do not lose the
1757-- 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.
1758-- remaining capacity. Need to check perf impact.
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
1760+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
2081−-- function as argument.
1761+-- as argument.
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1763+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2085-- /Pre-release/
1765-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
1766+{-# INLINE_NORMAL writeNWithUnsafe #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1767+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1768 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1769+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2093 initial = toArrayUnsafe <$> alloc (max n 0)
1773 initial = toArrayUnsafe <$> alloc (max n 0)
2095 step (ArrayUnsafe contents start end) x = do
1775 step (ArrayUnsafe contents start end) x = do
2096− liftIO $ pokeAt end contents x
1776+ liftIO $ pokeByteIndex end contents x
2098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1778 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2100−{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101−{-# INLINE writeNWithUnsafe #-}
2102−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104−writeNWithUnsafe = unsafeCreateOfWith
2106{-# INLINE_NORMAL writeNUnsafeAs #-}
1780{-# INLINE_NORMAL writeNUnsafeAs #-}
2107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
1781writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
2108 => PinnedState -> Int -> Fold m a (MutArray a)
1782 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1783+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1785+-- | Like 'writeN' 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
1786-- 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
1787-- corrupt the memory and crash. This function exists mainly because any
2114-- conditional in the step function blocks fusion causing 10x performance
1788-- conditional in the step function blocks fusion causing 10x performance
2115-- slowdown.
1789-- slowdown.
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1791+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
2119−{-# INLINE_NORMAL unsafeCreateOf #-}
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 #-}
1793+{-# INLINE_NORMAL writeNUnsafe #-}
2126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
1794writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
2127 => Int -> Fold m a (MutArray a)
1795 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1796+writeNUnsafe = writeNUnsafeAs Unpinned
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." #-}
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
1798+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
2143-- allocated using the @alloc@ function.
1799-- allocated using the @alloc@ function.
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
1801+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1802+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2148−{-# INLINE_NORMAL createOfWith #-}
1804+{-# 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)
1805writeNWith :: forall m a. (MonadIO m, Unbox a)
2156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1806 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1807+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2159{-# INLINE_NORMAL writeNAs #-}
1809{-# INLINE_NORMAL writeNAs #-}
2160writeNAs ::
1810writeNAs ::
@@ -2162,42 +1812,20 @@ writeNAs ::
2162 => PinnedState
1812 => PinnedState
2164 -> Fold m a (MutArray a)
1814 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1815+writeNAs ps = writeNWith (newAs ps)
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1817+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
2168-- 'MutArray'.
1818-- 'MutArray'.
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
1820+-- >>> writeN = MutArray.writeNWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
1821+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1822+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2174−{-# INLINE_NORMAL createOf #-}
1824+{-# 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)
1825writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1826+writeN = writeNAs Unpinned
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.
1828+-- | Like writeNWithUnsafe but writes the array in reverse order.
2202-- /Internal/
1830-- /Internal/
2203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
1831{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2214,11 +1842,11 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2215 step (ArrayUnsafe contents start end) x = do
1843 step (ArrayUnsafe contents start end) x = do
2216 let ptr = INDEX_PREV(start,a)
1844 let ptr = INDEX_PREV(start,a)
2217− liftIO $ pokeAt ptr contents x
1845+ liftIO $ pokeByteIndex ptr contents x
2219 $ ArrayUnsafe contents ptr end
1847 $ ArrayUnsafe contents ptr end
2221−-- | Like createOfWith but writes the array in reverse order.
1849+-- | Like writeNWith but writes the array in reverse order.
2223-- /Internal/
1851-- /Internal/
2224{-# INLINE_NORMAL writeRevNWith #-}
1852{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1854,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
2226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1854 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
1855writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
2229−-- | Like 'createOf' but writes the array in reverse order.
1857+-- | Like writeN but writes the array in reverse order.
2231-- /Pre-release/
1859-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
1860+{-# 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)
1861writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1862+writeRevN = writeRevNWith new
2241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
1864-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
2242-- input stream to a 'MutArray' aligned to the given size.
1865-- input stream to a 'MutArray' aligned to the given size.
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
1867+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.newAlignedPinned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1868+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.newAlignedPinned align n)
2247-- /Pre-release/
1870-- /Pre-release/
2249{-# INLINE_NORMAL pinnedWriteNAligned #-}
1872{-# INLINE_NORMAL pinnedWriteNAligned #-}
2250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1873pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
2251 => Int -> Int -> Fold m a (MutArray a)
1874 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1875+pinnedWriteNAligned align = writeNWith (newAlignedPinned align)
2254-- XXX Buffer to a list instead?
1877-- XXX Buffer to a list instead?
2256-- | Buffer a stream into a stream of arrays.
1879-- | Buffer a stream into a stream of arrays.
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1881+-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2260-- Breaking an array into an array stream can be useful to consume a large
1883-- 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.
1884-- array sequentially such that memory of the array is released incrementatlly.
@@ -2264,43 +1887,14 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
2265-- /Unimplemented/
1888-- /Unimplemented/
2267−{-# INLINE_NORMAL buildChunks #-}
1890+{-# 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) =>
1891writeChunks :: (MonadIO m, Unbox a) =>
2275 Int -> Fold m a (StreamK n (MutArray a))
1892 Int -> Fold m a (StreamK n (MutArray a))
2276−writeChunks = buildChunks
1893+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
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
1895+-- XXX Compare writeWith with fromStreamD which uses an array of streams
2302−-- implementation. We can write this using buildChunks above if that is faster.
1896+-- implementation. We can write this using writeChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
1897+-- If writeWith is faster then we should use that to implement
2304-- fromStreamD.
1898-- fromStreamD.
2306-- XXX The realloc based implementation needs to make one extra copy if we use
1900-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,91 +1909,74 @@ writeWithAs ps elemCount =
2315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
1909-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2316-- malloc to compare against.
1910-- malloc to compare against.
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
1912+-- | @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
1913-- starts at a size big enough to hold minCount elements, the size is doubled
2320-- every time the array needs to be grown.
1914-- every time the array needs to be grown.
2322-- /Caution! Do not use this on infinite streams./
1916-- /Caution! Do not use this on infinite streams./
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
1918+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
1919+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
1920+-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
2328-- /Pre-release/
1922-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
1923+{-# 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)
1924writeWith :: forall m a. (MonadIO m, Unbox a)
2338 => Int -> Fold m a (MutArray a)
1925 => Int -> Fold m a (MutArray a)
1926+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2339−writeWith = createWith
1927+writeWith elemCount =
1928+ FL.rmapM extract $ FL.foldlM' step initial
1933+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1934+ liftIO $ new elemCount
1936+ step arr@(MutArray _ start end bound) x
1937+ | INDEX_NEXT(end,a) > bound = do
1938+ let oldSize = end - start
1939+ newSize = max (oldSize * 2) 1
1940+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
1942+ step arr x = snocUnsafe arr x
1944+ extract = liftIO . rightSize
2341-- | Fold the whole input to a single array.
1946-- | Fold the whole input to a single array.
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
1948+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2344-- rounded up to the element size.
1949-- rounded up to the element size.
2346-- /Caution! Do not use this on infinite streams./
1951-- /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 #-}
1953{-# INLINE write #-}
2355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1954write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
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)
1955+write = writeWith (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-------------------------------------------------------------------------------
1957-------------------------------------------------------------------------------
2370-- construct from streams, known size
1958-- construct from streams, known size
2371-------------------------------------------------------------------------------
1959-------------------------------------------------------------------------------
1961+-- | Use the 'writeN' fold instead.
1963+-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
2373−{-# INLINE_NORMAL fromStreamDNAs #-}
1965+{-# INLINE_NORMAL fromStreamDN #-}
2374−fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
1966+fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2375− => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
1967+ => Int -> D.Stream m a -> m (MutArray a)
1968+-- fromStreamDN n = D.fold (writeN n)
2376−fromStreamDNAs ps limit str = do
1969+fromStreamDN limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
1970+ (arr :: MutArray a) <- liftIO $ new limit
2378 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
1971 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
2379 return $ arr {arrEnd = end}
1972 return $ arr {arrEnd = end}
2383 fwrite arrContents ptr x = do
1976 fwrite arrContents ptr x = do
2384− liftIO $ pokeAt ptr arrContents x
1977+ liftIO $ pokeByteIndex ptr arrContents x
2385 return $ INDEX_NEXT(ptr,a)
1978 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
1980-- | 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
1981-- allocated to size N, if the list terminates before N elements then the
2405-- array may hold less than N elements.
1982-- array may hold less than N elements.
@@ -2408,80 +1985,21 @@ fromStreamDN = fromStreamN
2408fromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
1985fromListN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2409fromListN n xs = fromStreamDN n $ D.fromList xs
1986fromListN 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.
1988-- | Like fromListN but writes the array in reverse order.
2418-- /Pre-release/
1990-- /Pre-release/
2419{-# INLINE fromListRevN #-}
1991{-# INLINE fromListRevN #-}
2420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
1992fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
1993+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.
1995-- | Convert a pure stream in Identity monad to a mutable array.
2431{-# INLINABLE fromPureStream #-}
1996{-# INLINABLE fromPureStream #-}
2432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
1997fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2433fromPureStream xs =
1998fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
1999+ liftIO $ D.fold write $ 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-------------------------------------------------------------------------------
2001-------------------------------------------------------------------------------
2463−-- convert a stream of arrays to a single array by reallocating and copying
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
2002+-- convert stream to a single array
2485-------------------------------------------------------------------------------
2003-------------------------------------------------------------------------------
2487{-# INLINE arrayStreamKLength #-}
2005{-# INLINE arrayStreamKLength #-}
@@ -2491,72 +2009,29 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
2491-- | Convert an array stream to an array. Note that this requires peak memory
2009-- | Convert an array stream to an array. Note that this requires peak memory
2492-- that is double the size of the array stream.
2010-- 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 #-}
2012{-# INLINE fromArrayStreamK #-}
2519fromArrayStreamK :: (Unbox a, MonadIO m) =>
2013fromArrayStreamK :: (Unbox a, MonadIO m) =>
2520 StreamK m (MutArray a) -> m (MutArray a)
2014 StreamK m (MutArray a) -> m (MutArray a)
2521−fromArrayStreamK = fromChunksK
2015+fromArrayStreamK as = do
2522−
2016+ len <- arrayStreamKLength as
2523−{-# INLINE fromStreamDAs #-}
2017+ 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
2019-- 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
2020-- due to GC overhead because we need to buffer the arrays before we flatten
2545-- all the arrays.
2021-- all the arrays.
2547−-- XXX Compare if this is faster or "fold create".
2023+-- XXX Compare if this is faster or "fold write".
2549-- | We could take the approach of doubling the memory allocation on each
2025-- | 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
2026-- 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
2027-- 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.
2028-- result in an extra copy of the entire data.
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2030+-- >>> fromStreamD = StreamD.fold MutArray.write
2556{-# INLINE fromStreamD #-}
2032{-# INLINE fromStreamD #-}
2557−{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
2558fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2033fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2559−fromStreamD = fromStream
2034+fromStreamD m = arrayStreamKFromStreamD m >>= fromArrayStreamK
2561-- | Create a 'MutArray' from a list. The list must be of finite size.
2036-- | Create a 'MutArray' from a list. The list must be of finite size.
@@ -2564,11 +2039,6 @@ fromStreamD = fromStream
2564fromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2039fromList :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2565fromList xs = fromStreamD $ D.fromList xs
2040fromList 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
2042-- XXX We are materializing the whole list first for getting the length. Check
2573-- if the 'fromList' like chunked implementation would fare better.
2043-- if the 'fromList' like chunked implementation would fare better.
@@ -2577,75 +2047,44 @@ pinnedFromList xs = fromStreamDAs Pinned $ D.fromList xs
2577fromListRev :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2047fromListRev :: (MonadIO m, Unbox a) => [a] -> m (MutArray a)
2578fromListRev xs = fromListRevN (Prelude.length xs) xs
2048fromListRev 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-------------------------------------------------------------------------------
2050-------------------------------------------------------------------------------
2625-- Combining
2051-- Combining
2626-------------------------------------------------------------------------------
2052-------------------------------------------------------------------------------
2054+-- | Put a sub range of a source array into a subrange of a destination array.
2055+-- This is not safe as it does not check the bounds.
2056+{-# INLINE putSliceUnsafe #-}
2057+putSliceUnsafe :: MonadIO m => MutArray a -> Int -> MutArray a -> Int -> Int -> m ()
2058+putSliceUnsafe src srcStartBytes dst dstStartBytes lenBytes = liftIO $ do
2059+ assertM(lenBytes <= arrBound dst - dstStartBytes)
2060+ assertM(lenBytes <= arrEnd src - srcStartBytes)
2061+ let !(I# srcStartBytes#) = srcStartBytes
2062+ !(I# dstStartBytes#) = dstStartBytes
2063+ !(I# lenBytes#) = lenBytes
2064+ let arrS# = getMutableByteArray# (arrContents src)
2065+ arrD# = getMutableByteArray# (arrContents dst)
2066+ IO $ \s# -> (# copyMutableByteArray#
2067+ arrS# srcStartBytes# arrD# dstStartBytes# lenBytes# s#
2628−-- | Copy two arrays into a newly allocated array. If the first array is pinned
2070+-- | Copy two arrays into a newly allocated array.
2629−-- the spliced array is also pinned.
2630{-# INLINE spliceCopy #-}
2071{-# INLINE spliceCopy #-}
2631spliceCopy :: forall m a. MonadIO m =>
2072spliceCopy :: forall m a. MonadIO m =>
2632#ifdef DEVBUILD
2073#ifdef DEVBUILD
2633 Unbox a =>
2074 Unbox a =>
2635 MutArray a -> MutArray a -> m (MutArray a)
2076 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2077+spliceCopy arr1 arr2 = liftIO $ do
2637 let start1 = arrStart arr1
2078 let start1 = arrStart arr1
2638 start2 = arrStart arr2
2079 start2 = arrStart arr2
2639 len1 = arrEnd arr1 - start1
2080 len1 = arrEnd arr1 - start1
2640 len2 = arrEnd arr2 - start2
2081 len2 = arrEnd arr2 - start2
2082+ newArrContents <- liftIO $ Unboxed.newUnpinnedBytes (len1 + len2)
2641 let len = len1 + len2
2083 let len = len1 + len2
2642− newArrContents <-
2084+ newArr = MutArray newArrContents 0 len len
2643− if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2646− putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
2085+ putSliceUnsafe arr1 start1 newArr 0 len1
2647− putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
2086+ putSliceUnsafe arr2 start2 newArr len1 len2
2648− return $ MutArray newArrContents 0 len len
2087+ return newArr
2650-- | Really really unsafe, appends the second array into the first array. If
2089-- | 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
2090-- the first array does not have enough space it may cause silent data
@@ -2654,13 +2093,12 @@ spliceCopy arr1 arr2 = do
2654spliceUnsafe :: MonadIO m =>
2093spliceUnsafe :: MonadIO m =>
2655 MutArray a -> MutArray a -> m (MutArray a)
2094 MutArray a -> MutArray a -> m (MutArray a)
2656spliceUnsafe dst src =
2095spliceUnsafe dst src =
2657− do
2096+ liftIO $ do
2658 let startSrc = arrStart src
2097 let startSrc = arrStart src
2659 srcLen = arrEnd src - startSrc
2098 srcLen = arrEnd src - startSrc
2660 endDst = arrEnd dst
2099 endDst = arrEnd dst
2661 assertM(endDst + srcLen <= arrBound dst)
2100 assertM(endDst + srcLen <= arrBound dst)
2663− (arrContents src) startSrc (arrContents dst) endDst srcLen
2101+ putSliceUnsafe src startSrc dst endDst srcLen
2664 return $ dst {arrEnd = endDst + srcLen}
2102 return $ dst {arrEnd = endDst + srcLen}
2666-- | @spliceWith sizer dst src@ mutates @dst@ to append @src@. If there is no
2104-- | @spliceWith sizer dst src@ mutates @dst@ to append @src@. If there is no
@@ -2676,7 +2114,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
2676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2114 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2677spliceWith sizer dst@(MutArray _ start end bound) src = do
2115spliceWith sizer dst@(MutArray _ start end bound) src = do
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2117+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
2680 in D.fold f (toStreamD src)
2118 in D.fold f (toStreamD src)
2682 assert (end <= bound) (return ())
2120 assert (end <= bound) (return ())
@@ -2692,7 +2130,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
2692 $ "splice: newSize is less than the total size "
2130 $ "splice: newSize is less than the total size "
2693 ++ "of arrays being appended. Please check the "
2131 ++ "of arrays being appended. Please check the "
2694 ++ "sizer function passed."
2132 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2133+ liftIO $ realloc newSizeInBytes dst
2696 else return dst
2134 else return dst
2697 spliceUnsafe dst1 src
2135 spliceUnsafe dst1 src
@@ -2704,8 +2142,6 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
2705-- >>> splice = MutArray.spliceWith (+)
2143-- >>> splice = MutArray.spliceWith (+)
2707−-- If the original array is pinned the spliced array is also pinned.
2709-- /Pre-release/
2145-- /Pre-release/
2710{-# INLINE splice #-}
2146{-# INLINE splice #-}
2711splice :: (MonadIO m, Unbox a) => MutArray a -> MutArray a -> m (MutArray a)
2147splice :: (MonadIO m, Unbox a) => MutArray a -> MutArray a -> m (MutArray a)
@@ -2729,24 +2165,14 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
2729-- Splitting
2165-- Splitting
2730-------------------------------------------------------------------------------
2166-------------------------------------------------------------------------------
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
2168-- | Drops the separator byte
2744{-# INLINE breakOn #-}
2169{-# INLINE breakOn #-}
2745breakOn :: MonadIO m
2170breakOn :: MonadIO m
2746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2171 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2172+breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2173+ -- XXX Instead of using asPtrUnsafe (pinning memory) we can pass unlifted
2174+ -- 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.
2175 -- 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)
2176 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2751 let sepIndex = loc `minusPtr` p
2177 let sepIndex = loc `minusPtr` p
2752 return $
2178 return $
@@ -2767,41 +2193,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
2196-- | Create two slices of an array without copying the original array. The
2793-- specified index @i@ is the first index of the second slice.
2197-- 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)
2199splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2200+splitAt i arr@MutArray{..} =
2798 let maxIndex = length arr - 1
2201 let maxIndex = length arr - 1
2799 in if i < 0
2202 in if i < 0
2800 then error "sliceAt: negative array index"
2203 then error "sliceAt: negative array index"
2801 else if i > maxIndex
2204 else if i > maxIndex
2802 then error $ "sliceAt: specified array index " ++ show i
2205 then error $ "sliceAt: specified array index " ++ show i
2803 ++ " is beyond the maximum index " ++ show maxIndex
2206 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2207+ else let off = i * SIZE_OF(a)
2210+ { arrContents = arrContents
2211+ , arrStart = arrStart
2216+ { arrContents = arrContents
2219+ , arrBound = arrBound
2806-------------------------------------------------------------------------------
2223-------------------------------------------------------------------------------
2807-- Casting
2224-- Casting
@@ -2851,16 +2268,13 @@ cast arr =
2851-- guarantees that unsafe calls will be performed in the calling thread. Making
2268-- guarantees that unsafe calls will be performed in the calling thread. Making
2852-- it safe to pass heap-allocated objects to unsafe functions.
2269-- it safe to pass heap-allocated objects to unsafe functions.
2271+-- Unsafe because of direct pointer operations. The user must ensure that they
2272+-- are writing within the legal bounds of the array. Should we just name it
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2273+-- asPtr, the unsafety is implicit for any pointer operations. And we are safe
2855−-- operations. And we are safe from Haskell perspective because we will be
2274+-- from Haskell perspective because we will be pinning the memory.
2856−-- 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
2276+-- | 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.
2277+-- 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
2279-- If the array is not pinned it is copied to pinned memory before passing it
2866-- to the monadic action.
2280-- to the monadic action.
@@ -2870,382 +2284,56 @@ cast arr =
2870-- opportunistically before this operation occurs, to avoid the cost of a copy
2284-- opportunistically before this operation occurs, to avoid the cost of a copy
2871-- if possible.
2285-- if possible.
2873−-- /Unsafe/ because of direct pointer operations. The user must ensure that
2287+-- /Unsafe/
2874−-- they are writing within the legal bounds of the array.
2876-- /Pre-release/
2289-- /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
2291asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2292+asPtrUnsafe arr f = do
2293+ contents <- liftIO $ Unboxed.pin $ arrContents arr
2294+ let !ptr = Ptr (byteArrayContents#
2295+ (unsafeCoerce# (getMutableByteArray# contents)))
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2892− Unboxed.unsafeAsPtr
2893− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2297+ r <- f (ptr `plusPtr` arrStart arr)
2298+ liftIO $ touch contents
2895-------------------------------------------------------------------------------
2301-------------------------------------------------------------------------------
2896-- Equality
2302-- Equality
2897-------------------------------------------------------------------------------
2303-------------------------------------------------------------------------------
2899−-- | Byte compare two arrays. Compare the length of the arrays. If the length
2305+-- | 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
2306+-- lexicographical ordering of two underlying byte arrays otherwise return the
2901−-- otherwise return the result of length comparison.
2307+-- 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/
2309-- /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 #-}
2310{-# INLINE cmp #-}
2932−{-# DEPRECATED cmp "Please use byteCmp instead." #-}
2933cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2311cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2934−cmp = byteCmp
2312+cmp arr1 arr2 =
2936−-- | Byte equality of two arrays.
2314+ $ do
2937−--
2315+ let marr1 = getMutableByteArray# (arrContents arr1)
2938−-- >>> byteEq arr1 arr2 = (==) EQ $ MArray.byteCmp arr1 arr2
2316+ marr2 = getMutableByteArray# (arrContents arr2)
2939−--
2317+ !(I# st1#) = arrStart arr1
2940−-- /Unsafe/: See 'byteCmp'.
2318+ !(I# st2#) = arrStart arr2
2941−{-# INLINE byteEq #-}
2319+ !(I# len#) = byteLength arr1
2942−byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
2320+ case compare (byteLength arr1) (byteLength arr2) of
2943−byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2321+ EQ -> do
2944−
2322+ r <- liftIO $ IO $ \s# ->
2945−-------------------------------------------------------------------------------
2323+ let res =
2947−-------------------------------------------------------------------------------
2325+ (compareByteArrays#
2948−
2326+ (unsafeCoerce# marr1)
2949−-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2327+ st1#
2950−-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2328+ (unsafeCoerce# marr2)
2951−-- can leave some memory unused. They can split the last array to fit it
2329+ st2#
2952−-- exactly in the space.
2330+ len#)
2953−
2331+ in (# s#, res #)
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2332+ return $ compare r 0
2955−pCompactLeAs ::
2333+ 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-------------------------------------------------------------------------------
2335-------------------------------------------------------------------------------
3248−-- In-place mutation algorithms
2336+-- NFData
3249-------------------------------------------------------------------------------
2337-------------------------------------------------------------------------------
3251-- | Strip elements which match with predicate from both ends.
2339-- | Strip elements which match with predicate from both ends.
@@ -3274,7 +2362,7 @@ strip eq arr@MutArray{..} = liftIO $ do
3274 getStart cur = do
2362 getStart cur = do
3275 if cur < arrEnd
2363 if cur < arrEnd
3277− r <- peekAt cur arrContents
2365+ r <- peekByteIndex cur arrContents
3279 then getStart (INDEX_NEXT(cur,a))
2367 then getStart (INDEX_NEXT(cur,a))
3280 else return cur
2368 else return cur
@@ -3284,7 +2372,7 @@ strip eq arr@MutArray{..} = liftIO $ do
3284 if cur > low
2372 if cur > low
3286 let prev = INDEX_PREV(cur,a)
2374 let prev = INDEX_PREV(cur,a)
3287− r <- peekAt prev arrContents
2375+ r <- peekByteIndex prev arrContents
3289 then getLast prev low
2377 then getLast prev low
3290 else return cur
2378 else return cur