@@ -40,22 +40,22 @@ module Streamly.Internal.Data.MutArray.Type
4040
4141 -- ** Casting
4242 , cast
43− , castUnsafe -- XXX unsafeCast
43+ , castUnsafe
4444 , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
45+ , asPtrUnsafe
46+ , asUnpinnedPtrUnsafe
4747
4848 -- ** Construction
49− , empty
49+ , nil
5050
5151 -- *** New
5252 -- | New arrays are always empty arrays with some reserve capacity to
5353 -- extend the length without reallocating.
54− , emptyOf
55− , newArrayWith -- emptyAlignedWith
56− , pinnedEmptyOf
57− , pinnedNewAligned -- XXX not required
58− -- , new -- uninitialized array of specified length
54+ , new
55+ , newArrayWith
56+ , pinnedNew
57+ , pinnedNewBytes
58+ , pinnedNewAligned
5959
6060 -- *** Cloning
6161 , clone
@@ -63,25 +63,27 @@ module Streamly.Internal.Data.MutArray.Type
6363
6464 -- *** Slicing
6565 -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
66+ , getSliceUnsafe
6767 , getSlice
6868 , splitAt -- XXX should be able to express using getSlice
6969 , breakOn
7070
7171 -- *** Stream Folds
7272 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
74− , unsafeCreateOf
75− , unsafePinnedCreateOf
76− , pinnedCreateOf
77− , createOfWith
78− , createOf
79− , revCreateOf
80−
81− , pinnedCreate
82− , createWith
83− , create
84− -- , revCreate
73+ , writeNWithUnsafe
74+ , writeNWith
75+ , writeNUnsafe
76+ , pinnedWriteNUnsafe
77+ , writeN
78+ , pinnedWriteN
79+ , pinnedWriteNAligned
80+
81+ , writeWith
82+ , write
83+ , pinnedWrite
84+
85+ , writeRevN
86+ -- , writeRev
8587
8688 -- *** From containers
8789 , fromListN
@@ -97,11 +99,11 @@ module Streamly.Internal.Data.MutArray.Type
9799 , fromByteStr#
98100 , fromPtrN
99101 , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
102+ , fromChunksRealloced
101103
102104 -- ** Random writes
103105 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
106+ , putIndexUnsafe
105107 , putIndices
106108 -- , putFromThenTo
107109 -- , putFrom -- start writing at the given position
@@ -109,7 +111,7 @@ module Streamly.Internal.Data.MutArray.Type
109111 -- , putFromTo
110112 -- , putFromRev
111113 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
114+ , modifyIndexUnsafe
113115 , modifyIndex
114116 , modifyIndices
115117 , modify
@@ -120,9 +122,9 @@ module Streamly.Internal.Data.MutArray.Type
120122
121123 -- *** Indexing
122124 , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
125+ , getIndexUnsafe
124126 -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
127+ , getIndexRev
126128 , indexReader
127129 , indexReaderWith
128130
@@ -193,34 +195,24 @@ module Streamly.Internal.Data.MutArray.Type
193195 , snoc
194196 , snocLinear
195197 , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
198+ , snocUnsafe
197199
198200 -- *** Appending streams
199− , unsafeAppendN
200− , appendN
201− , appendWith
202− , append
201+ , writeAppendNUnsafe
202+ , writeAppendN
203+ , writeAppendWith
204+ , writeAppend
203205
204206 -- *** Appending arrays
205207 , spliceCopy
206208 , spliceWith
207209 , splice
208210 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
211+ , spliceUnsafe
210212 -- , putSlice
211213 -- , appendSlice
212214 -- , appendSliceFrom
213215
214− -- ** Serialization using Unbox
215− , pokeAppend
216− , pokeAppendMay
217− , pokeSkipUnsafe -- unsafePokeSkip
218−
219− -- ** Deserialization using Unbox
220− , peekUncons
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
223−
224216 -- Arrays of arrays
225217 -- We can add dimensionality parameter to the array type to get
226218 -- multidimensional arrays. Multidimensional arrays would just be a
@@ -242,8 +234,6 @@ module Streamly.Internal.Data.MutArray.Type
242234
243235 -- *** Concat
244236 -- | Append the arrays in a stream to form a stream of elements.
245− , concatWith
246− , concatRevWith
247237 , concat
248238 , concatRev
249239
@@ -251,12 +241,9 @@ module Streamly.Internal.Data.MutArray.Type
251241 -- | Append the arrays in a stream to form a stream of larger arrays.
252242 , SpliceState (..)
253243 , pCompactLE
254− , pPinnedCompactLE
255− , compactLeAs
244+ , rCompactLE
256245 , fCompactGE
257− , fPinnedCompactGE
258246 , lCompactGE
259− , lPinnedCompactGE
260247 , compactGE
261248 , compactEQ
262249
@@ -267,7 +254,6 @@ module Streamly.Internal.Data.MutArray.Type
267254 , c_memchr
268255
269256 -- * Deprecated
270− , asPtrUnsafe
271257 , writeChunks
272258 , flattenArrays
273259 , flattenArraysRev
@@ -279,25 +265,6 @@ module Streamly.Internal.Data.MutArray.Type
279265 , getIndicesWith
280266 , resize
281267 , 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
301268 )
302269where
303270
@@ -479,8 +446,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479446-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480447-- allocatePinned in GHC source.
481448
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484449-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485450-- length and with a capacity to hold @count@ elements, using @allocator
486451-- size alignment@ as the memory allocator function.
@@ -504,25 +469,12 @@ newArrayWith alloc alignSize count = do
504469 , arrBound = size
505470 }
506471
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." #-}
520472nil ::
521473#ifdef DEVBUILD
522474 Unbox a =>
523475#endif
524476 MutArray a
525−nil = empty
477+nil = MutArray Unboxed.nil 0 0 0
526478
527479{-# INLINE newBytesAs #-}
528480newBytesAs :: MonadIO m =>
@@ -539,13 +491,12 @@ newBytesAs ps bytes = do
539491 , arrBound = bytes
540492 }
541493
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.
494+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
495+-- the array is uninitialized and the allocation is aligned as per the
496+-- 'Unboxed' instance of the type.
545497--
546498-- /Pre-release/
547499{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549500pinnedNewBytes :: MonadIO m =>
550501#ifdef DEVBUILD
551502 Unbox a =>
@@ -570,31 +521,21 @@ newAs ps =
570521 (error "new: alignment is not used in unpinned arrays.")
571522
572523-- 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." #-}
524+--
525+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
526+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
527+-- instance of the type.
528+--
582529{-# INLINE pinnedNew #-}
583530pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
531+pinnedNew = newAs Pinned
585532
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
533+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
534+-- of the array is uninitialized.
588535--
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." #-}
595536{-# INLINE new #-}
596537new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
538+new = newAs Unpinned
598539
599540-------------------------------------------------------------------------------
600541-- Random writes
@@ -842,15 +783,15 @@ roundDownTo elemSize size = size - (size `mod` elemSize)
842783-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843784-- which complicates some inspection tests.
844785--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
786+{-# NOINLINE reallocExplicit #-}
787+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
788+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848789 assertM(arrEnd <= arrBound)
849790
850791 -- Allocate new array
851792 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852793 contents <-
853− if ps == Pinned
794+ if Unboxed.isPinned arrContents
854795 then Unboxed.pinnedNew newCapMaxInBytes
855796 else Unboxed.new newCapMaxInBytes
856797 let !(MutByteArray mbarrFrom#) = arrContents
@@ -890,12 +831,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890831-- If the original array is pinned, the newly allocated array is also pinned.
891832{-# INLINABLE realloc #-}
892833realloc :: 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
834+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899835
900836-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901837-- in error messages and the capSizer is used to determine the capacity of the
@@ -944,7 +880,6 @@ grow nElems arr@MutArray{..} = do
944880 else realloc req arr
945881
946882{-# DEPRECATED resize "Please use grow instead." #-}
947−{-# INLINE resize #-}
948883resize :: forall m a. (MonadIO m, Unbox a) =>
949884 Int -> MutArray a -> m (MutArray a)
950885resize = grow
@@ -968,7 +903,6 @@ growExp nElems arr@MutArray{..} = do
968903 else realloc req1 arr
969904
970905{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971−{-# INLINE resizeExp #-}
972906resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973907 Int -> MutArray a -> m (MutArray a)
974908resizeExp = growExp
@@ -1117,126 +1051,6 @@ snoc = snocWith f
11171051 then oldSize * 2
11181052 else roundUpToPower2 oldSize * 2
11191053
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−
12401054-------------------------------------------------------------------------------
12411055-- Random reads
12421056-------------------------------------------------------------------------------
@@ -1302,7 +1116,6 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
13021116 D.Stop -> return D.Stop
13031117
13041118{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305−{-# INLINE getIndicesWith #-}
13061119getIndicesWith :: (Monad m, Unbox a) =>
13071120 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
13081121getIndicesWith = indexReaderWith
@@ -1318,7 +1131,6 @@ indexReader = indexReaderWith liftIO
13181131
13191132-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
13201133{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1321−{-# INLINE getIndices #-}
13221134getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
13231135getIndices = indexReader
13241136
@@ -1615,7 +1427,7 @@ chunksOfAs ps n (D.Stream step state) =
16151427--
16161428-- Same as the following but may be more efficient:
16171429--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1430+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
16191431--
16201432-- /Pre-release/
16211433{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1436,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
16241436-- XXX the idiomatic implementation leads to large regression in the D.reverse'
16251437-- benchmark. It seems it has difficulty producing optimized code when
16261438-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1439+-- chunksOf n = D.foldMany (writeN n)
16281440chunksOf = chunksOfAs Unpinned
16291441
16301442-- | Like 'chunksOf' but creates pinned arrays.
16311443{-# INLINE_NORMAL pinnedChunksOf #-}
16321444pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
16331445 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1446+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
16351447pinnedChunksOf = chunksOfAs Pinned
16361448
16371449-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1476,16 @@ data FlattenState s contents a =
16641476 OuterLoop s
16651477 | InnerLoop s contents !Int !Int
16661478
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)
1479+-- | Use the "reader" unfold instead.
1480+--
1481+-- @concat = unfoldMany reader@
1482+--
1483+-- We can try this if there are any fusion issues in the unfold.
1484+--
1485+{-# INLINE_NORMAL concat #-}
1486+concat :: forall m a. (MonadIO m, Unbox a)
1487+ => D.Stream m (MutArray a) -> D.Stream m a
1488+concat (D.Stream step state) = D.Stream step' (OuterLoop state)
16711489
16721490 where
16731491
@@ -1684,30 +1502,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841502 return $ D.Skip $ OuterLoop st
16851503
16861504 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1505+ x <- liftIO $ peekAt p contents
16881506 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891507
1690−-- | Use the "reader" unfold instead.
1691−--
1692−-- @concat = unfoldMany reader@
1693−--
1694−-- We can try this if there are any fusion issues in the unfold.
1695−--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1698− => D.Stream m (MutArray a) -> D.Stream m a
1699−concat = concatWith liftIO
1700−
17011508{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
17031509flattenArrays :: forall m a. (MonadIO m, Unbox a)
17041510 => D.Stream m (MutArray a) -> D.Stream m a
17051511flattenArrays = concat
17061512
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)
1513+-- | Use the "readerRev" unfold instead.
1514+--
1515+-- @concat = unfoldMany readerRev@
1516+--
1517+-- We can try this if there are any fusion issues in the unfold.
1518+--
1519+{-# INLINE_NORMAL concatRev #-}
1520+concatRev :: forall m a. (MonadIO m, Unbox a)
1521+ => D.Stream m (MutArray a) -> D.Stream m a
1522+concatRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111523
17121524 where
17131525
@@ -1725,23 +1537,11 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251537 return $ D.Skip $ OuterLoop st
17261538
17271539 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1540+ x <- liftIO $ peekAt p contents
17291541 let cur = INDEX_PREV(p,a)
17301542 return $ D.Yield x (InnerLoop st contents cur start)
17311543
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−
17431544{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
17451545flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17461546 => D.Stream m (MutArray a) -> D.Stream m a
17471547flattenArraysRev = concatRev
@@ -1973,7 +1773,7 @@ foldr f z arr = D.foldr f z $ read arr
19731773
19741774-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751775
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1776+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
19771777-- array.
19781778--
19791779-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1782,13 @@ foldr f z arr = D.foldr f z $ read arr
19821782-- Any free space left in the array after appending @n@ elements is lost.
19831783--
19841784-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1785+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1786+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871787 Int
19881788 -> m (MutArray a)
19891789 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1790+writeAppendNUnsafe n action =
1791+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911792
19921793 where
19931794
@@ -2000,7 +1801,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001801 -- otherwise we lose that space.
20011802 arr1 <-
20021803 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1804+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041805 else return arr
20051806 return $ toArrayUnsafe arr1
20061807
@@ -2008,51 +1809,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20081809 liftIO $ pokeAt end contents x
20091810 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101811
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−
20191812-- | Append @n@ elements to an existing array. Any free space left in the array
20201813-- after appending @n@ elements is lost.
20211814--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1815+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231816--
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 #-}
1817+{-# INLINE_NORMAL writeAppendN #-}
20321818writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331819 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1820+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351821
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1822+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371823-- append the input stream. If there is no reserved space available in the
20381824-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391825-- where @oldSize@ is the current size of the array in bytes.
20401826--
20411827-- Note that the returned array may be a mutated version of original array.
20421828--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1829+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441830--
20451831-- /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." #-}
20521832{-# INLINE writeAppendWith #-}
20531833writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541834 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1835+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561836
20571837-- | @append action@ mutates the array generated by @action@ to append the
20581838-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1840,26 @@ writeAppendWith = appendWith
20601840--
20611841-- Note that the returned array may be a mutated version of original array.
20621842--
2063−-- >>> append = MutArray.appendWith (* 2)
1843+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641844--
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." #-}
20721845{-# INLINE writeAppend #-}
20731846writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741847 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1848+writeAppend = writeAppendWith (* 2)
20761849
20771850-- XXX We can carry bound as well in the state to make sure we do not lose the
20781851-- remaining capacity. Need to check perf impact.
20791852--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1853+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1854+-- as argument.
20821855--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1856+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841857--
20851858-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1859+{-# INLINE_NORMAL writeNWithUnsafe #-}
1860+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881861 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1862+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901863
20911864 where
20921865
@@ -2097,64 +1870,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20971870 return
20981871 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991872
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−
21061873{-# INLINE_NORMAL writeNUnsafeAs #-}
21071874writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
21081875 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1876+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
21101877
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1878+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121879-- driver must not call the step function more than 'n' times otherwise it will
21131880-- corrupt the memory and crash. This function exists mainly because any
21141881-- conditional in the step function blocks fusion causing 10x performance
21151882-- slowdown.
21161883--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1884+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
21181885--
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 #-}
1886+{-# INLINE_NORMAL writeNUnsafe #-}
21261887writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271888 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1889+writeNUnsafe = writeNUnsafeAs Unpinned
21291890
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 #-}
1891+-- | Like 'writeNUnsafe' but creates a pinned array.
1892+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
21381893pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
21391894 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1895+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
21411896
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1897+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431898-- allocated using the @alloc@ function.
21441899--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1900+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1901+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471902--
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 #-}
1903+{-# INLINE_NORMAL writeNWith #-}
21551904writeNWith :: forall m a. (MonadIO m, Unbox a)
21561905 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1906+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21581907
21591908{-# INLINE_NORMAL writeNAs #-}
21601909writeNAs ::
@@ -2162,42 +1911,28 @@ writeNAs ::
21621911 => PinnedState
21631912 -> Int
21641913 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1914+writeNAs ps = writeNWith (newAs ps)
21661915
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1916+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681917-- 'MutArray'.
21691918--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1919+-- >>> writeN = MutArray.writeNWith MutArray.new
1920+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1921+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
21731922--
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 #-}
1923+{-# INLINE_NORMAL writeN #-}
21811924writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1925+writeN = writeNAs Unpinned
21831926
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 #-}
1927+-- | Like 'writeN' but creates a pinned array.
1928+{-# INLINE_NORMAL pinnedWriteN #-}
21941929pinnedWriteN ::
21951930 forall m a. (MonadIO m, Unbox a)
21961931 => Int
21971932 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1933+pinnedWriteN = writeNAs Pinned
21991934
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1935+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011936--
22021937-- /Internal/
22031938{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1953,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22181953 return
22191954 $ ArrayUnsafe contents ptr end
22201955
2221−-- | Like createOfWith but writes the array in reverse order.
1956+-- | Like writeNWith but writes the array in reverse order.
22221957--
22231958-- /Internal/
22241959{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1961,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261961 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271962writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281963
2229−-- | Like 'createOf' but writes the array in reverse order.
1964+-- | Like writeN but writes the array in reverse order.
22301965--
22311966-- /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 #-}
1967+{-# INLINE_NORMAL writeRevN #-}
22381968writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1969+writeRevN = writeRevNWith new
22401970
22411971-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
22421972-- input stream to a 'MutArray' aligned to the given size.
22431973--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1974+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1975+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
22461976--
22471977-- /Pre-release/
22481978--
22491979{-# INLINE_NORMAL pinnedWriteNAligned #-}
22501980pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
22511981 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1982+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
22531983
22541984-- XXX Buffer to a list instead?
22551985
22561986-- | Buffer a stream into a stream of arrays.
22571987--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1988+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591989--
22601990-- Breaking an array into an array stream can be useful to consume a large
22611991-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1997,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22671997{-# INLINE_NORMAL buildChunks #-}
22681998buildChunks :: (MonadIO m, Unbox a) =>
22691999 Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
2000+buildChunks n = FL.many (writeN n) FL.toStreamK
22712001
22722002{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
22742003writeChunks :: (MonadIO m, Unbox a) =>
22752004 Int -> Fold m a (StreamK n (MutArray a))
22762005writeChunks = buildChunks
@@ -2278,29 +2007,29 @@ writeChunks = buildChunks
22782007{-# INLINE_NORMAL writeWithAs #-}
22792008writeWithAs :: forall m a. (MonadIO m, Unbox a)
22802009 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
2010+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
22822011writeWithAs ps elemCount =
22832012 FL.rmapM extract $ FL.foldlM' step initial
22842013
22852014 where
22862015
22872016 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2017+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
22892018 newAs ps elemCount
22902019
22912020 step arr@(MutArray _ start end bound) x
22922021 | INDEX_NEXT(end,a) > bound = do
22932022 let oldSize = end - start
22942023 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
2024+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
22962025 snocUnsafe arr1 x
22972026 step arr x = snocUnsafe arr x
22982027
22992028 extract = liftIO . rightSize
23002029
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
2030+-- XXX Compare writeWith with fromStreamD which uses an array of streams
23022031-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
2032+-- If writeWith is faster then we should use that to implement
23042033-- fromStreamD.
23052034--
23062035-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +2044,39 @@ writeWithAs ps elemCount =
23152044-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23162045-- malloc to compare against.
23172046
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
2047+-- | @writeWith minCount@ folds the whole input to a single array. The array
23192048-- starts at a size big enough to hold minCount elements, the size is doubled
23202049-- every time the array needs to be grown.
23212050--
23222051-- /Caution! Do not use this on infinite streams./
23232052--
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)
2053+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2054+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2055+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
23272056--
23282057-- /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 #-}
2058+{-# INLINE_NORMAL writeWith #-}
23372059writeWith :: forall m a. (MonadIO m, Unbox a)
23382060 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2061+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2062+writeWith = writeWithAs Unpinned
23402063
23412064-- | Fold the whole input to a single array.
23422065--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2066+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23442067-- rounded up to the element size.
23452068--
23462069-- /Caution! Do not use this on infinite streams./
23472070--
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." #-}
23542071{-# INLINE write #-}
23552072write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2357−
2358−-- | Like 'create' but creates a pinned array.
2359−{-# INLINE pinnedCreate #-}
2360−pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2361−pinnedCreate =
2362− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2073+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23632074
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
2075+-- | Like 'write' but creates a pinned array.
23652076{-# INLINE pinnedWrite #-}
23662077pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2078+pinnedWrite =
2079+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23682080
23692081-------------------------------------------------------------------------------
23702082-- construct from streams, known size
@@ -2384,18 +2096,17 @@ fromStreamDNAs ps limit str = do
23842096 liftIO $ pokeAt ptr arrContents x
23852097 return $ INDEX_NEXT(ptr,a)
23862098
2387−-- | Use the 'createOf' fold instead.
2099+-- | Use the 'writeN' fold instead.
23882100--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2101+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
23902102--
23912103{-# INLINE_NORMAL fromStreamN #-}
23922104fromStreamN :: forall m a. (MonadIO m, Unbox a)
23932105 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2106+-- fromStreamDN n = D.fold (writeN n)
23952107fromStreamN = fromStreamDNAs Unpinned
23962108
23972109{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
23992110fromStreamDN :: forall m a. (MonadIO m, Unbox a)
24002111 => Int -> D.Stream m a -> m (MutArray a)
24012112fromStreamDN = fromStreamN
@@ -2418,20 +2129,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
24182129-- /Pre-release/
24192130{-# INLINE fromListRevN #-}
24202131fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2132+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24222133
24232134-- | Convert a pure stream in Identity monad to a mutable array.
24242135{-# INLINABLE fromPureStreamN #-}
24252136fromPureStreamN :: (MonadIO m, Unbox a) =>
24262137 Int -> Stream Identity a -> m (MutArray a)
24272138fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2139+ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
24292140
24302141-- | Convert a pure stream in Identity monad to a mutable array.
24312142{-# INLINABLE fromPureStream #-}
24322143fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
24332144fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2145+ D.fold write $ D.morphInner (return . runIdentity) xs
24352146
24362147{-# INLINABLE fromPtrN #-}
24372148fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2151,7 @@ fromPtrN len addr = do
24402151 -- XXX We can implement a stream copy in a similar way by streaming Word64
24412152 -- first and then remaining Word8.
24422153 arr <- new len
2443− _ <- unsafeAsPtr arr
2154+ _ <- asUnpinnedPtrUnsafe arr
24442155 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
24452156 return (arr {arrEnd = len})
24462157
@@ -2456,7 +2167,7 @@ fromByteStr# addr = do
24562167 len <- liftIO $ c_strlen (Ptr addr)
24572168 let lenInt = fromIntegral len
24582169 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2170+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
24602171 return (arr {arrEnd = lenInt})
24612172
24622173-------------------------------------------------------------------------------
@@ -2515,7 +2226,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
25152226fromChunksK = fromChunkskAs Unpinned
25162227
25172228{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
25192229fromArrayStreamK :: (Unbox a, MonadIO m) =>
25202230 StreamK m (MutArray a) -> m (MutArray a)
25212231fromArrayStreamK = fromChunksK
@@ -2527,7 +2237,7 @@ fromStreamDAs ps m =
25272237 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
25282238
25292239-- | 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
2240+-- single array from a stream of unknown size. 'writeN' is at least twice
25312241-- as efficient when the size is already known.
25322242--
25332243-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2249,19 @@ fromStreamDAs ps m =
25392249fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
25402250fromStream = fromStreamDAs Unpinned
25412251
2542−-- fromStream (Stream m) = P.fold create m
2252+-- fromStream (Stream m) = P.fold write m
25432253-- CAUTION: a very large number (millions) of arrays can degrade performance
25442254-- due to GC overhead because we need to buffer the arrays before we flatten
25452255-- all the arrays.
25462256--
2547−-- XXX Compare if this is faster or "fold create".
2257+-- XXX Compare if this is faster or "fold write".
25482258--
25492259-- | We could take the approach of doubling the memory allocation on each
25502260-- overflow. This would result in more or less the same amount of copying as in
25512261-- the chunking approach. However, if we have to shrink in the end then it may
25522262-- result in an extra copy of the entire data.
25532263--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2264+-- >>> fromStreamD = StreamD.fold MutArray.write
25552265--
25562266{-# INLINE fromStreamD #-}
25572267{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2291,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
25812291-- Cloning
25822292-------------------------------------------------------------------------------
25832293
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−
25882294{-# INLINE cloneAs #-}
25892295cloneAs ::
25902296 ( MonadIO m
@@ -2676,7 +2382,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762382 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772383spliceWith sizer dst@(MutArray _ start end bound) src = do
26782384{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2385+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802386 in D.fold f (toStreamD src)
26812387-}
26822388 assert (end <= bound) (return ())
@@ -2744,7 +2450,7 @@ splitOn predicate arr =
27442450{-# INLINE breakOn #-}
27452451breakOn :: MonadIO m
27462452 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2453+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
27482454 -- XXX We do not need memchr here, we can use a Haskell equivalent.
27492455 -- Need efficient stream based primitives that work on Word64.
27502456 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2473,33 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672473 }
27682474 )
27692475
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−
27922476-- | Create two slices of an array without copying the original array. The
27932477-- specified index @i@ is the first index of the second slice.
27942478--
27952479{-# INLINE splitAt #-}
27962480splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2481+splitAt i arr@MutArray{..} =
27982482 let maxIndex = length arr - 1
27992483 in if i < 0
28002484 then error "sliceAt: negative array index"
28012485 else if i > maxIndex
28022486 then error $ "sliceAt: specified array index " ++ show i
28032487 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2488+ else let off = i * SIZE_OF(a)
2489+ p = arrStart + off
2490+ in ( MutArray
2491+ { arrContents = arrContents
2492+ , arrStart = arrStart
2493+ , arrEnd = p
2494+ , arrBound = p
2495+ }
2496+ , MutArray
2497+ { arrContents = arrContents
2498+ , arrStart = p
2499+ , arrEnd = arrEnd
2500+ , arrBound = arrBound
2501+ }
2502+ )
28052503
28062504-------------------------------------------------------------------------------
28072505-- Casting
@@ -2851,13 +2549,9 @@ cast arr =
28512549-- guarantees that unsafe calls will be performed in the calling thread. Making
28522550-- it safe to pass heap-allocated objects to unsafe functions.
28532551
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2552+-- Should we just name it asPtr, the unsafety is implicit for any pointer
28552553-- operations. And we are safe from Haskell perspective because we will be
28562554-- 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.
28612555
28622556-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
28632557-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2569,16 @@ cast arr =
28752569--
28762570-- /Pre-release/
28772571--
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." #-}
28852572{-# INLINE asPtrUnsafe #-}
28862573asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2574+asPtrUnsafe arr f =
2575+ Unboxed.asPtrUnsafe
2576+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28882577
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2892− Unboxed.unsafeAsPtr
2578+{-# INLINE asUnpinnedPtrUnsafe #-}
2579+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2580+asUnpinnedPtrUnsafe arr f =
2581+ Unboxed.asUnpinnedPtrUnsafe
28932582 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28942583
28952584-------------------------------------------------------------------------------
@@ -2951,11 +2640,19 @@ byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
29512640-- can leave some memory unused. They can split the last array to fit it
29522641-- exactly in the space.
29532642
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2955−pCompactLeAs ::
2643+-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2644+-- only if the combined size would be less than or equal to @maxElems@
2645+-- elements. Note that it won't split an array if the original array is already
2646+-- larger than maxElems.
2647+--
2648+-- @maxElems@ must be greater than 0.
2649+--
2650+-- /Internal/
2651+{-# INLINE_NORMAL pCompactLE #-}
2652+pCompactLE ::
29562653 forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2654+ => Int -> Parser (MutArray a) m (MutArray a)
2655+pCompactLE maxElems = Parser step initial extract
29592656
29602657 where
29612658
@@ -2986,8 +2683,7 @@ pCompactLeAs ps maxElems = Parser step initial extract
29862683 else do
29872684 buf1 <-
29882685 if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2686+ then realloc maxBytes buf
29912687 else return buf
29922688 buf2 <- spliceUnsafe buf1 arr
29932689 return $ Parser.Partial 0 (Just buf2)
@@ -2995,30 +2691,6 @@ pCompactLeAs ps maxElems = Parser step initial extract
29952691 extract Nothing = return $ Parser.Done 0 nil
29962692 extract (Just buf) = return $ Parser.Done 0 buf
29972693
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−
30222694data SpliceState s arr
30232695 = SpliceInitial s
30242696 | SpliceBuffering s arr
@@ -3030,10 +2702,18 @@ data SpliceState s arr
30302702-- immutable array never has additional space so a new array is allocated
30312703-- instead of mutating it.
30322704
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) =
2705+-- | Scan @rCompactLE maxElems@ coalesces adjacent arrays in the input stream
2706+-- only if the combined size would be less than or equal to @maxElems@
2707+-- elements. Note that it won't split an array if the original array is already
2708+-- larger than maxElems.
2709+--
2710+-- @maxElems@ must be greater than 0.
2711+--
2712+-- /Internal/
2713+{-# INLINE_NORMAL rCompactLE #-}
2714+rCompactLE :: forall m a. (MonadIO m, Unbox a)
2715+ => Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
2716+rCompactLE maxElems (D.Stream step state) =
30372717 D.Stream step' (SpliceInitial state)
30382718
30392719 where
@@ -3069,8 +2749,7 @@ compactLeAs ps maxElems (D.Stream step state) =
30692749 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
30702750 else do
30712751 buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
2752+ then realloc maxBytes buf
30742753 else return buf
30752754 buf2 <- spliceUnsafe buf1 arr
30762755 return $ D.Skip (SpliceBuffering s buf2)
@@ -3081,12 +2760,14 @@ compactLeAs ps maxElems (D.Stream step state) =
30812760
30822761 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
30832762
3084−
3085−{-# INLINE_NORMAL fCompactGeAs #-}
3086−fCompactGeAs ::
2763+-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
2764+-- until the size becomes greater than or equal to @minElems@.
2765+--
2766+{-# INLINE_NORMAL fCompactGE #-}
2767+fCompactGE ::
30872768 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
2769+ => Int -> FL.Fold m (MutArray a) (MutArray a)
2770+fCompactGE minElems = Fold step initial extract extract
30902771
30912772 where
30922773
@@ -3114,8 +2795,7 @@ fCompactGeAs ps minElems = Fold step initial extract extract
31142795 let len = byteLength buf + byteLength arr
31152796 buf1 <-
31162797 if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
2798+ then realloc (max len minBytes) buf
31192799 else return buf
31202800 buf2 <- spliceUnsafe buf1 arr
31212801 if len >= minBytes
@@ -3125,30 +2805,15 @@ fCompactGeAs ps minElems = Fold step initial extract extract
31252805 extract Nothing = return nil
31262806 extract (Just buf) = return buf
31272807
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
2808+-- | Like 'compactGE' but for transforming folds instead of stream.
31302809--
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) =
2810+-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
2811+--
2812+{-# INLINE_NORMAL lCompactGE #-}
2813+lCompactGE :: forall m a. (MonadIO m, Unbox a)
2814+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
2815+-- lCompactGE n = Fold.many (fCompactGE n)
2816+lCompactGE minElems (Fold step1 initial1 _ final1) =
31522817 Fold step initial extract final
31532818
31542819 where
@@ -3186,8 +2851,7 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
31862851 step (Tuple' (Just buf) r1) arr = do
31872852 let len = byteLength buf + byteLength arr
31882853 buf1 <- if byteCapacity buf < len
3189− then liftIO $ reallocExplicitAs
3190− ps (SIZE_OF(a)) (max minBytes len) buf
2854+ then realloc (max minBytes len) buf
31912855 else return buf
31922856 buf2 <- spliceUnsafe buf1 arr
31932857 runInner len r1 buf2
@@ -3207,23 +2871,6 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
32072871 FL.Partial rr -> final1 rr
32082872 FL.Done _ -> return ()
32092873
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−
32272874-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
32282875-- the size becomes greater than or equal to @n@.
32292876--