@@ -31,57 +31,39 @@ module Streamly.Internal.Data.MutArray.Type
3131 -- ** Type
3232 -- $arrayNotes
3333 MutArray (..)
34−
35− -- ** Conversion
36− -- *** Pinned and Unpinned
34+ , MutByteArray
35+ , MutableByteArray
3736 , pin
3837 , unpin
3938 , isPinned
4039
41− -- ** Casting
42− , cast
43− , castUnsafe -- XXX unsafeCast
44− , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
47−
40+ -- -- * Constructing and Writing
4841 -- ** Construction
49− , empty
50−
51− -- *** New
52− -- | New arrays are always empty arrays with some reserve capacity to
53− -- extend the length without reallocating.
54− , emptyOf
55− , newArrayWith -- emptyAlignedWith
56− , pinnedEmptyOf
57− , pinnedNewAligned -- XXX not required
58− -- , new -- uninitialized array of specified length
59−
60− -- *** Cloning
61− , clone
62− , pinnedClone
42+ , nil
6343
64− -- *** Slicing
65− -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
67− , getSlice
68− , splitAt -- XXX should be able to express using getSlice
69− , breakOn
44+ -- *** Uninitialized Arrays
45+ , pinnedNew
46+ , pinnedNewBytes
47+ , pinnedNewAligned
48+ , new
49+ , newArrayWith
7050
71− -- *** Stream Folds
51+ -- *** From streams
7252 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
74− , unsafeCreateOf
75− , unsafePinnedCreateOf
76− , pinnedCreateOf
77− , createOfWith
78− , createOf
79− , revCreateOf
80−
81− , pinnedCreate
82− , createWith
83− , create
84− -- , revCreate
53+ , writeNWithUnsafe
54+ , writeNWith
55+ , writeNUnsafe
56+ , pinnedWriteNUnsafe
57+ , writeN
58+ , pinnedWriteN
59+ , pinnedWriteNAligned
60+
61+ , writeWith
62+ , write
63+ , pinnedWrite
64+
65+ , writeRevN
66+ -- , writeRev
8567
8668 -- *** From containers
8769 , fromListN
@@ -97,11 +79,11 @@ module Streamly.Internal.Data.MutArray.Type
9779 , fromByteStr#
9880 , fromPtrN
9981 , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
82+ , fromChunksRealloced
10183
10284 -- ** Random writes
10385 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
86+ , putIndexUnsafe
10587 , putIndices
10688 -- , putFromThenTo
10789 -- , putFrom -- start writing at the given position
@@ -109,69 +91,76 @@ module Streamly.Internal.Data.MutArray.Type
10991 -- , putFromTo
11092 -- , putFromRev
11193 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
94+ , modifyIndexUnsafe
11395 , modifyIndex
11496 , modifyIndices
11597 , modify
11698 , swapIndices
11799 , unsafeSwapIndices
118100
119− -- ** Reading
101+ -- ** Growing and Shrinking
102+ -- | Arrays grow only at the end, though it is possible to grow on both sides
103+ -- and therefore have a cons as well as snoc. But that will require two
104+ -- bounds in the array representation.
120105
121− -- *** Indexing
122− , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
124− -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
126− , indexReader
127− , indexReaderWith
106+ -- *** Appending elements
107+ , snocWith
108+ , snoc
109+ , snocLinear
110+ , snocMay
111+ , snocUnsafe
112+
113+ -- *** Appending streams
114+ , writeAppendNUnsafe
115+ , writeAppendN
116+ , writeAppendWith
117+ , writeAppend
118+
119+ -- ** Eliminating and Reading
120+
121+ -- *** To streams
122+ , reader
123+ , readerRevWith
124+ , readerRev
128125
129− -- *** To Streams
126+ -- *** To containers
127+ , toStreamDWith
128+ , toStreamDRevWith
129+ , toStreamKWith
130+ , toStreamKRevWith
130131 , read
131132 , readRev
132− , toStreamWith
133− , toStreamRevWith
134133 , toStreamK
135− , toStreamKWith
136134 , toStreamKRev
137− , toStreamKRevWith
138−
139− -- *** To Containers
140135 , toList
141136
142− -- *** Unfolds
143137 -- experimental
144138 , producerWith
145139 , producer
146140
147− , reader
148− , readerRevWith
149− , readerRev
150−
151− -- ** Size and Capacity
152− -- *** Size
153− , length
154− , byteLength
155−
156− -- *** Capacity
157− -- , capacity
158− , byteCapacity
159− , bytesFree
141+ -- *** Random reads
142+ , getIndex
143+ , getIndexUnsafe
144+ , getIndices
145+ , getIndicesD
146+ -- , getFromThenTo
147+ , getIndexRev
160148
161− -- *** Capacity Management
149+ -- ** Memory Management
162150 , blockSize
163151 , arrayChunkBytes
164152 , allocBytesToElemCount
165− , realloc -- this is "resize"
166− , grow
167− , growExp
153+ , realloc
154+ , resize
155+ , resizeExp
168156 , rightSize
169157
170− -- ** Folding
171− , foldl'
172− , foldr
173− , byteCmp
174− , byteEq
158+ -- ** Size
159+ , length
160+ , byteLength
161+ -- , capacity
162+ , byteCapacity
163+ , bytesFree
175164
176165 -- ** In-place Mutation Algorithms
177166 , strip
@@ -183,82 +172,58 @@ module Streamly.Internal.Data.MutArray.Type
183172 , mergeBy
184173 , bubble
185174
186− -- ** Growing and Shrinking
187− -- | Arrays grow only at the end, though it is possible to grow on both
188− -- sides and therefore have a cons as well as snoc. But that will require
189− -- both lower and upper bound in the array representation.
190−
191− -- *** Appending elements
192− , snocWith
193− , snoc
194− , snocLinear
195− , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
197−
198− -- *** Appending streams
199− , unsafeAppendN
200− , appendN
201− , appendWith
202− , append
203−
204− -- *** Appending arrays
205− , spliceCopy
206− , spliceWith
207− , splice
208− , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
210− -- , putSlice
211− -- , appendSlice
212− -- , appendSliceFrom
213−
214− -- ** Serialization using Unbox
215− , pokeAppend
216− , pokeAppendMay
217− , pokeSkipUnsafe -- unsafePokeSkip
175+ -- ** Casting
176+ , cast
177+ , castUnsafe
178+ , asBytes
179+ , asPtrUnsafe
180+ , asUnpinnedPtrUnsafe
218181
219− -- ** Deserialization using Unbox
220− , peekUncons
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
182+ -- ** Folding
183+ , foldl'
184+ , foldr
185+ , cmp
186+ , byteCmp
187+ , byteEq
223188
224− -- Arrays of arrays
189+ -- ** Arrays of arrays
225190 -- We can add dimensionality parameter to the array type to get
226191 -- multidimensional arrays. Multidimensional arrays would just be a
227192 -- convenience wrapper on top of single dimensional arrays.
228193
229− -- ** Streams of Arrays
230− -- *** Chunk
231− -- | Group a stream into arrays.
194+ -- | Operations dealing with multiple arrays, streams of arrays or
195+ -- multidimensional array representations.
196+
197+ -- *** Construct from streams
232198 , chunksOf
233199 , pinnedChunksOf
234200 , buildChunks
235201
236− -- *** Split
237− -- | Split an array into slices.
202+ -- *** Eliminate to streams
203+ , concatChunks
204+ , concatChunksRev
238205
206+ -- *** Construct from arrays
207+ -- get chunks without copying
208+ , getSliceUnsafe
209+ , getSlice
239210 -- , getSlicesFromLenN
240− , splitOn
241− -- , slicesOf
242−
243− -- *** Concat
244− -- | Append the arrays in a stream to form a stream of elements.
245− , concatWith
246− , concatRevWith
247− , concat
248− , concatRev
249−
250− -- *** Compact
251− -- | Append the arrays in a stream to form a stream of larger arrays.
252− , SpliceState (..)
253− , pCompactLE
254− , pPinnedCompactLE
255− , compactLeAs
256− , fCompactGE
257− , fPinnedCompactGE
258− , lCompactGE
259− , lPinnedCompactGE
260− , compactGE
261− , compactEQ
211+ , splitAt -- XXX should be able to express using getSlice
212+ , breakOn
213+
214+ -- ** Cloning arrays
215+ , clone
216+ , pinnedClone
217+
218+ -- ** Appending arrays
219+ , spliceCopy
220+ , spliceWith
221+ , splice
222+ , spliceExp
223+ , spliceUnsafe
224+ -- , putSlice
225+ -- , appendSlice
226+ -- , appendSliceFrom
262227
263228 -- ** Utilities
264229 , roundUpToPower2
@@ -267,37 +232,12 @@ module Streamly.Internal.Data.MutArray.Type
267232 , c_memchr
268233
269234 -- * Deprecated
270− , asPtrUnsafe
271235 , writeChunks
272236 , flattenArrays
273237 , flattenArraysRev
274238 , fromArrayStreamK
275239 , fromStreamDN
276240 , fromStreamD
277− , cmp
278− , getIndices
279− , getIndicesWith
280− , resize
281− , resizeExp
282− , nil
283− , new
284− , pinnedNew
285− , pinnedNewBytes
286− , writeAppendNUnsafe
287− , writeAppendN
288− , writeAppendWith
289− , writeAppend
290− , writeNWithUnsafe
291− , writeNWith
292− , writeNUnsafe
293− , pinnedWriteNUnsafe
294− , writeN
295− , pinnedWriteN
296− , pinnedWriteNAligned -- XXX not required
297− , writeWith
298− , write
299− , pinnedWrite
300− , writeRevN
301241 )
302242where
303243
@@ -308,7 +248,6 @@ where
308248
309249import Control.Monad (when, void)
310250import Control.Monad.IO.Class (MonadIO(..))
311−import Data.Bifunctor (first)
312251import Data.Bits (shiftR, (.|.), (.&.))
313252import Data.Functor.Identity (Identity(..))
314253import Data.Proxy (Proxy(..))
@@ -317,6 +256,7 @@ import Foreign.C.Types (CSize(..), CInt(..))
317256import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
318257import Streamly.Internal.Data.MutByteArray.Type
319258 ( MutByteArray(..)
259+ , MutableByteArray
320260 , PinnedState(..)
321261 , getMutableByteArray#
322262 , putSliceUnsafe
@@ -335,17 +275,13 @@ import GHC.Ptr (Ptr(..))
335275import Streamly.Internal.Data.Fold.Type (Fold(..))
336276import Streamly.Internal.Data.Producer.Type (Producer (..))
337277import Streamly.Internal.Data.Stream.Type (Stream)
338−import Streamly.Internal.Data.Parser.Type (Parser (..))
339278import Streamly.Internal.Data.StreamK.Type (StreamK)
340279import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341−import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
342280import Streamly.Internal.Data.Unfold.Type (Unfold(..))
343281import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
344282
345283import qualified Streamly.Internal.Data.Fold.Type as FL
346284import 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
349285import qualified Streamly.Internal.Data.Producer as Producer
350286import qualified Streamly.Internal.Data.Stream.Type as D
351287import qualified Streamly.Internal.Data.Stream.Lift as D
@@ -353,7 +289,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
353289import qualified Prelude
354290
355291import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
292+ (Foldable(..), read, unlines, splitAt, reverse, truncate)
357293
358294#include "DocTestDataMutArray.hs"
359295
@@ -479,8 +415,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479415-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480416-- allocatePinned in GHC source.
481417
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484418-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485419-- length and with a capacity to hold @count@ elements, using @allocator
486420-- size alignment@ as the memory allocator function.
@@ -504,25 +438,12 @@ newArrayWith alloc alignSize count = do
504438 , arrBound = size
505439 }
506440
507−-- For arrays "nil" sounds a bit odd. empty is better. The only problem with
508−-- empty is that it is also used by the Alternative type class. But assuming we
509−-- will mostly import the Array module qualified this should be fine.
510−
511−-- | Create an empty array.
512−empty ::
513−#ifdef DEVBUILD
514− Unbox a =>
515−#endif
516− MutArray a
517−empty = MutArray Unboxed.empty 0 0 0
518−
519−{-# DEPRECATED nil "Please use empty instead." #-}
520441nil ::
521442#ifdef DEVBUILD
522443 Unbox a =>
523444#endif
524445 MutArray a
525−nil = empty
446+nil = MutArray Unboxed.nil 0 0 0
526447
527448{-# INLINE newBytesAs #-}
528449newBytesAs :: MonadIO m =>
@@ -539,13 +460,12 @@ newBytesAs ps bytes = do
539460 , arrBound = bytes
540461 }
541462
542−-- | Allocates a pinned empty array that with a reserved capacity of bytes.
543−-- The memory of the array is uninitialized and the allocation is aligned as
544−-- per the 'Unboxed' instance of the type.
463+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
464+-- the array is uninitialized and the allocation is aligned as per the
465+-- 'Unboxed' instance of the type.
545466--
546467-- /Pre-release/
547468{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549469pinnedNewBytes :: MonadIO m =>
550470#ifdef DEVBUILD
551471 Unbox a =>
@@ -570,31 +490,21 @@ newAs ps =
570490 (error "new: alignment is not used in unpinned arrays.")
571491
572492-- XXX can unaligned allocation be more efficient when alignment is not needed?
573−
574−-- | Allocates a pinned array of zero length but growable to the specified
575−-- capacity without reallocation.
576−{-# INLINE pinnedEmptyOf #-}
577−pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
578−pinnedEmptyOf = newAs Pinned
579−
580−-- XXX Deprecate in major
581−-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
493+--
494+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
495+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
496+-- instance of the type.
497+--
582498{-# INLINE pinnedNew #-}
583499pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
500+pinnedNew = newAs Pinned
585501
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
502+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
503+-- of the array is uninitialized.
588504--
589−{-# INLINE emptyOf #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
592−
593−-- XXX Deprecate in major
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
595505{-# INLINE new #-}
596506new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
507+new = newAs Unpinned
598508
599509-------------------------------------------------------------------------------
600510-- Random writes
@@ -642,7 +552,7 @@ putIndices arr = FL.foldlM' step (return ())
642552
643553 where
644554
645− step () (i, x) = putIndex i arr x
555+ step () (i, x) = liftIO (putIndex i arr x)
646556
647557-- | Modify a given index of an array using a modifier function.
648558--
@@ -838,19 +748,22 @@ arrayChunkBytes = 1024
838748roundDownTo :: Int -> Int -> Int
839749roundDownTo elemSize size = size - (size `mod` elemSize)
840750
751+-- XXX See if resizing can be implemented by reading the old array as a stream
752+-- and then using writeN to the new array.
753+--
841754-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842755-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843756-- which complicates some inspection tests.
844757--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
758+{-# NOINLINE reallocExplicit #-}
759+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
760+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848761 assertM(arrEnd <= arrBound)
849762
850763 -- Allocate new array
851764 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852765 contents <-
853− if ps == Pinned
766+ if Unboxed.isPinned arrContents
854767 then Unboxed.pinnedNew newCapMaxInBytes
855768 else Unboxed.new newCapMaxInBytes
856769 let !(MutByteArray mbarrFrom#) = arrContents
@@ -875,10 +788,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875788 , arrBound = newCapInBytes
876789 }
877790
878−-- XXX Should these be called reallocBytes etc?
879−-- XXX We may also need reallocAs to allocate as pinned/unpinned explicitly. In
880−-- fact clone/pinnedClone can be implemented using reallocAs.
881−
882791-- | @realloc newCapacity array@ reallocates the array to the specified
883792-- capacity in bytes.
884793--
@@ -890,12 +799,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890799-- If the original array is pinned, the newly allocated array is also pinned.
891800{-# INLINABLE realloc #-}
892801realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
893−realloc bytes arr =
894− let ps =
895− if isPinned arr
896− then Pinned
897− else Unpinned
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
802+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899803
900804-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901805-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +822,14 @@ reallocWith label capSizer minIncrBytes arr = do
918822 where
919823
920824 badSize newSize =
921− Prelude.concat
825+ concat
922826 [ label
923827 , ": new array size (in bytes) is less than required size "
924828 , show newSize
925829 , ". Please check the sizing function passed."
926830 ]
927831
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
832+-- | @resize newCapacity array@ changes the total capacity of the array so that
929833-- it is enough to hold the specified number of elements. Nothing is done if
930834-- the specified capacity is less than the length of the array.
931835--
@@ -933,46 +837,34 @@ reallocWith label capSizer minIncrBytes arr = do
933837-- the block size (4K).
934838--
935839-- /Pre-release/
936−{-# INLINE grow #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
840+{-# INLINE resize #-}
841+resize :: forall m a. (MonadIO m, Unbox a) =>
938842 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
843+resize nElems arr@MutArray{..} = do
940844 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
942− if req < cap
845+ len = arrEnd - arrStart
846+ if req < len
943847 then return arr
944848 else realloc req arr
945849
946−{-# DEPRECATED resize "Please use grow instead." #-}
947−{-# INLINE resize #-}
948−resize :: forall m a. (MonadIO m, Unbox a) =>
949− Int -> MutArray a -> m (MutArray a)
950−resize = grow
951−
952−-- | Like 'grow' but if the requested byte capacity is more than
953−-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
850+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
851+-- then it is rounded up to the closest power of 2.
954852--
955853-- /Pre-release/
956−{-# INLINE growExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
854+{-# INLINE resizeExp #-}
855+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958856 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
857+resizeExp nElems arr@MutArray{..} = do
960858 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
961859 req1 =
962860 if req > largeObjectThreshold
963861 then roundUpToPower2 req
964862 else req
965− cap = arrBound - arrStart
966− if req1 < cap
863+ len = arrEnd - arrStart
864+ if req1 < len
967865 then return arr
968866 else realloc req1 arr
969867
970−{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971−{-# INLINE resizeExp #-}
972−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973− Int -> MutArray a -> m (MutArray a)
974−resizeExp = growExp
975−
976868-- | Resize the allocated memory to drop any reserved free space at the end of
977869-- the array and reallocate it to reduce wastage.
978870--
@@ -1037,7 +929,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037929{-# INLINE snocMay #-}
1038930snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039931 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
932+snocMay arr@MutArray{..} x = liftIO $ do
1041933 let newEnd = INDEX_NEXT(arrEnd,a)
1042934 if newEnd <= arrBound
1043935 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +943,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1051943 -> a
1052944 -> m (MutArray a)
1053945snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
946+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055947 snocUnsafe arr1 x
1056948
1057949-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +965,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073965 -> MutArray a
1074966 -> a
1075967 -> m (MutArray a)
1076−snocWith allocSize arr x = do
968+snocWith allocSize arr x = liftIO $ do
1077969 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078970 if newEnd <= arrBound arr
1079971 then snocNewEnd newEnd arr x
@@ -1117,126 +1009,6 @@ snoc = snocWith f
11171009 then oldSize * 2
11181010 else roundUpToPower2 oldSize * 2
11191011
1120−-------------------------------------------------------------------------------
1121−-- Serialization/Deserialization
1122−-------------------------------------------------------------------------------
1123−
1124−{-# INLINE pokeNewEnd #-}
1125−pokeNewEnd :: (MonadIO m, Unbox a) =>
1126− Int -> MutArray Word8 -> a -> m (MutArray Word8)
1127−pokeNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1128− assert (newEnd <= arrBound) (return ())
1129− liftIO $ pokeAt arrEnd arrContents x
1130− return $ arr {arrEnd = newEnd}
1131−
1132−-- | Really really unsafe, unboxes a Haskell type and appends the resulting
1133−-- bytes to the byte array, may cause silent data corruption or if you are
1134−-- lucky a segfault if the array does not have enough space to append the
1135−-- element.
1136−--
1137−-- /Internal/
1138−{-# INLINE pokeAppendUnsafe #-}
1139−pokeAppendUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1140− MutArray Word8 -> a -> m (MutArray Word8)
1141−pokeAppendUnsafe arr@MutArray{..} = pokeNewEnd (arrEnd + SIZE_OF(a)) arr
1142−
1143−-- | Skip the specified number of bytes in the array. The data in the skipped
1144−-- region remains uninitialzed.
1145−{-# INLINE pokeSkipUnsafe #-}
1146−pokeSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1147−pokeSkipUnsafe n arr@MutArray{..} = do
1148− let newEnd = arrEnd + n
1149− in assert (newEnd <= arrBound) (arr {arrEnd = newEnd})
1150−
1151−-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152−-- capacity becomes full.
1153−--
1154−-- /Internal/
1155−{-# INLINE pokeAppendMay #-}
1156−pokeAppendMay :: forall m a. (MonadIO m, Unbox a) =>
1157− MutArray Word8 -> a -> m (Maybe (MutArray Word8))
1158−pokeAppendMay arr@MutArray{..} x = liftIO $ do
1159− let newEnd = arrEnd + SIZE_OF(a)
1160− if newEnd <= arrBound
1161− then Just <$> pokeNewEnd newEnd arr x
1162− else return Nothing
1163−
1164−{-# NOINLINE pokeWithRealloc #-}
1165−pokeWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1166− (Int -> Int)
1167− -> MutArray Word8
1168− -> a
1169− -> m (MutArray Word8)
1170−pokeWithRealloc sizer arr x = do
1171− arr1 <- liftIO $ reallocWith "pokeWithRealloc" sizer (SIZE_OF(a)) arr
1172− pokeAppendUnsafe arr1 x
1173−
1174−{-# INLINE pokeAppendWith #-}
1175−pokeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1176− (Int -> Int)
1177− -> MutArray Word8
1178− -> a
1179− -> m (MutArray Word8)
1180−pokeAppendWith allocSize arr x = liftIO $ do
1181− let newEnd = arrEnd arr + SIZE_OF(a)
1182− if newEnd <= arrBound arr
1183− then pokeNewEnd newEnd arr x
1184− else pokeWithRealloc allocSize arr x
1185−
1186−-- | Unbox a Haskell type and append the resulting bytes to a mutable byte
1187−-- array. The array is grown exponentially when more space is needed.
1188−--
1189−-- Definition:
1190−--
1191−-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1192−--
1193−{-# INLINE pokeAppend #-}
1194−pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195− MutArray Word8 -> a -> m (MutArray Word8)
1196−pokeAppend = pokeAppendWith f
1197−
1198− where
1199−
1200− f oldSize =
1201− if isPower2 oldSize
1202− then oldSize * 2
1203− else roundUpToPower2 oldSize * 2
1204−
1205−-- | Really really unsafe, create a Haskell value from an unboxed byte array,
1206−-- does not check if the array is big enough, may return garbage or if you are
1207−-- lucky may cause a segfault.
1208−--
1209−-- /Internal/
1210−{-# INLINE peekUnconsUnsafe #-}
1211−peekUnconsUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1212− MutArray Word8 -> m (a, MutArray Word8)
1213−peekUnconsUnsafe MutArray{..} = do
1214− let start1 = arrStart + SIZE_OF(a)
1215− assert (start1 <= arrEnd) (return ())
1216− liftIO $ do
1217− r <- peekAt arrStart arrContents
1218− return (r, MutArray arrContents start1 arrEnd arrBound)
1219−
1220−-- | Discard the specified number of bytes in the array.
1221−{-# INLINE peekSkipUnsafe #-}
1222−peekSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1223−peekSkipUnsafe n MutArray{..} =
1224− let start1 = arrStart + n
1225− in assert (start1 <= arrEnd) (MutArray arrContents start1 arrEnd arrBound)
1226−
1227−-- | Create a Haskell value from its unboxed representation from the head of a
1228−-- byte array, return the value and the remaining array.
1229−{-# INLINE peekUncons #-}
1230−peekUncons :: forall m a. (MonadIO m, Unbox a) =>
1231− MutArray Word8 -> m (Maybe a, MutArray Word8)
1232−peekUncons arr@MutArray{..} = do
1233− let start1 = arrStart + SIZE_OF(a)
1234− if start1 > arrEnd
1235− then return (Nothing, arr)
1236− else liftIO $ do
1237− r <- peekAt arrStart arrContents
1238− return (Just r, MutArray arrContents start1 arrEnd arrBound)
1239−
12401012-------------------------------------------------------------------------------
12411013-- Random reads
12421014-------------------------------------------------------------------------------
@@ -1279,10 +1051,15 @@ getIndexRev i MutArray{..} = do
12791051data GetIndicesState contents start end st =
12801052 GetIndicesState contents start end st
12811053
1282−{-# INLINE indexReaderWith #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1054+-- | Given an unfold that generates array indices, read the elements on those
1055+-- indices from the supplied MutArray. An error is thrown if an index is out of
1056+-- bounds.
1057+--
1058+-- /Pre-release/
1059+{-# INLINE getIndicesD #-}
1060+getIndicesD :: (Monad m, Unbox a) =>
12841061 (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
1062+getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
12861063
12871064 where
12881065
@@ -1301,26 +1078,9 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
13011078 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
13021079 D.Stop -> return D.Stop
13031080
1304−{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305−{-# INLINE getIndicesWith #-}
1306−getIndicesWith :: (Monad m, Unbox a) =>
1307− (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1308−getIndicesWith = indexReaderWith
1309−
1310−-- | Given an unfold that generates array indices, read the elements on those
1311−-- indices from the supplied MutArray. An error is thrown if an index is out of
1312−-- bounds.
1313−--
1314−-- /Pre-release/
1315−{-# INLINE indexReader #-}
1316−indexReader :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1317−indexReader = indexReaderWith liftIO
1318−
1319−-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320−{-# DEPRECATED getIndices "Please use indexReader instead." #-}
13211081{-# INLINE getIndices #-}
13221082getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1083+getIndices = getIndicesD liftIO
13241084
13251085-------------------------------------------------------------------------------
13261086-- Subarrays
@@ -1615,7 +1375,7 @@ chunksOfAs ps n (D.Stream step state) =
16151375--
16161376-- Same as the following but may be more efficient:
16171377--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1378+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
16191379--
16201380-- /Pre-release/
16211381{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1384,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
16241384-- XXX the idiomatic implementation leads to large regression in the D.reverse'
16251385-- benchmark. It seems it has difficulty producing optimized code when
16261386-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1387+-- chunksOf n = D.foldMany (writeN n)
16281388chunksOf = chunksOfAs Unpinned
16291389
16301390-- | Like 'chunksOf' but creates pinned arrays.
16311391{-# INLINE_NORMAL pinnedChunksOf #-}
16321392pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
16331393 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1394+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
16351395pinnedChunksOf = chunksOfAs Pinned
16361396
16371397-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1424,16 @@ data FlattenState s contents a =
16641424 OuterLoop s
16651425 | InnerLoop s contents !Int !Int
16661426
1667−{-# INLINE_NORMAL concatWith #-}
1668−concatWith :: forall m a. (Monad m, Unbox a)
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1427+-- | Use the "reader" unfold instead.
1428+--
1429+-- @concatChunks = unfoldMany reader@
1430+--
1431+-- We can try this if there are any fusion issues in the unfold.
1432+--
1433+{-# INLINE_NORMAL concatChunks #-}
1434+concatChunks :: forall m a. (MonadIO m, Unbox a)
1435+ => D.Stream m (MutArray a) -> D.Stream m a
1436+concatChunks (D.Stream step state) = D.Stream step' (OuterLoop state)
16711437
16721438 where
16731439
@@ -1684,30 +1450,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841450 return $ D.Skip $ OuterLoop st
16851451
16861452 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1453+ x <- liftIO $ peekAt p contents
16881454 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891455
1690−-- | Use the "reader" unfold instead.
1456+{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1457+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1458+ => D.Stream m (MutArray a) -> D.Stream m a
1459+flattenArrays = concatChunks
1460+
1461+-- | Use the "readerRev" unfold instead.
16911462--
1692−-- @concat = unfoldMany reader@
1463+-- @concatChunks = unfoldMany readerRev@
16931464--
16941465-- We can try this if there are any fusion issues in the unfold.
16951466--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1467+{-# INLINE_NORMAL concatChunksRev #-}
1468+concatChunksRev :: forall m a. (MonadIO m, Unbox a)
16981469 => D.Stream m (MutArray a) -> D.Stream m a
1699−concat = concatWith liftIO
1700−
1701−{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704− => D.Stream m (MutArray a) -> D.Stream m a
1705−flattenArrays = concat
1706−
1707−{-# INLINE_NORMAL concatRevWith #-}
1708−concatRevWith :: forall m a. (Monad m, Unbox a)
1709− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1710−concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1470+concatChunksRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111471
17121472 where
17131473
@@ -1725,26 +1485,14 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251485 return $ D.Skip $ OuterLoop st
17261486
17271487 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1488+ x <- liftIO $ peekAt p contents
17291489 let cur = INDEX_PREV(p,a)
17301490 return $ D.Yield x (InnerLoop st contents cur start)
17311491
1732−-- | Use the "readerRev" unfold instead.
1733−--
1734−-- @concat = unfoldMany readerRev@
1735−--
1736−-- We can try this if there are any fusion issues in the unfold.
1737−--
1738−{-# INLINE_NORMAL concatRev #-}
1739−concatRev :: forall m a. (MonadIO m, Unbox a)
1740− => D.Stream m (MutArray a) -> D.Stream m a
1741−concatRev = concatRevWith liftIO
1742−
17431492{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
17451493flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17461494 => D.Stream m (MutArray a) -> D.Stream m a
1747−flattenArraysRev = concatRev
1495+flattenArraysRev = concatChunksRev
17481496
17491497-------------------------------------------------------------------------------
17501498-- Unfolds
@@ -1863,11 +1611,11 @@ toList MutArray{..} = liftIO $ go arrStart
18631611 x <- peekAt p arrContents
18641612 (:) x <$> go (INDEX_NEXT(p,a))
18651613
1866−{-# INLINE_NORMAL toStreamWith #-}
1867−toStreamWith ::
1614+{-# INLINE_NORMAL toStreamDWith #-}
1615+toStreamDWith ::
18681616 forall m a. (Monad m, Unbox a)
18691617 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1870−toStreamWith liftio MutArray{..} = D.Stream step arrStart
1618+toStreamDWith liftio MutArray{..} = D.Stream step arrStart
18711619
18721620 where
18731621
@@ -1883,7 +1631,7 @@ toStreamWith liftio MutArray{..} = D.Stream step arrStart
18831631--
18841632{-# INLINE_NORMAL read #-}
18851633read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1886−read = toStreamWith liftIO
1634+read = toStreamDWith liftIO
18871635
18881636{-# INLINE toStreamKWith #-}
18891637toStreamKWith ::
@@ -1902,11 +1650,11 @@ toStreamKWith liftio MutArray{..} = go arrStart
19021650toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
19031651toStreamK = toStreamKWith liftIO
19041652
1905−{-# INLINE_NORMAL toStreamRevWith #-}
1906−toStreamRevWith ::
1653+{-# INLINE_NORMAL toStreamDRevWith #-}
1654+toStreamDRevWith ::
19071655 forall m a. (Monad m, Unbox a)
19081656 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1909−toStreamRevWith liftio MutArray{..} =
1657+toStreamDRevWith liftio MutArray{..} =
19101658 let p = INDEX_PREV(arrEnd,a)
19111659 in D.Stream step p
19121660
@@ -1924,7 +1672,7 @@ toStreamRevWith liftio MutArray{..} =
19241672--
19251673{-# INLINE_NORMAL readRev #-}
19261674readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1927−readRev = toStreamRevWith liftIO
1675+readRev = toStreamDRevWith liftIO
19281676
19291677{-# INLINE toStreamKRevWith #-}
19301678toStreamKRevWith ::
@@ -1973,7 +1721,7 @@ foldr f z arr = D.foldr f z $ read arr
19731721
19741722-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751723
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1724+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
19771725-- array.
19781726--
19791727-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1730,13 @@ foldr f z arr = D.foldr f z $ read arr
19821730-- Any free space left in the array after appending @n@ elements is lost.
19831731--
19841732-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1733+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1734+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871735 Int
19881736 -> m (MutArray a)
19891737 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1738+writeAppendNUnsafe n action =
1739+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911740
19921741 where
19931742
@@ -2000,7 +1749,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001749 -- otherwise we lose that space.
20011750 arr1 <-
20021751 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1752+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041753 else return arr
20051754 return $ toArrayUnsafe arr1
20061755
@@ -2008,51 +1757,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20081757 liftIO $ pokeAt end contents x
20091758 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101759
2011−{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012−{-# INLINE writeAppendNUnsafe #-}
2013−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2014− Int
2015− -> m (MutArray a)
2016− -> Fold m a (MutArray a)
2017−writeAppendNUnsafe = unsafeAppendN
2018−
20191760-- | Append @n@ elements to an existing array. Any free space left in the array
20201761-- after appending @n@ elements is lost.
20211762--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1763+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231764--
2024−{-# INLINE_NORMAL appendN #-}
2025−appendN :: forall m a. (MonadIO m, Unbox a) =>
2026− Int -> m (MutArray a) -> Fold m a (MutArray a)
2027−appendN n initial = FL.take n (unsafeAppendN n initial)
2028−
2029−-- XXX Deprecate in major
2030−-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031−{-# INLINE writeAppendN #-}
1765+{-# INLINE_NORMAL writeAppendN #-}
20321766writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331767 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1768+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351769
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1770+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371771-- append the input stream. If there is no reserved space available in the
20381772-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391773-- where @oldSize@ is the current size of the array in bytes.
20401774--
20411775-- Note that the returned array may be a mutated version of original array.
20421776--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1777+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441778--
20451779-- /Pre-release/
2046−{-# INLINE appendWith #-}
2047−appendWith :: forall m a. (MonadIO m, Unbox a) =>
2048− (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2049−appendWith sizer = FL.foldlM' (snocWith sizer)
2050−
2051−{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
20521780{-# INLINE writeAppendWith #-}
20531781writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541782 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1783+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561784
20571785-- | @append action@ mutates the array generated by @action@ to append the
20581786-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1788,26 @@ writeAppendWith = appendWith
20601788--
20611789-- Note that the returned array may be a mutated version of original array.
20621790--
2063−-- >>> append = MutArray.appendWith (* 2)
1791+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641792--
2065−{-# INLINE append #-}
2066−append :: forall m a. (MonadIO m, Unbox a) =>
2067− m (MutArray a) -> Fold m a (MutArray a)
2068−append = appendWith (* 2)
2069−
2070−-- XXX Deprecate in major
2071−-- {-# DEPRECATED writeAppend "Please use append instead." #-}
20721793{-# INLINE writeAppend #-}
20731794writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741795 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1796+writeAppend = writeAppendWith (* 2)
20761797
20771798-- XXX We can carry bound as well in the state to make sure we do not lose the
20781799-- remaining capacity. Need to check perf impact.
20791800--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1801+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1802+-- as argument.
20821803--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1804+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841805--
20851806-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1807+{-# INLINE_NORMAL writeNWithUnsafe #-}
1808+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881809 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1810+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901811
20911812 where
20921813
@@ -2097,64 +1818,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20971818 return
20981819 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991820
2100−{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101−{-# INLINE writeNWithUnsafe #-}
2102−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104−writeNWithUnsafe = unsafeCreateOfWith
2105−
21061821{-# INLINE_NORMAL writeNUnsafeAs #-}
21071822writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
21081823 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1824+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
21101825
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1826+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121827-- driver must not call the step function more than 'n' times otherwise it will
21131828-- corrupt the memory and crash. This function exists mainly because any
21141829-- conditional in the step function blocks fusion causing 10x performance
21151830-- slowdown.
21161831--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1832+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
21181833--
2119−{-# INLINE_NORMAL unsafeCreateOf #-}
2120−unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121− => Int -> Fold m a (MutArray a)
2122−unsafeCreateOf = writeNUnsafeAs Unpinned
2123−
2124−{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
2125−{-# INLINE writeNUnsafe #-}
1834+{-# INLINE_NORMAL writeNUnsafe #-}
21261835writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271836 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
2129−
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
1837+writeNUnsafe = writeNUnsafeAs Unpinned
21351838
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137−{-# INLINE pinnedWriteNUnsafe #-}
1839+-- | Like 'writeNUnsafe' but creates a pinned array.
1840+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
21381841pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
21391842 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1843+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
21411844
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1845+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431846-- allocated using the @alloc@ function.
21441847--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1848+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1849+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471850--
2148−{-# INLINE_NORMAL createOfWith #-}
2149−createOfWith :: forall m a. (MonadIO m, Unbox a)
2150− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151−createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2152−
2153−-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154−{-# INLINE writeNWith #-}
1851+{-# INLINE_NORMAL writeNWith #-}
21551852writeNWith :: forall m a. (MonadIO m, Unbox a)
21561853 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1854+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21581855
21591856{-# INLINE_NORMAL writeNAs #-}
21601857writeNAs ::
@@ -2162,42 +1859,28 @@ writeNAs ::
21621859 => PinnedState
21631860 -> Int
21641861 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1862+writeNAs ps = writeNWith (newAs ps)
21661863
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1864+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681865-- 'MutArray'.
21691866--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1867+-- >>> writeN = MutArray.writeNWith MutArray.new
1868+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1869+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
21731870--
2174−{-# INLINE_NORMAL createOf #-}
2175−createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176−createOf = writeNAs Unpinned
2177−
2178−-- XXX Deprecate in major
2179−-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180−{-# INLINE writeN #-}
1871+{-# INLINE_NORMAL writeN #-}
21811872writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1873+writeN = writeNAs Unpinned
21831874
2184−-- | Like 'createOf' but creates a pinned array.
2185−{-# INLINE_NORMAL pinnedCreateOf #-}
2186−pinnedCreateOf ::
2187− forall m a. (MonadIO m, Unbox a)
2188− => Int
2189− -> Fold m a (MutArray a)
2190−pinnedCreateOf = writeNAs Pinned
2191−
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
1875+-- | Like 'writeN' but creates a pinned array.
1876+{-# INLINE_NORMAL pinnedWriteN #-}
21941877pinnedWriteN ::
21951878 forall m a. (MonadIO m, Unbox a)
21961879 => Int
21971880 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1881+pinnedWriteN = writeNAs Pinned
21991882
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1883+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011884--
22021885-- /Internal/
22031886{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1901,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22181901 return
22191902 $ ArrayUnsafe contents ptr end
22201903
2221−-- | Like createOfWith but writes the array in reverse order.
1904+-- | Like writeNWith but writes the array in reverse order.
22221905--
22231906-- /Internal/
22241907{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1909,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261909 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271910writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281911
2229−-- | Like 'createOf' but writes the array in reverse order.
1912+-- | Like writeN but writes the array in reverse order.
22301913--
22311914-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
2233−revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234−revCreateOf = writeRevNWith new
2235−
2236−{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237−{-# INLINE writeRevN #-}
1915+{-# INLINE_NORMAL writeRevN #-}
22381916writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1917+writeRevN = writeRevNWith new
22401918
22411919-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
22421920-- input stream to a 'MutArray' aligned to the given size.
22431921--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1922+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1923+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
22461924--
22471925-- /Pre-release/
22481926--
22491927{-# INLINE_NORMAL pinnedWriteNAligned #-}
22501928pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
22511929 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1930+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
22531931
22541932-- XXX Buffer to a list instead?
22551933
22561934-- | Buffer a stream into a stream of arrays.
22571935--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1936+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591937--
22601938-- Breaking an array into an array stream can be useful to consume a large
22611939-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1945,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22671945{-# INLINE_NORMAL buildChunks #-}
22681946buildChunks :: (MonadIO m, Unbox a) =>
22691947 Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
1948+buildChunks n = FL.many (writeN n) FL.toStreamK
22711949
22721950{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
22741951writeChunks :: (MonadIO m, Unbox a) =>
22751952 Int -> Fold m a (StreamK n (MutArray a))
22761953writeChunks = buildChunks
@@ -2278,29 +1955,29 @@ writeChunks = buildChunks
22781955{-# INLINE_NORMAL writeWithAs #-}
22791956writeWithAs :: forall m a. (MonadIO m, Unbox a)
22801957 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
1958+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
22821959writeWithAs ps elemCount =
22831960 FL.rmapM extract $ FL.foldlM' step initial
22841961
22851962 where
22861963
22871964 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2289− newAs ps elemCount
1965+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1966+ liftIO $ newAs ps elemCount
22901967
22911968 step arr@(MutArray _ start end bound) x
22921969 | INDEX_NEXT(end,a) > bound = do
22931970 let oldSize = end - start
22941971 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
1972+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
22961973 snocUnsafe arr1 x
22971974 step arr x = snocUnsafe arr x
22981975
22991976 extract = liftIO . rightSize
23001977
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
1978+-- XXX Compare writeWith with fromStreamD which uses an array of streams
23021979-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
1980+-- If writeWith is faster then we should use that to implement
23041981-- fromStreamD.
23051982--
23061983-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +1992,39 @@ writeWithAs ps elemCount =
23151992-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23161993-- malloc to compare against.
23171994
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
1995+-- | @writeWith minCount@ folds the whole input to a single array. The array
23191996-- starts at a size big enough to hold minCount elements, the size is doubled
23201997-- every time the array needs to be grown.
23211998--
23221999-- /Caution! Do not use this on infinite streams./
23232000--
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2001+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2002+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2003+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
23272004--
23282005-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
2330−createWith :: forall m a. (MonadIO m, Unbox a)
2331− => Int -> Fold m a (MutArray a)
2332−-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333−createWith = writeWithAs Unpinned
2334−
2335−{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336−{-# INLINE writeWith #-}
2006+{-# INLINE_NORMAL writeWith #-}
23372007writeWith :: forall m a. (MonadIO m, Unbox a)
23382008 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2009+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2010+writeWith = writeWithAs Unpinned
23402011
23412012-- | Fold the whole input to a single array.
23422013--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2014+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23442015-- rounded up to the element size.
23452016--
23462017-- /Caution! Do not use this on infinite streams./
23472018--
2348−{-# INLINE create #-}
2349−create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350−create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2351−
2352−-- XXX Deprecate in major
2353−-- {-# DEPRECATED write "Please use create instead." #-}
23542019{-# INLINE write #-}
23552020write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2021+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23572022
2358−-- | Like 'create' but creates a pinned array.
2359−{-# INLINE pinnedCreate #-}
2360−pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2361−pinnedCreate =
2362− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2363−
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
2023+-- | Like 'write' but creates a pinned array.
23652024{-# INLINE pinnedWrite #-}
23662025pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2026+pinnedWrite =
2027+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23682028
23692029-------------------------------------------------------------------------------
23702030-- construct from streams, known size
@@ -2374,7 +2034,7 @@ pinnedWrite = pinnedCreate
23742034fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
23752035 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
23762036fromStreamDNAs ps limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
2037+ (arr :: MutArray a) <- liftIO $ newAs ps limit
23782038 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
23792039 return $ arr {arrEnd = end}
23802040
@@ -2384,18 +2044,17 @@ fromStreamDNAs ps limit str = do
23842044 liftIO $ pokeAt ptr arrContents x
23852045 return $ INDEX_NEXT(ptr,a)
23862046
2387−-- | Use the 'createOf' fold instead.
2047+-- | Use the 'writeN' fold instead.
23882048--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2049+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
23902050--
23912051{-# INLINE_NORMAL fromStreamN #-}
23922052fromStreamN :: forall m a. (MonadIO m, Unbox a)
23932053 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2054+-- fromStreamDN n = D.fold (writeN n)
23952055fromStreamN = fromStreamDNAs Unpinned
23962056
23972057{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
23992058fromStreamDN :: forall m a. (MonadIO m, Unbox a)
24002059 => Int -> D.Stream m a -> m (MutArray a)
24012060fromStreamDN = fromStreamN
@@ -2418,20 +2077,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
24182077-- /Pre-release/
24192078{-# INLINE fromListRevN #-}
24202079fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2080+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24222081
24232082-- | Convert a pure stream in Identity monad to a mutable array.
24242083{-# INLINABLE fromPureStreamN #-}
24252084fromPureStreamN :: (MonadIO m, Unbox a) =>
24262085 Int -> Stream Identity a -> m (MutArray a)
24272086fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2087+ liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
24292088
24302089-- | Convert a pure stream in Identity monad to a mutable array.
24312090{-# INLINABLE fromPureStream #-}
24322091fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
24332092fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2093+ liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
24352094
24362095{-# INLINABLE fromPtrN #-}
24372096fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2099,7 @@ fromPtrN len addr = do
24402099 -- XXX We can implement a stream copy in a similar way by streaming Word64
24412100 -- first and then remaining Word8.
24422101 arr <- new len
2443− _ <- unsafeAsPtr arr
2102+ _ <- asUnpinnedPtrUnsafe arr
24442103 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
24452104 return (arr {arrEnd = len})
24462105
@@ -2456,7 +2115,7 @@ fromByteStr# addr = do
24562115 len <- liftIO $ c_strlen (Ptr addr)
24572116 let lenInt = fromIntegral len
24582117 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2118+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
24602119 return (arr {arrEnd = lenInt})
24612120
24622121-------------------------------------------------------------------------------
@@ -2477,7 +2136,7 @@ fromChunksRealloced s = do
24772136 arr <- D.foldlM' spliceExp (pure a) strm
24782137 -- Reallocation is exponential so there may be 50% empty space in
24792138 -- worst case. One more reallocation to reclaim the space.
2480− rightSize arr
2139+ liftIO $ rightSize arr
24812140 Nothing -> pure nil
24822141
24832142-------------------------------------------------------------------------------
@@ -2515,7 +2174,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
25152174fromChunksK = fromChunkskAs Unpinned
25162175
25172176{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
25192177fromArrayStreamK :: (Unbox a, MonadIO m) =>
25202178 StreamK m (MutArray a) -> m (MutArray a)
25212179fromArrayStreamK = fromChunksK
@@ -2527,7 +2185,7 @@ fromStreamDAs ps m =
25272185 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
25282186
25292187-- | 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
2188+-- single array from a stream of unknown size. 'writeN' is at least twice
25312189-- as efficient when the size is already known.
25322190--
25332191-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2197,19 @@ fromStreamDAs ps m =
25392197fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
25402198fromStream = fromStreamDAs Unpinned
25412199
2542−-- fromStream (Stream m) = P.fold create m
2200+-- fromStream (Stream m) = P.fold write m
25432201-- CAUTION: a very large number (millions) of arrays can degrade performance
25442202-- due to GC overhead because we need to buffer the arrays before we flatten
25452203-- all the arrays.
25462204--
2547−-- XXX Compare if this is faster or "fold create".
2205+-- XXX Compare if this is faster or "fold write".
25482206--
25492207-- | We could take the approach of doubling the memory allocation on each
25502208-- overflow. This would result in more or less the same amount of copying as in
25512209-- the chunking approach. However, if we have to shrink in the end then it may
25522210-- result in an extra copy of the entire data.
25532211--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2212+-- >>> fromStreamD = StreamD.fold MutArray.write
25552213--
25562214{-# INLINE fromStreamD #-}
25572215{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2239,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
25812239-- Cloning
25822240-------------------------------------------------------------------------------
25832241
2584−-- Arrays are aligned on 64-bit boundaries. The fastest way to copy an array is
2585−-- to unsafeCast it to Word64, read it, write it to Word64 array and unsafeCast
2586−-- it again. We can use SIMD read/write as well.
2587−
25882242{-# INLINE cloneAs #-}
25892243cloneAs ::
25902244 ( MonadIO m
@@ -2594,7 +2248,7 @@ cloneAs ::
25942248 )
25952249 => PinnedState -> MutArray a -> m (MutArray a)
25962250cloneAs ps src =
2597− do
2251+ liftIO $ do
25982252 let startSrc = arrStart src
25992253 srcLen = arrEnd src - startSrc
26002254 newArrContents <-
@@ -2633,16 +2287,17 @@ spliceCopy :: forall m a. MonadIO m =>
26332287 Unbox a =>
26342288#endif
26352289 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2290+spliceCopy arr1 arr2 = liftIO $ do
26372291 let start1 = arrStart arr1
26382292 start2 = arrStart arr2
26392293 len1 = arrEnd arr1 - start1
26402294 len2 = arrEnd arr2 - start2
2641− let len = len1 + len2
2295+ let newLen = len1 + len2
26422296 newArrContents <-
26432297 if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2298+ then Unboxed.pinnedNew newLen
2299+ else Unboxed.new newLen
2300+ let len = len1 + len2
26462301 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
26472302 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
26482303 return $ MutArray newArrContents 0 len len
@@ -2654,7 +2309,7 @@ spliceCopy arr1 arr2 = do
26542309spliceUnsafe :: MonadIO m =>
26552310 MutArray a -> MutArray a -> m (MutArray a)
26562311spliceUnsafe dst src =
2657− do
2312+ liftIO $ do
26582313 let startSrc = arrStart src
26592314 srcLen = arrEnd src - startSrc
26602315 endDst = arrEnd dst
@@ -2676,7 +2331,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762331 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772332spliceWith sizer dst@(MutArray _ start end bound) src = do
26782333{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2334+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802335 in D.fold f (toStreamD src)
26812336-}
26822337 assert (end <= bound) (return ())
@@ -2692,7 +2347,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
26922347 $ "splice: newSize is less than the total size "
26932348 ++ "of arrays being appended. Please check the "
26942349 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2350+ liftIO $ realloc newSizeInBytes dst
26962351 else return dst
26972352 spliceUnsafe dst1 src
26982353
@@ -2729,22 +2384,11 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
27292384-- Splitting
27302385-------------------------------------------------------------------------------
27312386
2732−-- | Generate a stream of array slices using a predicate. The array element
2733−-- matching the predicate is dropped.
2734−--
2735−-- /Pre-release/
2736−{-# INLINE splitOn #-}
2737−splitOn :: (MonadIO m, Unbox a) =>
2738− (a -> Bool) -> MutArray a -> Stream m (MutArray a)
2739−splitOn predicate arr =
2740− fmap (\(i, len) -> getSliceUnsafe i len arr)
2741− $ D.indexOnSuffix predicate (read arr)
2742−
27432387-- | Drops the separator byte
27442388{-# INLINE breakOn #-}
27452389breakOn :: MonadIO m
27462390 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2391+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
27482392 -- XXX We do not need memchr here, we can use a Haskell equivalent.
27492393 -- Need efficient stream based primitives that work on Word64.
27502394 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2411,32 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672411 }
27682412 )
27692413
2770−-- | Like 'splitAt' but does not check whether the index is valid.
2771−--
2772−{-# INLINE unsafeSplitAt #-}
2773−unsafeSplitAt :: forall a. Unbox a =>
2774− Int -> MutArray a -> (MutArray a, MutArray a)
2775−unsafeSplitAt i MutArray{..} =
2776− let off = i * SIZE_OF(a)
2777− p = arrStart + off
2778− in ( MutArray
2779− { arrContents = arrContents
2780− , arrStart = arrStart
2781− , arrEnd = p
2782− , arrBound = p
2783− }
2784− , MutArray
2785− { arrContents = arrContents
2786− , arrStart = p
2787− , arrEnd = arrEnd
2788− , arrBound = arrBound
2789− }
2790− )
2791−
27922414-- | Create two slices of an array without copying the original array. The
27932415-- specified index @i@ is the first index of the second slice.
27942416--
2795−{-# INLINE splitAt #-}
27962417splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2418+splitAt i arr@MutArray{..} =
27982419 let maxIndex = length arr - 1
27992420 in if i < 0
28002421 then error "sliceAt: negative array index"
28012422 else if i > maxIndex
28022423 then error $ "sliceAt: specified array index " ++ show i
28032424 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2425+ else let off = i * SIZE_OF(a)
2426+ p = arrStart + off
2427+ in ( MutArray
2428+ { arrContents = arrContents
2429+ , arrStart = arrStart
2430+ , arrEnd = p
2431+ , arrBound = p
2432+ }
2433+ , MutArray
2434+ { arrContents = arrContents
2435+ , arrStart = p
2436+ , arrEnd = arrEnd
2437+ , arrBound = arrBound
2438+ }
2439+ )
28052440
28062441-------------------------------------------------------------------------------
28072442-- Casting
@@ -2851,13 +2486,9 @@ cast arr =
28512486-- guarantees that unsafe calls will be performed in the calling thread. Making
28522487-- it safe to pass heap-allocated objects to unsafe functions.
28532488
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2489+-- Should we just name it asPtr, the unsafety is implicit for any pointer
28552490-- operations. And we are safe from Haskell perspective because we will be
28562491-- pinning the memory.
2857−--
2858−-- XXX we cannot pass the length of the ptr here as in some cases it may not be
2859−-- available e.g. a null terminated C string. However, we can create another
2860−-- flavor of the API e.g. asPtrN.
28612492
28622493-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
28632494-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2506,16 @@ cast arr =
28752506--
28762507-- /Pre-release/
28772508--
2878−{-# INLINE unsafePinnedAsPtr #-}
2879−unsafePinnedAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2880−unsafePinnedAsPtr arr f =
2881− Unboxed.unsafePinnedAsPtr
2882− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2883−
2884−{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
28852509{-# INLINE asPtrUnsafe #-}
28862510asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2511+asPtrUnsafe arr f =
2512+ Unboxed.asPtrUnsafe
2513+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28882514
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2892− Unboxed.unsafeAsPtr
2515+{-# INLINE asUnpinnedPtrUnsafe #-}
2516+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2517+asUnpinnedPtrUnsafe arr f =
2518+ Unboxed.asUnpinnedPtrUnsafe
28932519 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28942520
28952521-------------------------------------------------------------------------------
@@ -2907,26 +2533,28 @@ unsafeAsPtr arr f =
29072533-- /Pre-release/
29082534{-# INLINE byteCmp #-}
29092535byteCmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2910−byteCmp arr1 arr2 = do
2911− let marr1 = getMutableByteArray# (arrContents arr1)
2912− marr2 = getMutableByteArray# (arrContents arr2)
2913− !(I# st1#) = arrStart arr1
2914− !(I# st2#) = arrStart arr2
2915− !(I# len#) = byteLength arr1
2916− case compare (byteLength arr1) (byteLength arr2) of
2917− EQ -> do
2918− r <- liftIO $ IO $ \s# ->
2919− let res =
2920− I#
2921− (compareByteArrays#
2922− (unsafeCoerce# marr1)
2923− st1#
2924− (unsafeCoerce# marr2)
2925− st2#
2926− len#)
2927− in (# s#, res #)
2928− return $ compare r 0
2929− x -> return x
2536+byteCmp arr1 arr2 =
2537+ liftIO
2538+ $ do
2539+ let marr1 = getMutableByteArray# (arrContents arr1)
2540+ marr2 = getMutableByteArray# (arrContents arr2)
2541+ !(I# st1#) = arrStart arr1
2542+ !(I# st2#) = arrStart arr2
2543+ !(I# len#) = byteLength arr1
2544+ case compare (byteLength arr1) (byteLength arr2) of
2545+ EQ -> do
2546+ r <- liftIO $ IO $ \s# ->
2547+ let res =
2548+ I#
2549+ (compareByteArrays#
2550+ (unsafeCoerce# marr1)
2551+ st1#
2552+ (unsafeCoerce# marr2)
2553+ st2#
2554+ len#)
2555+ in (# s#, res #)
2556+ return $ compare r 0
2557+ x -> return x
29302558
29312559{-# INLINE cmp #-}
29322560{-# DEPRECATED cmp "Please use byteCmp instead." #-}
@@ -2943,309 +2571,7 @@ byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
29432571byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
29442572
29452573-------------------------------------------------------------------------------
2946−-- Compact
2947−-------------------------------------------------------------------------------
2948−
2949−-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2950−-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2951−-- can leave some memory unused. They can split the last array to fit it
2952−-- exactly in the space.
2953−
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2955−pCompactLeAs ::
2956− forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2959−
2960− where
2961−
2962− maxBytes = maxElems * SIZE_OF(a)
2963−
2964− functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2965−
2966− initial =
2967− return
2968− $ if maxElems <= 0
2969− then error
2970− $ functionName
2971− ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2973− else Parser.IPartial Nothing
2974−
2975− step Nothing arr =
2976− return
2977− $ let len = byteLength arr
2978− in if len >= maxBytes
2979− then Parser.Done 0 arr
2980− else Parser.Partial 0 (Just arr)
2981− -- XXX Split the last array to use the space more compactly.
2982− step (Just buf) arr =
2983− let len = byteLength buf + byteLength arr
2984− in if len > maxBytes
2985− then return $ Parser.Done 1 buf
2986− else do
2987− buf1 <-
2988− if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2991− else return buf
2992− buf2 <- spliceUnsafe buf1 arr
2993− return $ Parser.Partial 0 (Just buf2)
2994−
2995− extract Nothing = return $ Parser.Done 0 nil
2996− extract (Just buf) = return $ Parser.Done 0 buf
2997−
2998−-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2999−-- only if the combined size would be less than or equal to @maxElems@
3000−-- elements. Note that it won't split an array if the original array is already
3001−-- larger than maxElems.
3002−--
3003−-- @maxElems@ must be greater than 0.
3004−--
3005−-- Generates unpinned arrays irrespective of the pinning status of input
3006−-- arrays.
3007−--
3008−-- /Internal/
3009−{-# INLINE pCompactLE #-}
3010−pCompactLE ::
3011− forall m a. (MonadIO m, Unbox a)
3012− => Int -> Parser (MutArray a) m (MutArray a)
3013−pCompactLE = pCompactLeAs Unpinned
3014−
3015−-- | Pinned version of 'pCompactLE'.
3016−{-# INLINE pPinnedCompactLE #-}
3017−pPinnedCompactLE ::
3018− forall m a. (MonadIO m, Unbox a)
3019− => Int -> Parser (MutArray a) m (MutArray a)
3020−pPinnedCompactLE = pCompactLeAs Pinned
3021−
3022−data SpliceState s arr
3023− = SpliceInitial s
3024− | SpliceBuffering s arr
3025− | SpliceYielding arr (SpliceState s arr)
3026− | SpliceFinish
3027−
3028−-- This mutates the first array (if it has space) to append values from the
3029−-- second one. This would work for immutable arrays as well because an
3030−-- immutable array never has additional space so a new array is allocated
3031−-- instead of mutating it.
3032−
3033−{-# INLINE_NORMAL compactLeAs #-}
3034−compactLeAs :: forall m a. (MonadIO m, Unbox a)
3035− => PinnedState -> Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
3036−compactLeAs ps maxElems (D.Stream step state) =
3037− D.Stream step' (SpliceInitial state)
3038−
3039− where
3040−
3041− maxBytes = maxElems * SIZE_OF(a)
3042−
3043− functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
3044−
3045− {-# INLINE_LATE step' #-}
3046− step' gst (SpliceInitial st) = do
3047− when (maxElems <= 0) $
3048− -- XXX we can pass the module string from the higher level API
3049− error $ functionName ++ ": the size of arrays [" ++ show maxElems
3050− ++ "] must be a natural number"
3051− r <- step gst st
3052− case r of
3053− D.Yield arr s -> return $
3054− let len = byteLength arr
3055− in if len >= maxBytes
3056− then D.Skip (SpliceYielding arr (SpliceInitial s))
3057− else D.Skip (SpliceBuffering s arr)
3058− D.Skip s -> return $ D.Skip (SpliceInitial s)
3059− D.Stop -> return D.Stop
3060−
3061− -- XXX Split the last array to use the space more compactly.
3062− step' gst (SpliceBuffering st buf) = do
3063− r <- step gst st
3064− case r of
3065− D.Yield arr s -> do
3066− let len = byteLength buf + byteLength arr
3067− if len > maxBytes
3068− then return $
3069− D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3070− else do
3071− buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
3074− else return buf
3075− buf2 <- spliceUnsafe buf1 arr
3076− return $ D.Skip (SpliceBuffering s buf2)
3077− D.Skip s -> return $ D.Skip (SpliceBuffering s buf)
3078− D.Stop -> return $ D.Skip (SpliceYielding buf SpliceFinish)
3079−
3080− step' _ SpliceFinish = return D.Stop
3081−
3082− step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3083−
3084−
3085−{-# INLINE_NORMAL fCompactGeAs #-}
3086−fCompactGeAs ::
3087− forall m a. (MonadIO m, Unbox a)
3088− => PinnedState -> Int -> FL.Fold m (MutArray a) (MutArray a)
3089−fCompactGeAs ps minElems = Fold step initial extract extract
3090−
3091− where
3092−
3093− minBytes = minElems * SIZE_OF(a)
3094−
3095− functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3096−
3097− initial =
3098− return
3099− $ if minElems < 0
3100− then error
3101− $ functionName
3102− ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
3104− else FL.Partial Nothing
3105−
3106− step Nothing arr =
3107− return
3108− $ let len = byteLength arr
3109− in if len >= minBytes
3110− then FL.Done arr
3111− else FL.Partial (Just arr)
3112− -- XXX Buffer arrays as a list to avoid copy and reallocations
3113− step (Just buf) arr = do
3114− let len = byteLength buf + byteLength arr
3115− buf1 <-
3116− if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
3119− else return buf
3120− buf2 <- spliceUnsafe buf1 arr
3121− if len >= minBytes
3122− then return $ FL.Done buf2
3123− else return $ FL.Partial (Just buf2)
3124−
3125− extract Nothing = return nil
3126− extract (Just buf) = return buf
3127−
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
3130−--
3131−-- Generates unpinned arrays irrespective of the pinning status of input
3132−-- arrays.
3133−{-# INLINE fCompactGE #-}
3134−fCompactGE ::
3135− forall m a. (MonadIO m, Unbox a)
3136− => Int -> FL.Fold m (MutArray a) (MutArray a)
3137−fCompactGE = fCompactGeAs Unpinned
3138−
3139−-- | Pinned version of 'fCompactGE'.
3140−{-# INLINE fPinnedCompactGE #-}
3141−fPinnedCompactGE ::
3142− forall m a. (MonadIO m, Unbox a)
3143− => Int -> FL.Fold m (MutArray a) (MutArray a)
3144−fPinnedCompactGE = fCompactGeAs Pinned
3145−
3146−{-# INLINE_NORMAL lCompactGeAs #-}
3147−lCompactGeAs :: forall m a. (MonadIO m, Unbox a)
3148− => PinnedState -> Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3149−-- The fold version turns out to be a little bit slower.
3150−-- lCompactGeAs ps n = FL.many (fCompactGeAs ps n)
3151−lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
3152− Fold step initial extract final
3153−
3154− where
3155−
3156− minBytes = minElems * SIZE_OF(a)
3157−
3158− functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
3159−
3160− initial = do
3161− when (minElems <= 0) $
3162− -- XXX we can pass the module string from the higher level API
3163− error $ functionName ++ ": the size of arrays ["
3164− ++ show minElems ++ "] must be a natural number"
3165−
3166− r <- initial1
3167− return $ first (Tuple' Nothing) r
3168−
3169− {-# INLINE runInner #-}
3170− runInner len acc buf =
3171− if len >= minBytes
3172− then do
3173− r <- step1 acc buf
3174− case r of
3175− FL.Done _ -> return $ FL.Done ()
3176− FL.Partial s -> do
3177− _ <- final1 s
3178− res <- initial1
3179− return $ first (Tuple' Nothing) res
3180− else return $ FL.Partial $ Tuple' (Just buf) acc
3181−
3182− step (Tuple' Nothing r1) arr =
3183− runInner (byteLength arr) r1 arr
3184−
3185− -- XXX Buffer arrays as a list to avoid copy and reallocations
3186− step (Tuple' (Just buf) r1) arr = do
3187− let len = byteLength buf + byteLength arr
3188− buf1 <- if byteCapacity buf < len
3189− then liftIO $ reallocExplicitAs
3190− ps (SIZE_OF(a)) (max minBytes len) buf
3191− else return buf
3192− buf2 <- spliceUnsafe buf1 arr
3193− runInner len r1 buf2
3194−
3195− -- XXX Several folds do extract >=> final, therefore, we need to make final
3196− -- return "m b" rather than using extract post it if we want extract to be
3197− -- partial.
3198− --
3199− -- extract forces the pending buffer to be sent to the fold which is not
3200− -- what we want.
3201− extract _ = error "lCompactGE: not designed for scanning"
3202−
3203− final (Tuple' Nothing r1) = final1 r1
3204− final (Tuple' (Just buf) r1) = do
3205− r <- step1 r1 buf
3206− case r of
3207− FL.Partial rr -> final1 rr
3208− FL.Done _ -> return ()
3209−
3210−-- | Like 'compactGE' but for transforming folds instead of stream.
3211−--
3212−-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3213−--
3214−-- Generates unpinned arrays irrespective of the pinning status of input
3215−-- arrays.
3216−{-# INLINE lCompactGE #-}
3217−lCompactGE :: forall m a. (MonadIO m, Unbox a)
3218− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3219−lCompactGE = lCompactGeAs Unpinned
3220−
3221−-- | Pinned version of 'lCompactGE'.
3222−{-# INLINE lPinnedCompactGE #-}
3223−lPinnedCompactGE :: forall m a. (MonadIO m, Unbox a)
3224− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3225−lPinnedCompactGE = lCompactGeAs Pinned
3226−
3227−-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228−-- the size becomes greater than or equal to @n@.
3229−--
3230−-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
3231−--
3232−{-# INLINE compactGE #-}
3233−compactGE ::
3234− (MonadIO m, Unbox a)
3235− => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236−compactGE n = D.foldMany (fCompactGE n)
3237−
3238−-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
3239−-- arrays of exact size @n@.
3240−--
3241−-- /Unimplemented/
3242−{-# INLINE compactEQ #-}
3243−compactEQ :: -- (MonadIO m, Unbox a) =>
3244− Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3245−compactEQ _n = undefined -- D.parseManyD (pCompactEQ n)
3246−
3247−-------------------------------------------------------------------------------
3248−-- In-place mutation algorithms
2574+-- NFData
32492575-------------------------------------------------------------------------------
32502576
32512577-- | Strip elements which match with predicate from both ends.