@@ -31,57 +31,48 @@ module Streamly.Internal.Data.MutArray.Type
3131 -- ** Type
3232 -- $arrayNotes
3333 MutArray (..)
34−
35− -- ** Conversion
36− -- *** Pinned and Unpinned
3734 , pin
3835 , unpin
3936 , isPinned
4037
41− -- ** Casting
42− , cast
43− , castUnsafe -- XXX unsafeCast
44− , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
47−
38+ -- -- * Constructing and Writing
4839 -- ** 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
40+ , nil
41+
42+ -- *** Uninitialized Arrays
43+ , pinnedNew
44+ , pinnedNewBytes
45+ , pinnedNewAligned
46+ , new
47+ , newArrayWith
48+
49+ -- ** Cloning arrays
6150 , clone
6251 , pinnedClone
6352
64− -- *** Slicing
53+ -- ** Slicing
6554 -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
55+ , getSliceUnsafe
6756 , getSlice
6857 , splitAt -- XXX should be able to express using getSlice
6958 , breakOn
7059
71− -- *** Stream Folds
60+ -- *** From streams
7261 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
74− , unsafeCreateOf
75− , unsafePinnedCreateOf
76− , pinnedCreateOf
77− , createOfWith
78− , createOf
79− , revCreateOf
80−
81− , pinnedCreate
82− , createWith
83− , create
84− -- , revCreate
62+ , writeNWithUnsafe
63+ , writeNWith
64+ , writeNUnsafe
65+ , pinnedWriteNUnsafe
66+ , writeN
67+ , pinnedWriteN
68+ , pinnedWriteNAligned
69+
70+ , writeWith
71+ , write
72+ , pinnedWrite
73+
74+ , writeRevN
75+ -- , writeRev
8576
8677 -- *** From containers
8778 , fromListN
@@ -97,11 +88,11 @@ module Streamly.Internal.Data.MutArray.Type
9788 , fromByteStr#
9889 , fromPtrN
9990 , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
91+ , fromChunksRealloced
10192
10293 -- ** Random writes
10394 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
95+ , putIndexUnsafe
10596 , putIndices
10697 -- , putFromThenTo
10798 -- , putFrom -- start writing at the given position
@@ -109,69 +100,86 @@ module Streamly.Internal.Data.MutArray.Type
109100 -- , putFromTo
110101 -- , putFromRev
111102 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
103+ , modifyIndexUnsafe
113104 , modifyIndex
114105 , modifyIndices
115106 , modify
116107 , swapIndices
117108 , unsafeSwapIndices
118109
119− -- ** Reading
110+ -- ** Growing and Shrinking
111+ -- | Arrays grow only at the end, though it is possible to grow on both sides
112+ -- and therefore have a cons as well as snoc. But that will require two
113+ -- bounds in the array representation.
120114
121− -- *** Indexing
122− , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
124− -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
126− , indexReader
127− , indexReaderWith
115+ -- *** Appending elements
116+ , snocWith
117+ , snoc
118+ , snocLinear
119+ , snocMay
120+ , snocUnsafe
128121
129− -- *** To Streams
130− , read
131− , readRev
122+ -- *** Appending streams
123+ , writeAppendNUnsafe
124+ , writeAppendN
125+ , writeAppendWith
126+ , writeAppend
127+
128+ -- *** Appending arrays
129+ , spliceCopy
130+ , spliceWith
131+ , splice
132+ , spliceExp
133+ , spliceUnsafe
134+ -- , putSlice
135+ -- , appendSlice
136+ -- , appendSliceFrom
137+
138+ -- ** Eliminating and Reading
139+
140+ -- *** To streams
141+ , reader
142+ , readerRevWith
143+ , readerRev
144+
145+ -- *** To containers
132146 , toStreamWith
133147 , toStreamRevWith
134− , toStreamK
135148 , toStreamKWith
136− , toStreamKRev
137149 , toStreamKRevWith
138−
139− -- *** To Containers
150+ , read
151+ , readRev
152+ , toStreamK
153+ , toStreamKRev
140154 , toList
141155
142− -- *** Unfolds
143156 -- experimental
144157 , producerWith
145158 , producer
146159
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
160+ -- *** Random reads
161+ , getIndex
162+ , getIndexUnsafe
163+ , getIndices
164+ , getIndicesWith
165+ -- , getFromThenTo
166+ , getIndexRev
160167
161− -- *** Capacity Management
168+ -- ** Memory Management
162169 , blockSize
163170 , arrayChunkBytes
164171 , allocBytesToElemCount
165− , realloc -- this is "resize"
166− , grow
167− , growExp
172+ , realloc
173+ , resize
174+ , resizeExp
168175 , rightSize
169176
170− -- ** Folding
171− , foldl'
172− , foldr
173− , byteCmp
174− , byteEq
177+ -- ** Size
178+ , length
179+ , byteLength
180+ -- , capacity
181+ , byteCapacity
182+ , bytesFree
175183
176184 -- ** In-place Mutation Algorithms
177185 , strip
@@ -183,43 +191,19 @@ module Streamly.Internal.Data.MutArray.Type
183191 , mergeBy
184192 , bubble
185193
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
194+ -- ** Casting
195+ , cast
196+ , castUnsafe
197+ , asBytes
198+ , asPtrUnsafe
199+ , asUnpinnedPtrUnsafe
218200
219− -- ** Deserialization using Unbox
220− , peekUncons
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
201+ -- ** Folding
202+ , foldl'
203+ , foldr
204+ , cmp
205+ , byteCmp
206+ , byteEq
223207
224208 -- Arrays of arrays
225209 -- We can add dimensionality parameter to the array type to get
@@ -227,38 +211,28 @@ module Streamly.Internal.Data.MutArray.Type
227211 -- convenience wrapper on top of single dimensional arrays.
228212
229213 -- ** Streams of Arrays
230− -- *** Chunk
231− -- | Group a stream into arrays.
214+ -- *** Group a stream into arrays
232215 , chunksOf
233216 , pinnedChunksOf
234217 , buildChunks
235218
236− -- *** Split
237− -- | Split an array into slices.
238−
219+ -- *** Split an array into slices
239220 -- , getSlicesFromLenN
240221 , splitOn
241222 -- , slicesOf
242223
243− -- *** Concat
244− -- | Append the arrays in a stream to form a stream of elements.
245− , concatWith
246− , concatRevWith
247− , concat
248− , concatRev
224+ -- *** Flatten a stream of arrays
225+ , concatChunks
226+ , concatChunksRev
249227
250− -- *** Compact
251− -- | Append the arrays in a stream to form a stream of larger arrays.
228+ -- *** Compaction
252229 , SpliceState (..)
253− , pCompactLE
254− , pPinnedCompactLE
255− , compactLeAs
256− , fCompactGE
257− , fPinnedCompactGE
258− , lCompactGE
259− , lPinnedCompactGE
260− , compactGE
261− , compactEQ
230+ , pCompactChunksLE
231+ , rCompactChunksLE
232+ , fCompactChunksGE
233+ , lCompactChunksGE
234+ , compactChunksGE
235+ , compactChunksEQ
262236
263237 -- ** Utilities
264238 , roundUpToPower2
@@ -267,37 +241,12 @@ module Streamly.Internal.Data.MutArray.Type
267241 , c_memchr
268242
269243 -- * Deprecated
270− , asPtrUnsafe
271244 , writeChunks
272245 , flattenArrays
273246 , flattenArraysRev
274247 , fromArrayStreamK
275248 , fromStreamDN
276249 , 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
301250 )
302251where
303252
@@ -353,7 +302,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
353302import qualified Prelude
354303
355304import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
305+ (Foldable(..), read, unlines, splitAt, reverse, truncate)
357306
358307#include "DocTestDataMutArray.hs"
359308
@@ -479,8 +428,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479428-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480429-- allocatePinned in GHC source.
481430
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484431-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485432-- length and with a capacity to hold @count@ elements, using @allocator
486433-- size alignment@ as the memory allocator function.
@@ -504,25 +451,12 @@ newArrayWith alloc alignSize count = do
504451 , arrBound = size
505452 }
506453
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." #-}
520454nil ::
521455#ifdef DEVBUILD
522456 Unbox a =>
523457#endif
524458 MutArray a
525−nil = empty
459+nil = MutArray Unboxed.nil 0 0 0
526460
527461{-# INLINE newBytesAs #-}
528462newBytesAs :: MonadIO m =>
@@ -539,13 +473,12 @@ newBytesAs ps bytes = do
539473 , arrBound = bytes
540474 }
541475
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.
476+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
477+-- the array is uninitialized and the allocation is aligned as per the
478+-- 'Unboxed' instance of the type.
545479--
546480-- /Pre-release/
547481{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549482pinnedNewBytes :: MonadIO m =>
550483#ifdef DEVBUILD
551484 Unbox a =>
@@ -570,31 +503,21 @@ newAs ps =
570503 (error "new: alignment is not used in unpinned arrays.")
571504
572505-- 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." #-}
506+--
507+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
508+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
509+-- instance of the type.
510+--
582511{-# INLINE pinnedNew #-}
583512pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
513+pinnedNew = newAs Pinned
585514
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
515+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
516+-- of the array is uninitialized.
588517--
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." #-}
595518{-# INLINE new #-}
596519new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
520+new = newAs Unpinned
598521
599522-------------------------------------------------------------------------------
600523-- Random writes
@@ -642,7 +565,7 @@ putIndices arr = FL.foldlM' step (return ())
642565
643566 where
644567
645− step () (i, x) = putIndex i arr x
568+ step () (i, x) = liftIO (putIndex i arr x)
646569
647570-- | Modify a given index of an array using a modifier function.
648571--
@@ -838,19 +761,22 @@ arrayChunkBytes = 1024
838761roundDownTo :: Int -> Int -> Int
839762roundDownTo elemSize size = size - (size `mod` elemSize)
840763
764+-- XXX See if resizing can be implemented by reading the old array as a stream
765+-- and then using writeN to the new array.
766+--
841767-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842768-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843769-- which complicates some inspection tests.
844770--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
771+{-# NOINLINE reallocExplicit #-}
772+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
773+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848774 assertM(arrEnd <= arrBound)
849775
850776 -- Allocate new array
851777 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852778 contents <-
853− if ps == Pinned
779+ if Unboxed.isPinned arrContents
854780 then Unboxed.pinnedNew newCapMaxInBytes
855781 else Unboxed.new newCapMaxInBytes
856782 let !(MutByteArray mbarrFrom#) = arrContents
@@ -875,10 +801,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875801 , arrBound = newCapInBytes
876802 }
877803
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−
882804-- | @realloc newCapacity array@ reallocates the array to the specified
883805-- capacity in bytes.
884806--
@@ -890,12 +812,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890812-- If the original array is pinned, the newly allocated array is also pinned.
891813{-# INLINABLE realloc #-}
892814realloc :: 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
815+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899816
900817-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901818-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +835,14 @@ reallocWith label capSizer minIncrBytes arr = do
918835 where
919836
920837 badSize newSize =
921− Prelude.concat
838+ concat
922839 [ label
923840 , ": new array size (in bytes) is less than required size "
924841 , show newSize
925842 , ". Please check the sizing function passed."
926843 ]
927844
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
845+-- | @resize newCapacity array@ changes the total capacity of the array so that
929846-- it is enough to hold the specified number of elements. Nothing is done if
930847-- the specified capacity is less than the length of the array.
931848--
@@ -933,46 +850,34 @@ reallocWith label capSizer minIncrBytes arr = do
933850-- the block size (4K).
934851--
935852-- /Pre-release/
936−{-# INLINE grow #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
853+{-# INLINE resize #-}
854+resize :: forall m a. (MonadIO m, Unbox a) =>
938855 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
856+resize nElems arr@MutArray{..} = do
940857 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
942− if req < cap
858+ len = arrEnd - arrStart
859+ if req < len
943860 then return arr
944861 else realloc req arr
945862
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.
863+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
864+-- then it is rounded up to the closest power of 2.
954865--
955866-- /Pre-release/
956−{-# INLINE growExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
867+{-# INLINE resizeExp #-}
868+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958869 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
870+resizeExp nElems arr@MutArray{..} = do
960871 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
961872 req1 =
962873 if req > largeObjectThreshold
963874 then roundUpToPower2 req
964875 else req
965− cap = arrBound - arrStart
966− if req1 < cap
876+ len = arrEnd - arrStart
877+ if req1 < len
967878 then return arr
968879 else realloc req1 arr
969880
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−
976881-- | Resize the allocated memory to drop any reserved free space at the end of
977882-- the array and reallocate it to reduce wastage.
978883--
@@ -1037,7 +942,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037942{-# INLINE snocMay #-}
1038943snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039944 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
945+snocMay arr@MutArray{..} x = liftIO $ do
1041946 let newEnd = INDEX_NEXT(arrEnd,a)
1042947 if newEnd <= arrBound
1043948 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +956,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1051956 -> a
1052957 -> m (MutArray a)
1053958snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
959+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055960 snocUnsafe arr1 x
1056961
1057962-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +978,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073978 -> MutArray a
1074979 -> a
1075980 -> m (MutArray a)
1076−snocWith allocSize arr x = do
981+snocWith allocSize arr x = liftIO $ do
1077982 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078983 if newEnd <= arrBound arr
1079984 then snocNewEnd newEnd arr x
@@ -1117,126 +1022,6 @@ snoc = snocWith f
11171022 then oldSize * 2
11181023 else roundUpToPower2 oldSize * 2
11191024
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−
12401025-------------------------------------------------------------------------------
12411026-- Random reads
12421027-------------------------------------------------------------------------------
@@ -1279,10 +1064,10 @@ getIndexRev i MutArray{..} = do
12791064data GetIndicesState contents start end st =
12801065 GetIndicesState contents start end st
12811066
1282−{-# INLINE indexReaderWith #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1067+{-# INLINE getIndicesWith #-}
1068+getIndicesWith :: (Monad m, Unbox a) =>
12841069 (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
1070+getIndicesWith liftio (D.Stream stepi sti) = Unfold step inject
12861071
12871072 where
12881073
@@ -1301,26 +1086,14 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
13011086 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
13021087 D.Stop -> return D.Stop
13031088
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−
13101089-- | Given an unfold that generates array indices, read the elements on those
13111090-- indices from the supplied MutArray. An error is thrown if an index is out of
13121091-- bounds.
13131092--
13141093-- /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." #-}
13211094{-# INLINE getIndices #-}
13221095getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1096+getIndices = getIndicesWith liftIO
13241097
13251098-------------------------------------------------------------------------------
13261099-- Subarrays
@@ -1615,7 +1388,7 @@ chunksOfAs ps n (D.Stream step state) =
16151388--
16161389-- Same as the following but may be more efficient:
16171390--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1391+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
16191392--
16201393-- /Pre-release/
16211394{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1397,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
16241397-- XXX the idiomatic implementation leads to large regression in the D.reverse'
16251398-- benchmark. It seems it has difficulty producing optimized code when
16261399-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1400+-- chunksOf n = D.foldMany (writeN n)
16281401chunksOf = chunksOfAs Unpinned
16291402
16301403-- | Like 'chunksOf' but creates pinned arrays.
16311404{-# INLINE_NORMAL pinnedChunksOf #-}
16321405pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
16331406 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1407+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
16351408pinnedChunksOf = chunksOfAs Pinned
16361409
16371410-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1437,16 @@ data FlattenState s contents a =
16641437 OuterLoop s
16651438 | InnerLoop s contents !Int !Int
16661439
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)
1440+-- | Use the "reader" unfold instead.
1441+--
1442+-- @concatChunks = unfoldMany reader@
1443+--
1444+-- We can try this if there are any fusion issues in the unfold.
1445+--
1446+{-# INLINE_NORMAL concatChunks #-}
1447+concatChunks :: forall m a. (MonadIO m, Unbox a)
1448+ => D.Stream m (MutArray a) -> D.Stream m a
1449+concatChunks (D.Stream step state) = D.Stream step' (OuterLoop state)
16711450
16721451 where
16731452
@@ -1684,30 +1463,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841463 return $ D.Skip $ OuterLoop st
16851464
16861465 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1466+ x <- liftIO $ peekAt p contents
16881467 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891468
1690−-- | Use the "reader" unfold instead.
1469+{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1470+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1471+ => D.Stream m (MutArray a) -> D.Stream m a
1472+flattenArrays = concatChunks
1473+
1474+-- | Use the "readerRev" unfold instead.
16911475--
1692−-- @concat = unfoldMany reader@
1476+-- @concatChunks = unfoldMany readerRev@
16931477--
16941478-- We can try this if there are any fusion issues in the unfold.
16951479--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1480+{-# INLINE_NORMAL concatChunksRev #-}
1481+concatChunksRev :: forall m a. (MonadIO m, Unbox a)
16981482 => 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)
1483+concatChunksRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111484
17121485 where
17131486
@@ -1725,26 +1498,14 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251498 return $ D.Skip $ OuterLoop st
17261499
17271500 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1501+ x <- liftIO $ peekAt p contents
17291502 let cur = INDEX_PREV(p,a)
17301503 return $ D.Yield x (InnerLoop st contents cur start)
17311504
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−
17431505{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
17451506flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17461507 => D.Stream m (MutArray a) -> D.Stream m a
1747−flattenArraysRev = concatRev
1508+flattenArraysRev = concatChunksRev
17481509
17491510-------------------------------------------------------------------------------
17501511-- Unfolds
@@ -1973,7 +1734,7 @@ foldr f z arr = D.foldr f z $ read arr
19731734
19741735-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751736
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1737+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
19771738-- array.
19781739--
19791740-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1743,13 @@ foldr f z arr = D.foldr f z $ read arr
19821743-- Any free space left in the array after appending @n@ elements is lost.
19831744--
19841745-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1746+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1747+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871748 Int
19881749 -> m (MutArray a)
19891750 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1751+writeAppendNUnsafe n action =
1752+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911753
19921754 where
19931755
@@ -2000,7 +1762,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001762 -- otherwise we lose that space.
20011763 arr1 <-
20021764 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1765+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041766 else return arr
20051767 return $ toArrayUnsafe arr1
20061768
@@ -2008,51 +1770,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20081770 liftIO $ pokeAt end contents x
20091771 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101772
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−
20191773-- | Append @n@ elements to an existing array. Any free space left in the array
20201774-- after appending @n@ elements is lost.
20211775--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1776+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231777--
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 #-}
1778+{-# INLINE_NORMAL writeAppendN #-}
20321779writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331780 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1781+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351782
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1783+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371784-- append the input stream. If there is no reserved space available in the
20381785-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391786-- where @oldSize@ is the current size of the array in bytes.
20401787--
20411788-- Note that the returned array may be a mutated version of original array.
20421789--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1790+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441791--
20451792-- /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." #-}
20521793{-# INLINE writeAppendWith #-}
20531794writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541795 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1796+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561797
20571798-- | @append action@ mutates the array generated by @action@ to append the
20581799-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1801,26 @@ writeAppendWith = appendWith
20601801--
20611802-- Note that the returned array may be a mutated version of original array.
20621803--
2063−-- >>> append = MutArray.appendWith (* 2)
1804+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641805--
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." #-}
20721806{-# INLINE writeAppend #-}
20731807writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741808 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1809+writeAppend = writeAppendWith (* 2)
20761810
20771811-- XXX We can carry bound as well in the state to make sure we do not lose the
20781812-- remaining capacity. Need to check perf impact.
20791813--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1814+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1815+-- as argument.
20821816--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1817+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841818--
20851819-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1820+{-# INLINE_NORMAL writeNWithUnsafe #-}
1821+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881822 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1823+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901824
20911825 where
20921826
@@ -2097,64 +1831,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20971831 return
20981832 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991833
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−
21061834{-# INLINE_NORMAL writeNUnsafeAs #-}
21071835writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
21081836 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1837+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
21101838
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1839+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121840-- driver must not call the step function more than 'n' times otherwise it will
21131841-- corrupt the memory and crash. This function exists mainly because any
21141842-- conditional in the step function blocks fusion causing 10x performance
21151843-- slowdown.
21161844--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1845+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
21181846--
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 #-}
1847+{-# INLINE_NORMAL writeNUnsafe #-}
21261848writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271849 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1850+writeNUnsafe = writeNUnsafeAs Unpinned
21291851
2130−-- | Like 'unsafeCreateOf' but creates a pinned array.
2131−{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132−unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133− => Int -> Fold m a (MutArray a)
2134−unsafePinnedCreateOf = writeNUnsafeAs Pinned
2135−
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137−{-# INLINE pinnedWriteNUnsafe #-}
1852+-- | Like 'writeNUnsafe' but creates a pinned array.
1853+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
21381854pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
21391855 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1856+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
21411857
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1858+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431859-- allocated using the @alloc@ function.
21441860--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1861+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1862+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471863--
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 #-}
1864+{-# INLINE_NORMAL writeNWith #-}
21551865writeNWith :: forall m a. (MonadIO m, Unbox a)
21561866 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1867+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21581868
21591869{-# INLINE_NORMAL writeNAs #-}
21601870writeNAs ::
@@ -2162,42 +1872,28 @@ writeNAs ::
21621872 => PinnedState
21631873 -> Int
21641874 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1875+writeNAs ps = writeNWith (newAs ps)
21661876
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1877+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681878-- 'MutArray'.
21691879--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1880+-- >>> writeN = MutArray.writeNWith MutArray.new
1881+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1882+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
21731883--
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 #-}
1884+{-# INLINE_NORMAL writeN #-}
21811885writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1886+writeN = writeNAs Unpinned
21831887
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 #-}
1888+-- | Like 'writeN' but creates a pinned array.
1889+{-# INLINE_NORMAL pinnedWriteN #-}
21941890pinnedWriteN ::
21951891 forall m a. (MonadIO m, Unbox a)
21961892 => Int
21971893 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1894+pinnedWriteN = writeNAs Pinned
21991895
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1896+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011897--
22021898-- /Internal/
22031899{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1914,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22181914 return
22191915 $ ArrayUnsafe contents ptr end
22201916
2221−-- | Like createOfWith but writes the array in reverse order.
1917+-- | Like writeNWith but writes the array in reverse order.
22221918--
22231919-- /Internal/
22241920{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1922,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261922 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271923writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281924
2229−-- | Like 'createOf' but writes the array in reverse order.
1925+-- | Like writeN but writes the array in reverse order.
22301926--
22311927-- /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 #-}
1928+{-# INLINE_NORMAL writeRevN #-}
22381929writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1930+writeRevN = writeRevNWith new
22401931
22411932-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
22421933-- input stream to a 'MutArray' aligned to the given size.
22431934--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1935+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1936+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
22461937--
22471938-- /Pre-release/
22481939--
22491940{-# INLINE_NORMAL pinnedWriteNAligned #-}
22501941pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
22511942 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1943+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
22531944
22541945-- XXX Buffer to a list instead?
22551946
22561947-- | Buffer a stream into a stream of arrays.
22571948--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1949+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591950--
22601951-- Breaking an array into an array stream can be useful to consume a large
22611952-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1958,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22671958{-# INLINE_NORMAL buildChunks #-}
22681959buildChunks :: (MonadIO m, Unbox a) =>
22691960 Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
1961+buildChunks n = FL.many (writeN n) FL.toStreamK
22711962
22721963{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
22741964writeChunks :: (MonadIO m, Unbox a) =>
22751965 Int -> Fold m a (StreamK n (MutArray a))
22761966writeChunks = buildChunks
@@ -2278,29 +1968,29 @@ writeChunks = buildChunks
22781968{-# INLINE_NORMAL writeWithAs #-}
22791969writeWithAs :: forall m a. (MonadIO m, Unbox a)
22801970 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
1971+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
22821972writeWithAs ps elemCount =
22831973 FL.rmapM extract $ FL.foldlM' step initial
22841974
22851975 where
22861976
22871977 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2289− newAs ps elemCount
1978+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1979+ liftIO $ newAs ps elemCount
22901980
22911981 step arr@(MutArray _ start end bound) x
22921982 | INDEX_NEXT(end,a) > bound = do
22931983 let oldSize = end - start
22941984 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
1985+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
22961986 snocUnsafe arr1 x
22971987 step arr x = snocUnsafe arr x
22981988
22991989 extract = liftIO . rightSize
23001990
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
1991+-- XXX Compare writeWith with fromStreamD which uses an array of streams
23021992-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
1993+-- If writeWith is faster then we should use that to implement
23041994-- fromStreamD.
23051995--
23061996-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +2005,39 @@ writeWithAs ps elemCount =
23152005-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23162006-- malloc to compare against.
23172007
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
2008+-- | @writeWith minCount@ folds the whole input to a single array. The array
23192009-- starts at a size big enough to hold minCount elements, the size is doubled
23202010-- every time the array needs to be grown.
23212011--
23222012-- /Caution! Do not use this on infinite streams./
23232013--
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)
2014+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2015+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2016+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
23272017--
23282018-- /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 #-}
2019+{-# INLINE_NORMAL writeWith #-}
23372020writeWith :: forall m a. (MonadIO m, Unbox a)
23382021 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2022+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2023+writeWith = writeWithAs Unpinned
23402024
23412025-- | Fold the whole input to a single array.
23422026--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2027+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23442028-- rounded up to the element size.
23452029--
23462030-- /Caution! Do not use this on infinite streams./
23472031--
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." #-}
23542032{-# INLINE write #-}
23552033write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2034+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23572035
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." #-}
2036+-- | Like 'write' but creates a pinned array.
23652037{-# INLINE pinnedWrite #-}
23662038pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2039+pinnedWrite =
2040+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23682041
23692042-------------------------------------------------------------------------------
23702043-- construct from streams, known size
@@ -2374,7 +2047,7 @@ pinnedWrite = pinnedCreate
23742047fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
23752048 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
23762049fromStreamDNAs ps limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
2050+ (arr :: MutArray a) <- liftIO $ newAs ps limit
23782051 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
23792052 return $ arr {arrEnd = end}
23802053
@@ -2384,18 +2057,17 @@ fromStreamDNAs ps limit str = do
23842057 liftIO $ pokeAt ptr arrContents x
23852058 return $ INDEX_NEXT(ptr,a)
23862059
2387−-- | Use the 'createOf' fold instead.
2060+-- | Use the 'writeN' fold instead.
23882061--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2062+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
23902063--
23912064{-# INLINE_NORMAL fromStreamN #-}
23922065fromStreamN :: forall m a. (MonadIO m, Unbox a)
23932066 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2067+-- fromStreamDN n = D.fold (writeN n)
23952068fromStreamN = fromStreamDNAs Unpinned
23962069
23972070{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
23992071fromStreamDN :: forall m a. (MonadIO m, Unbox a)
24002072 => Int -> D.Stream m a -> m (MutArray a)
24012073fromStreamDN = fromStreamN
@@ -2418,20 +2090,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
24182090-- /Pre-release/
24192091{-# INLINE fromListRevN #-}
24202092fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2093+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24222094
24232095-- | Convert a pure stream in Identity monad to a mutable array.
24242096{-# INLINABLE fromPureStreamN #-}
24252097fromPureStreamN :: (MonadIO m, Unbox a) =>
24262098 Int -> Stream Identity a -> m (MutArray a)
24272099fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2100+ liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
24292101
24302102-- | Convert a pure stream in Identity monad to a mutable array.
24312103{-# INLINABLE fromPureStream #-}
24322104fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
24332105fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2106+ liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
24352107
24362108{-# INLINABLE fromPtrN #-}
24372109fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2112,7 @@ fromPtrN len addr = do
24402112 -- XXX We can implement a stream copy in a similar way by streaming Word64
24412113 -- first and then remaining Word8.
24422114 arr <- new len
2443− _ <- unsafeAsPtr arr
2115+ _ <- asUnpinnedPtrUnsafe arr
24442116 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
24452117 return (arr {arrEnd = len})
24462118
@@ -2456,7 +2128,7 @@ fromByteStr# addr = do
24562128 len <- liftIO $ c_strlen (Ptr addr)
24572129 let lenInt = fromIntegral len
24582130 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2131+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
24602132 return (arr {arrEnd = lenInt})
24612133
24622134-------------------------------------------------------------------------------
@@ -2477,7 +2149,7 @@ fromChunksRealloced s = do
24772149 arr <- D.foldlM' spliceExp (pure a) strm
24782150 -- Reallocation is exponential so there may be 50% empty space in
24792151 -- worst case. One more reallocation to reclaim the space.
2480− rightSize arr
2152+ liftIO $ rightSize arr
24812153 Nothing -> pure nil
24822154
24832155-------------------------------------------------------------------------------
@@ -2515,7 +2187,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
25152187fromChunksK = fromChunkskAs Unpinned
25162188
25172189{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
25192190fromArrayStreamK :: (Unbox a, MonadIO m) =>
25202191 StreamK m (MutArray a) -> m (MutArray a)
25212192fromArrayStreamK = fromChunksK
@@ -2527,7 +2198,7 @@ fromStreamDAs ps m =
25272198 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
25282199
25292200-- | 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
2201+-- single array from a stream of unknown size. 'writeN' is at least twice
25312202-- as efficient when the size is already known.
25322203--
25332204-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2210,19 @@ fromStreamDAs ps m =
25392210fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
25402211fromStream = fromStreamDAs Unpinned
25412212
2542−-- fromStream (Stream m) = P.fold create m
2213+-- fromStream (Stream m) = P.fold write m
25432214-- CAUTION: a very large number (millions) of arrays can degrade performance
25442215-- due to GC overhead because we need to buffer the arrays before we flatten
25452216-- all the arrays.
25462217--
2547−-- XXX Compare if this is faster or "fold create".
2218+-- XXX Compare if this is faster or "fold write".
25482219--
25492220-- | We could take the approach of doubling the memory allocation on each
25502221-- overflow. This would result in more or less the same amount of copying as in
25512222-- the chunking approach. However, if we have to shrink in the end then it may
25522223-- result in an extra copy of the entire data.
25532224--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2225+-- >>> fromStreamD = StreamD.fold MutArray.write
25552226--
25562227{-# INLINE fromStreamD #-}
25572228{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2252,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
25812252-- Cloning
25822253-------------------------------------------------------------------------------
25832254
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−
25882255{-# INLINE cloneAs #-}
25892256cloneAs ::
25902257 ( MonadIO m
@@ -2594,7 +2261,7 @@ cloneAs ::
25942261 )
25952262 => PinnedState -> MutArray a -> m (MutArray a)
25962263cloneAs ps src =
2597− do
2264+ liftIO $ do
25982265 let startSrc = arrStart src
25992266 srcLen = arrEnd src - startSrc
26002267 newArrContents <-
@@ -2633,16 +2300,17 @@ spliceCopy :: forall m a. MonadIO m =>
26332300 Unbox a =>
26342301#endif
26352302 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2303+spliceCopy arr1 arr2 = liftIO $ do
26372304 let start1 = arrStart arr1
26382305 start2 = arrStart arr2
26392306 len1 = arrEnd arr1 - start1
26402307 len2 = arrEnd arr2 - start2
2641− let len = len1 + len2
2308+ let newLen = len1 + len2
26422309 newArrContents <-
26432310 if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2311+ then Unboxed.pinnedNew newLen
2312+ else Unboxed.new newLen
2313+ let len = len1 + len2
26462314 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
26472315 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
26482316 return $ MutArray newArrContents 0 len len
@@ -2654,7 +2322,7 @@ spliceCopy arr1 arr2 = do
26542322spliceUnsafe :: MonadIO m =>
26552323 MutArray a -> MutArray a -> m (MutArray a)
26562324spliceUnsafe dst src =
2657− do
2325+ liftIO $ do
26582326 let startSrc = arrStart src
26592327 srcLen = arrEnd src - startSrc
26602328 endDst = arrEnd dst
@@ -2676,7 +2344,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762344 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772345spliceWith sizer dst@(MutArray _ start end bound) src = do
26782346{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2347+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802348 in D.fold f (toStreamD src)
26812349-}
26822350 assert (end <= bound) (return ())
@@ -2692,7 +2360,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
26922360 $ "splice: newSize is less than the total size "
26932361 ++ "of arrays being appended. Please check the "
26942362 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2363+ liftIO $ realloc newSizeInBytes dst
26962364 else return dst
26972365 spliceUnsafe dst1 src
26982366
@@ -2744,7 +2412,7 @@ splitOn predicate arr =
27442412{-# INLINE breakOn #-}
27452413breakOn :: MonadIO m
27462414 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2415+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
27482416 -- XXX We do not need memchr here, we can use a Haskell equivalent.
27492417 -- Need efficient stream based primitives that work on Word64.
27502418 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2435,33 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672435 }
27682436 )
27692437
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−
27922438-- | Create two slices of an array without copying the original array. The
27932439-- specified index @i@ is the first index of the second slice.
27942440--
27952441{-# INLINE splitAt #-}
27962442splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2443+splitAt i arr@MutArray{..} =
27982444 let maxIndex = length arr - 1
27992445 in if i < 0
28002446 then error "sliceAt: negative array index"
28012447 else if i > maxIndex
28022448 then error $ "sliceAt: specified array index " ++ show i
28032449 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2450+ else let off = i * SIZE_OF(a)
2451+ p = arrStart + off
2452+ in ( MutArray
2453+ { arrContents = arrContents
2454+ , arrStart = arrStart
2455+ , arrEnd = p
2456+ , arrBound = p
2457+ }
2458+ , MutArray
2459+ { arrContents = arrContents
2460+ , arrStart = p
2461+ , arrEnd = arrEnd
2462+ , arrBound = arrBound
2463+ }
2464+ )
28052465
28062466-------------------------------------------------------------------------------
28072467-- Casting
@@ -2851,13 +2511,9 @@ cast arr =
28512511-- guarantees that unsafe calls will be performed in the calling thread. Making
28522512-- it safe to pass heap-allocated objects to unsafe functions.
28532513
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2514+-- Should we just name it asPtr, the unsafety is implicit for any pointer
28552515-- operations. And we are safe from Haskell perspective because we will be
28562516-- 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.
28612517
28622518-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
28632519-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2531,16 @@ cast arr =
28752531--
28762532-- /Pre-release/
28772533--
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." #-}
28852534{-# INLINE asPtrUnsafe #-}
28862535asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2536+asPtrUnsafe arr f =
2537+ Unboxed.asPtrUnsafe
2538+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28882539
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2892− Unboxed.unsafeAsPtr
2540+{-# INLINE asUnpinnedPtrUnsafe #-}
2541+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2542+asUnpinnedPtrUnsafe arr f =
2543+ Unboxed.asUnpinnedPtrUnsafe
28932544 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28942545
28952546-------------------------------------------------------------------------------
@@ -2907,26 +2558,28 @@ unsafeAsPtr arr f =
29072558-- /Pre-release/
29082559{-# INLINE byteCmp #-}
29092560byteCmp :: 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
2561+byteCmp arr1 arr2 =
2562+ liftIO
2563+ $ do
2564+ let marr1 = getMutableByteArray# (arrContents arr1)
2565+ marr2 = getMutableByteArray# (arrContents arr2)
2566+ !(I# st1#) = arrStart arr1
2567+ !(I# st2#) = arrStart arr2
2568+ !(I# len#) = byteLength arr1
2569+ case compare (byteLength arr1) (byteLength arr2) of
2570+ EQ -> do
2571+ r <- liftIO $ IO $ \s# ->
2572+ let res =
2573+ I#
2574+ (compareByteArrays#
2575+ (unsafeCoerce# marr1)
2576+ st1#
2577+ (unsafeCoerce# marr2)
2578+ st2#
2579+ len#)
2580+ in (# s#, res #)
2581+ return $ compare r 0
2582+ x -> return x
29302583
29312584{-# INLINE cmp #-}
29322585{-# DEPRECATED cmp "Please use byteCmp instead." #-}
@@ -2946,48 +2599,46 @@ byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
29462599-- Compact
29472600-------------------------------------------------------------------------------
29482601
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 ::
2602+-- | Parser @pCompactChunksLE n@ coalesces adjacent arrays in the input stream
2603+-- only if the combined size would be less than or equal to n.
2604+--
2605+-- /Internal/
2606+{-# INLINE_NORMAL pCompactChunksLE #-}
2607+pCompactChunksLE ::
29562608 forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2609+ => Int -> Parser (MutArray a) m (MutArray a)
2610+pCompactChunksLE n = Parser step initial extract
29592611
29602612 where
29612613
2962− maxBytes = maxElems * SIZE_OF(a)
2614+ nBytes = n * SIZE_OF(a)
29632615
2964− functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2616+ functionName = "Streamly.Internal.Data.MutArray.pCompactChunksLE"
29652617
29662618 initial =
29672619 return
2968− $ if maxElems <= 0
2620+ $ if n <= 0
29692621 then error
29702622 $ functionName
29712623 ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2624+ ++ show n ++ "] must be a natural number"
29732625 else Parser.IPartial Nothing
29742626
29752627 step Nothing arr =
29762628 return
29772629 $ let len = byteLength arr
2978− in if len >= maxBytes
2630+ in if len >= nBytes
29792631 then Parser.Done 0 arr
29802632 else Parser.Partial 0 (Just arr)
2981− -- XXX Split the last array to use the space more compactly.
29822633 step (Just buf) arr =
29832634 let len = byteLength buf + byteLength arr
2984− in if len > maxBytes
2635+ in if len > nBytes
29852636 then return $ Parser.Done 1 buf
29862637 else do
2638+ -- XXX check this in the Nothing case
29872639 buf1 <-
2988− if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2640+ if byteCapacity buf < nBytes
2641+ then liftIO $ realloc nBytes buf
29912642 else return buf
29922643 buf2 <- spliceUnsafe buf1 arr
29932644 return $ Parser.Partial 0 (Just buf2)
@@ -2995,30 +2646,6 @@ pCompactLeAs ps maxElems = Parser step initial extract
29952646 extract Nothing = return $ Parser.Done 0 nil
29962647 extract (Just buf) = return $ Parser.Done 0 buf
29972648
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−
30222649data SpliceState s arr
30232650 = SpliceInitial s
30242651 | SpliceBuffering s arr
@@ -3030,47 +2657,48 @@ data SpliceState s arr
30302657-- immutable array never has additional space so a new array is allocated
30312658-- instead of mutating it.
30322659
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) =
2660+-- | Scan @rCompactChunksLE n@ coalesces adjacent arrays in the input stream
2661+-- only if the combined size would be less than or equal to n.
2662+--
2663+-- /Internal/
2664+{-# INLINE_NORMAL rCompactChunksLE #-}
2665+rCompactChunksLE :: (MonadIO m, Unbox a)
2666+ => Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
2667+rCompactChunksLE n (D.Stream step state) =
30372668 D.Stream step' (SpliceInitial state)
30382669
30392670 where
30402671
3041− maxBytes = maxElems * SIZE_OF(a)
3042−
3043− functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
2672+ functionName = "Streamly.Internal.Data.MutArray.rCompactChunksLE"
30442673
30452674 {-# INLINE_LATE step' #-}
30462675 step' gst (SpliceInitial st) = do
3047− when (maxElems <= 0) $
2676+ when (n <= 0) $
30482677 -- XXX we can pass the module string from the higher level API
3049− error $ functionName ++ ": the size of arrays [" ++ show maxElems
2678+ error $ functionName ++ ": the size of arrays [" ++ show n
30502679 ++ "] must be a natural number"
30512680 r <- step gst st
30522681 case r of
30532682 D.Yield arr s -> return $
30542683 let len = byteLength arr
3055− in if len >= maxBytes
2684+ in if len >= n
30562685 then D.Skip (SpliceYielding arr (SpliceInitial s))
30572686 else D.Skip (SpliceBuffering s arr)
30582687 D.Skip s -> return $ D.Skip (SpliceInitial s)
30592688 D.Stop -> return D.Stop
30602689
3061− -- XXX Split the last array to use the space more compactly.
30622690 step' gst (SpliceBuffering st buf) = do
30632691 r <- step gst st
30642692 case r of
30652693 D.Yield arr s -> do
30662694 let len = byteLength buf + byteLength arr
3067− if len > maxBytes
2695+ if len > n
30682696 then return $
30692697 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
30702698 else do
3071− buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
2699+ -- XXX check this in the SpliceInitial case
2700+ buf1 <- if byteCapacity buf < n
2701+ then liftIO $ realloc n buf
30742702 else return buf
30752703 buf2 <- spliceUnsafe buf1 arr
30762704 return $ D.Skip (SpliceBuffering s buf2)
@@ -3081,124 +2709,113 @@ compactLeAs ps maxElems (D.Stream step state) =
30812709
30822710 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
30832711
3084−
3085−{-# INLINE_NORMAL fCompactGeAs #-}
3086−fCompactGeAs ::
2712+-- | Fold @fCompactChunksGE n@ coalesces adjacent arrays in the input stream
2713+-- until the size becomes greater than or equal to n.
2714+--
2715+{-# INLINE_NORMAL fCompactChunksGE #-}
2716+fCompactChunksGE ::
30872717 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
2718+ => Int -> FL.Fold m (MutArray a) (MutArray a)
2719+fCompactChunksGE n = Fold step initial extract extract
30902720
30912721 where
30922722
3093− minBytes = minElems * SIZE_OF(a)
2723+ nBytes = n * SIZE_OF(a)
30942724
3095− functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
2725+ functionName = "Streamly.Internal.Data.MutArray.fCompactChunksGE"
30962726
30972727 initial =
30982728 return
3099− $ if minElems < 0
2729+ $ if n < 0
31002730 then error
31012731 $ functionName
31022732 ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
2733+ ++ show n ++ "] must be a natural number"
31042734 else FL.Partial Nothing
31052735
31062736 step Nothing arr =
31072737 return
31082738 $ let len = byteLength arr
3109− in if len >= minBytes
2739+ in if len >= nBytes
31102740 then FL.Done arr
31112741 else FL.Partial (Just arr)
3112− -- XXX Buffer arrays as a list to avoid copy and reallocations
31132742 step (Just buf) arr = do
31142743 let len = byteLength buf + byteLength arr
31152744 buf1 <-
31162745 if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
2746+ then liftIO $ realloc (max len nBytes) buf
31192747 else return buf
31202748 buf2 <- spliceUnsafe buf1 arr
3121− if len >= minBytes
2749+ if len >= n
31222750 then return $ FL.Done buf2
31232751 else return $ FL.Partial (Just buf2)
31242752
31252753 extract Nothing = return nil
31262754 extract (Just buf) = return buf
31272755
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
2756+-- | Like 'compactChunksGE' but for transforming folds instead of stream.
31302757--
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) =
2758+-- >>> lCompactChunksGE n = Fold.many (MutArray.fCompactChunksGE n)
2759+--
2760+{-# INLINE_NORMAL lCompactChunksGE #-}
2761+lCompactChunksGE :: (MonadIO m, Unbox a)
2762+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
2763+-- lCompactChunksGE n = Fold.many (fCompactChunksGE n)
2764+lCompactChunksGE n (Fold step1 initial1 _ final1) =
31522765 Fold step initial extract final
31532766
31542767 where
31552768
3156− minBytes = minElems * SIZE_OF(a)
3157−
3158− functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
2769+ functionName = "Streamly.Internal.Data.MutArray.lCompactChunksGE"
31592770
31602771 initial = do
3161− when (minElems <= 0) $
2772+ when (n <= 0) $
31622773 -- XXX we can pass the module string from the higher level API
31632774 error $ functionName ++ ": the size of arrays ["
3164− ++ show minElems ++ "] must be a natural number"
2775+ ++ show n ++ "] must be a natural number"
31652776
31662777 r <- initial1
31672778 return $ first (Tuple' Nothing) r
31682779
3169− {-# INLINE runInner #-}
3170− runInner len acc buf =
3171− if len >= minBytes
2780+ step (Tuple' Nothing r1) arr =
2781+ let len = byteLength arr
2782+ in if len >= n
2783+ then do
2784+ r <- step1 r1 arr
2785+ case r of
2786+ FL.Done _ -> return $ FL.Done ()
2787+ FL.Partial s -> do
2788+ _ <- final1 s
2789+ res <- initial1
2790+ return $ first (Tuple' Nothing) res
2791+ else return $ FL.Partial $ Tuple' (Just arr) r1
2792+
2793+ step (Tuple' (Just buf) r1) arr = do
2794+ let len = byteLength buf + byteLength arr
2795+ buf1 <- if byteCapacity buf < len
2796+ then liftIO $ realloc (max n len) buf
2797+ else return buf
2798+ buf2 <- spliceUnsafe buf1 arr
2799+
2800+ -- XXX this is common in both the equations of step
2801+ if len >= n
31722802 then do
3173− r <- step1 acc buf
2803+ r <- step1 r1 buf2
31742804 case r of
31752805 FL.Done _ -> return $ FL.Done ()
31762806 FL.Partial s -> do
31772807 _ <- final1 s
31782808 res <- initial1
31792809 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
2810+ else return $ FL.Partial $ Tuple' (Just buf2) r1
31942811
31952812 -- 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
2813+ -- return "m b" rather than using extract post it if we want extract to be
31972814 -- partial.
31982815 --
31992816 -- extract forces the pending buffer to be sent to the fold which is not
32002817 -- what we want.
3201− extract _ = error "lCompactGE: not designed for scanning"
2818+ extract _ = error "lCompactChunksGE: not designed for scanning"
32022819
32032820 final (Tuple' Nothing r1) = final1 r1
32042821 final (Tuple' (Just buf) r1) = do
@@ -3207,42 +2824,25 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
32072824 FL.Partial rr -> final1 rr
32082825 FL.Done _ -> return ()
32092826
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
2827+-- | @compactChunksGE n stream@ coalesces adjacent arrays in the @stream@ until
32282828-- the size becomes greater than or equal to @n@.
32292829--
3230−-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
2830+-- >>> compactChunksGE n = Stream.foldMany (MutArray.fCompactChunksGE n)
32312831--
3232−{-# INLINE compactGE #-}
3233−compactGE ::
2832+{-# INLINE compactChunksGE #-}
2833+compactChunksGE ::
32342834 (MonadIO m, Unbox a)
32352835 => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236−compactGE n = D.foldMany (fCompactGE n)
2836+compactChunksGE n = D.foldMany (fCompactChunksGE n)
32372837
3238−-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
2838+-- | 'compactChunksEQ n' coalesces adajacent arrays in the input stream to
32392839-- arrays of exact size @n@.
32402840--
32412841-- /Unimplemented/
3242−{-# INLINE compactEQ #-}
3243−compactEQ :: -- (MonadIO m, Unbox a) =>
2842+{-# INLINE compactChunksEQ #-}
2843+compactChunksEQ :: -- (MonadIO m, Unbox a) =>
32442844 Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3245−compactEQ _n = undefined -- D.parseManyD (pCompactEQ n)
2845+compactChunksEQ _n = undefined -- D.parseManyD (pCompactChunksEQ n)
32462846
32472847-------------------------------------------------------------------------------
32482848-- In-place mutation algorithms