@@ -40,22 +40,22 @@ module Streamly.Internal.Data.MutArray.Type
41 -- ** Casting
41 -- ** Casting
43− , castUnsafe -- XXX unsafeCast
43+ , castUnsafe
45− , unsafePinnedAsPtr
45+ , asPtrUnsafe
46− , unsafeAsPtr
46+ , asUnpinnedPtrUnsafe
48 -- ** Construction
48 -- ** Construction
51 -- *** New
51 -- *** New
52 -- | New arrays are always empty arrays with some reserve capacity to
52 -- | New arrays are always empty arrays with some reserve capacity to
53 -- extend the length without reallocating.
53 -- extend the length without reallocating.
55− , newArrayWith -- emptyAlignedWith
55+ , newArrayWith
56− , pinnedEmptyOf
56+ , pinnedNew
57− , pinnedNewAligned -- XXX not required
58+ , pinnedNewAligned
58− -- , new -- uninitialized array of specified length
60 -- *** Cloning
60 -- *** Cloning
@@ -63,25 +63,27 @@ module Streamly.Internal.Data.MutArray.Type
64 -- *** Slicing
64 -- *** Slicing
65 -- | Get a subarray without copying
65 -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
66+ , getSliceUnsafe
67 , getSlice
67 , getSlice
68 , splitAt -- XXX should be able to express using getSlice
68 , splitAt -- XXX should be able to express using getSlice
71 -- *** Stream Folds
71 -- *** Stream Folds
72 , ArrayUnsafe (..)
72 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
73+ , writeNWithUnsafe
74− , unsafeCreateOf
74+ , writeNWith
75− , unsafePinnedCreateOf
75+ , writeNUnsafe
76− , pinnedCreateOf
76+ , pinnedWriteNUnsafe
77− , createOfWith
77+ , writeN
78− , createOf
78+ , pinnedWriteN
79− , revCreateOf
79+ , pinnedWriteNAligned
81− , pinnedCreate
81+ , writeWith
82− , createWith
82+ , write
83− , create
83+ , pinnedWrite
86 -- *** From containers
88 -- *** From containers
87 , fromListN
89 , fromListN
@@ -97,11 +99,11 @@ module Streamly.Internal.Data.MutArray.Type
97 , fromByteStr#
99 , fromByteStr#
98 , fromPtrN
100 , fromPtrN
99 , fromChunksK
101 , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
102+ , fromChunksRealloced
102 -- ** Random writes
104 -- ** Random writes
103 , putIndex
105 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
106+ , putIndexUnsafe
105 , putIndices
107 , putIndices
106 -- , putFromThenTo
108 -- , putFromThenTo
107 -- , putFrom -- start writing at the given position
109 -- , putFrom -- start writing at the given position
@@ -109,7 +111,7 @@ module Streamly.Internal.Data.MutArray.Type
109 -- , putFromTo
111 -- , putFromTo
110 -- , putFromRev
112 -- , putFromRev
111 -- , putUptoRev
113 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
114+ , modifyIndexUnsafe
113 , modifyIndex
115 , modifyIndex
114 , modifyIndices
116 , modifyIndices
@@ -120,9 +122,9 @@ module Streamly.Internal.Data.MutArray.Type
121 -- *** Indexing
123 -- *** Indexing
122 , getIndex
124 , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
125+ , getIndexUnsafe
124 -- , getFromThenTo
126 -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
127+ , getIndexRev
126 , indexReader
128 , indexReader
127 , indexReaderWith
129 , indexReaderWith
@@ -193,34 +195,24 @@ module Streamly.Internal.Data.MutArray.Type
194 , snocLinear
196 , snocLinear
195 , snocMay
197 , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
198+ , snocUnsafe
198 -- *** Appending streams
200 -- *** Appending streams
199− , unsafeAppendN
201+ , writeAppendNUnsafe
200− , appendN
202+ , writeAppendN
201− , appendWith
203+ , writeAppendWith
202− , append
204+ , writeAppend
204 -- *** Appending arrays
206 -- *** Appending arrays
205 , spliceCopy
207 , spliceCopy
206 , spliceWith
208 , spliceWith
208 , spliceExp
210 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
211+ , spliceUnsafe
210 -- , putSlice
212 -- , putSlice
211 -- , appendSlice
213 -- , appendSlice
212 -- , appendSliceFrom
214 -- , appendSliceFrom
214− -- ** Serialization using Unbox
217− , pokeSkipUnsafe -- unsafePokeSkip
219− -- ** Deserialization using Unbox
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
224 -- Arrays of arrays
216 -- Arrays of arrays
225 -- We can add dimensionality parameter to the array type to get
217 -- We can add dimensionality parameter to the array type to get
226 -- multidimensional arrays. Multidimensional arrays would just be a
218 -- multidimensional arrays. Multidimensional arrays would just be a
@@ -242,8 +234,6 @@ module Streamly.Internal.Data.MutArray.Type
243 -- *** Concat
235 -- *** Concat
244 -- | Append the arrays in a stream to form a stream of elements.
236 -- | Append the arrays in a stream to form a stream of elements.
248 , concatRev
238 , concatRev
@@ -251,12 +241,9 @@ module Streamly.Internal.Data.MutArray.Type
251 -- | Append the arrays in a stream to form a stream of larger arrays.
241 -- | Append the arrays in a stream to form a stream of larger arrays.
252 , SpliceState (..)
242 , SpliceState (..)
253 , pCompactLE
243 , pCompactLE
254− , pPinnedCompactLE
244+ , rCompactLE
256 , fCompactGE
245 , fCompactGE
258 , lCompactGE
246 , lCompactGE
260 , compactGE
247 , compactGE
261 , compactEQ
248 , compactEQ
@@ -267,7 +254,6 @@ module Streamly.Internal.Data.MutArray.Type
267 , c_memchr
254 , c_memchr
269 -- * Deprecated
256 -- * Deprecated
271 , writeChunks
257 , writeChunks
272 , flattenArrays
258 , flattenArrays
273 , flattenArraysRev
259 , flattenArraysRev
@@ -279,25 +265,6 @@ module Streamly.Internal.Data.MutArray.Type
279 , getIndicesWith
265 , getIndicesWith
281 , resizeExp
267 , resizeExp
286− , writeAppendNUnsafe
293− , pinnedWriteNUnsafe
296− , pinnedWriteNAligned -- XXX not required
@@ -479,8 +446,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
446-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480-- allocatePinned in GHC source.
447-- allocatePinned in GHC source.
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
484-- | @newArrayWith allocator alignment count@ allocates a new array of zero
449-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485-- length and with a capacity to hold @count@ elements, using @allocator
450-- length and with a capacity to hold @count@ elements, using @allocator
486-- size alignment@ as the memory allocator function.
451-- size alignment@ as the memory allocator function.
@@ -504,25 +469,12 @@ newArrayWith alloc alignSize count = do
504 , arrBound = size
469 , arrBound = size
507−-- For arrays "nil" sounds a bit odd. empty is better. The only problem with
508−-- empty is that it is also used by the Alternative type class. But assuming we
509−-- will mostly import the Array module qualified this should be fine.
511−-- | Create an empty array.
517−empty = MutArray Unboxed.empty 0 0 0
519−{-# DEPRECATED nil "Please use empty instead." #-}
521#ifdef DEVBUILD
473#ifdef DEVBUILD
522 Unbox a =>
474 Unbox a =>
524 MutArray a
476 MutArray a
525−nil = empty
477+nil = MutArray Unboxed.nil 0 0 0
527{-# INLINE newBytesAs #-}
479{-# INLINE newBytesAs #-}
528newBytesAs :: MonadIO m =>
480newBytesAs :: MonadIO m =>
@@ -539,13 +491,12 @@ newBytesAs ps bytes = do
539 , arrBound = bytes
491 , arrBound = bytes
542−-- | Allocates a pinned empty array that with a reserved capacity of bytes.
494+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
543−-- The memory of the array is uninitialized and the allocation is aligned as
495+-- the array is uninitialized and the allocation is aligned as per the
544−-- per the 'Unboxed' instance of the type.
496+-- 'Unboxed' instance of the type.
546-- /Pre-release/
498-- /Pre-release/
547{-# INLINE pinnedNewBytes #-}
499{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549pinnedNewBytes :: MonadIO m =>
500pinnedNewBytes :: MonadIO m =>
550#ifdef DEVBUILD
501#ifdef DEVBUILD
551 Unbox a =>
502 Unbox a =>
@@ -570,31 +521,21 @@ newAs ps =
570 (error "new: alignment is not used in unpinned arrays.")
521 (error "new: alignment is not used in unpinned arrays.")
572-- XXX can unaligned allocation be more efficient when alignment is not needed?
523-- XXX can unaligned allocation be more efficient when alignment is not needed?
574−-- | Allocates a pinned array of zero length but growable to the specified
525+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
575−-- capacity without reallocation.
526+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
576−{-# INLINE pinnedEmptyOf #-}
527+-- instance of the type.
577−pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
528+--
578−pinnedEmptyOf = newAs Pinned
580−-- XXX Deprecate in major
581−-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
582{-# INLINE pinnedNew #-}
529{-# INLINE pinnedNew #-}
583pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
530pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
531+pinnedNew = newAs Pinned
586−-- | Allocates an unpinned array of zero length but growable to the specified
533+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
587−-- capacity without reallocation.
534+-- of the array is uninitialized.
589−{-# INLINE emptyOf #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
593−-- XXX Deprecate in major
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
595{-# INLINE new #-}
536{-# INLINE new #-}
596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
537new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
538+new = newAs Unpinned
599-------------------------------------------------------------------------------
540-------------------------------------------------------------------------------
600-- Random writes
541-- Random writes
@@ -842,15 +783,15 @@ roundDownTo elemSize size = size - (size `mod` elemSize)
842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
783-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843-- which complicates some inspection tests.
784-- which complicates some inspection tests.
845−{-# NOINLINE reallocExplicitAs #-}
786+{-# NOINLINE reallocExplicit #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
787+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
788+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848 assertM(arrEnd <= arrBound)
789 assertM(arrEnd <= arrBound)
850 -- Allocate new array
791 -- Allocate new array
851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
792 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852 contents <-
793 contents <-
853− if ps == Pinned
794+ if Unboxed.isPinned arrContents
854 then Unboxed.pinnedNew newCapMaxInBytes
795 then Unboxed.pinnedNew newCapMaxInBytes
855 else Unboxed.new newCapMaxInBytes
796 else Unboxed.new newCapMaxInBytes
856 let !(MutByteArray mbarrFrom#) = arrContents
797 let !(MutByteArray mbarrFrom#) = arrContents
@@ -890,12 +831,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890-- If the original array is pinned, the newly allocated array is also pinned.
831-- If the original array is pinned, the newly allocated array is also pinned.
891{-# INLINABLE realloc #-}
832{-# INLINABLE realloc #-}
892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
833realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
834+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
836-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901-- in error messages and the capSizer is used to determine the capacity of the
837-- in error messages and the capSizer is used to determine the capacity of the
@@ -944,7 +880,6 @@ grow nElems arr@MutArray{..} = do
944 else realloc req arr
880 else realloc req arr
946{-# DEPRECATED resize "Please use grow instead." #-}
882{-# DEPRECATED resize "Please use grow instead." #-}
947−{-# INLINE resize #-}
948resize :: forall m a. (MonadIO m, Unbox a) =>
883resize :: forall m a. (MonadIO m, Unbox a) =>
949 Int -> MutArray a -> m (MutArray a)
884 Int -> MutArray a -> m (MutArray a)
950resize = grow
885resize = grow
@@ -968,7 +903,6 @@ growExp nElems arr@MutArray{..} = do
968 else realloc req1 arr
903 else realloc req1 arr
970{-# DEPRECATED resizeExp "Please use growExp instead." #-}
905{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971−{-# INLINE resizeExp #-}
972resizeExp :: forall m a. (MonadIO m, Unbox a) =>
906resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973 Int -> MutArray a -> m (MutArray a)
907 Int -> MutArray a -> m (MutArray a)
974resizeExp = growExp
908resizeExp = growExp
@@ -1117,126 +1051,6 @@ snoc = snocWith f
1117 then oldSize * 2
1051 then oldSize * 2
1118 else roundUpToPower2 oldSize * 2
1052 else roundUpToPower2 oldSize * 2
1120−-------------------------------------------------------------------------------
1121−-- Serialization/Deserialization
1122−-------------------------------------------------------------------------------
1124−{-# INLINE pokeNewEnd #-}
1125−pokeNewEnd :: (MonadIO m, Unbox a) =>
1126− Int -> MutArray Word8 -> a -> m (MutArray Word8)
1127−pokeNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1128− assert (newEnd <= arrBound) (return ())
1129− liftIO $ pokeAt arrEnd arrContents x
1130− return $ arr {arrEnd = newEnd}
1132−-- | Really really unsafe, unboxes a Haskell type and appends the resulting
1133−-- bytes to the byte array, may cause silent data corruption or if you are
1134−-- lucky a segfault if the array does not have enough space to append the
1138−{-# INLINE pokeAppendUnsafe #-}
1139−pokeAppendUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1140− MutArray Word8 -> a -> m (MutArray Word8)
1141−pokeAppendUnsafe arr@MutArray{..} = pokeNewEnd (arrEnd + SIZE_OF(a)) arr
1143−-- | Skip the specified number of bytes in the array. The data in the skipped
1144−-- region remains uninitialzed.
1145−{-# INLINE pokeSkipUnsafe #-}
1146−pokeSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1147−pokeSkipUnsafe n arr@MutArray{..} = do
1148− let newEnd = arrEnd + n
1149− in assert (newEnd <= arrBound) (arr {arrEnd = newEnd})
1151−-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152−-- capacity becomes full.
1155−{-# INLINE pokeAppendMay #-}
1156−pokeAppendMay :: forall m a. (MonadIO m, Unbox a) =>
1157− MutArray Word8 -> a -> m (Maybe (MutArray Word8))
1158−pokeAppendMay arr@MutArray{..} x = liftIO $ do
1159− let newEnd = arrEnd + SIZE_OF(a)
1160− if newEnd <= arrBound
1161− then Just <$> pokeNewEnd newEnd arr x
1162− else return Nothing
1164−{-# NOINLINE pokeWithRealloc #-}
1165−pokeWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1169− -> m (MutArray Word8)
1170−pokeWithRealloc sizer arr x = do
1171− arr1 <- liftIO $ reallocWith "pokeWithRealloc" sizer (SIZE_OF(a)) arr
1172− pokeAppendUnsafe arr1 x
1174−{-# INLINE pokeAppendWith #-}
1175−pokeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1179− -> m (MutArray Word8)
1180−pokeAppendWith allocSize arr x = liftIO $ do
1181− let newEnd = arrEnd arr + SIZE_OF(a)
1182− if newEnd <= arrBound arr
1183− then pokeNewEnd newEnd arr x
1184− else pokeWithRealloc allocSize arr x
1186−-- | Unbox a Haskell type and append the resulting bytes to a mutable byte
1187−-- array. The array is grown exponentially when more space is needed.
1191−-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1193−{-# INLINE pokeAppend #-}
1194−pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195− MutArray Word8 -> a -> m (MutArray Word8)
1196−pokeAppend = pokeAppendWith f
1201− if isPower2 oldSize
1203− else roundUpToPower2 oldSize * 2
1205−-- | Really really unsafe, create a Haskell value from an unboxed byte array,
1206−-- does not check if the array is big enough, may return garbage or if you are
1207−-- lucky may cause a segfault.
1210−{-# INLINE peekUnconsUnsafe #-}
1211−peekUnconsUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1212− MutArray Word8 -> m (a, MutArray Word8)
1213−peekUnconsUnsafe MutArray{..} = do
1214− let start1 = arrStart + SIZE_OF(a)
1215− assert (start1 <= arrEnd) (return ())
1217− r <- peekAt arrStart arrContents
1218− return (r, MutArray arrContents start1 arrEnd arrBound)
1220−-- | Discard the specified number of bytes in the array.
1221−{-# INLINE peekSkipUnsafe #-}
1222−peekSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1223−peekSkipUnsafe n MutArray{..} =
1224− let start1 = arrStart + n
1225− in assert (start1 <= arrEnd) (MutArray arrContents start1 arrEnd arrBound)
1227−-- | Create a Haskell value from its unboxed representation from the head of a
1228−-- byte array, return the value and the remaining array.
1229−{-# INLINE peekUncons #-}
1230−peekUncons :: forall m a. (MonadIO m, Unbox a) =>
1231− MutArray Word8 -> m (Maybe a, MutArray Word8)
1232−peekUncons arr@MutArray{..} = do
1233− let start1 = arrStart + SIZE_OF(a)
1235− then return (Nothing, arr)
1237− r <- peekAt arrStart arrContents
1238− return (Just r, MutArray arrContents start1 arrEnd arrBound)
1240-------------------------------------------------------------------------------
1054-------------------------------------------------------------------------------
1241-- Random reads
1055-- Random reads
1242-------------------------------------------------------------------------------
1056-------------------------------------------------------------------------------
@@ -1302,7 +1116,6 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1302 D.Stop -> return D.Stop
1116 D.Stop -> return D.Stop
1304{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1118{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305−{-# INLINE getIndicesWith #-}
1306getIndicesWith :: (Monad m, Unbox a) =>
1119getIndicesWith :: (Monad m, Unbox a) =>
1307 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1120 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1308getIndicesWith = indexReaderWith
1121getIndicesWith = indexReaderWith
@@ -1318,7 +1131,6 @@ indexReader = indexReaderWith liftIO
1319-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1132-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1133{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1321−{-# INLINE getIndices #-}
1322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1134getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323getIndices = indexReader
1135getIndices = indexReader
@@ -1615,7 +1427,7 @@ chunksOfAs ps n (D.Stream step state) =
1616-- Same as the following but may be more efficient:
1428-- Same as the following but may be more efficient:
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1430+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
1620-- /Pre-release/
1432-- /Pre-release/
1621{-# INLINE_NORMAL chunksOf #-}
1433{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1436,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
1624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1436-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1625-- benchmark. It seems it has difficulty producing optimized code when
1437-- benchmark. It seems it has difficulty producing optimized code when
1626-- converting to StreamK. Investigate GHC optimizations.
1438-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1439+-- chunksOf n = D.foldMany (writeN n)
1628chunksOf = chunksOfAs Unpinned
1440chunksOf = chunksOfAs Unpinned
1630-- | Like 'chunksOf' but creates pinned arrays.
1442-- | Like 'chunksOf' but creates pinned arrays.
1631{-# INLINE_NORMAL pinnedChunksOf #-}
1443{-# INLINE_NORMAL pinnedChunksOf #-}
1632pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1444pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1633 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1445 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1446+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
1635pinnedChunksOf = chunksOfAs Pinned
1447pinnedChunksOf = chunksOfAs Pinned
1637-- | When we are buffering a stream of unknown size into an array we do not
1449-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1476,16 @@ data FlattenState s contents a =
1664 OuterLoop s
1476 OuterLoop s
1665 | InnerLoop s contents !Int !Int
1477 | InnerLoop s contents !Int !Int
1479+-- | Use the "reader" unfold instead.
1481+-- @concat = unfoldMany reader@
1483+-- We can try this if there are any fusion issues in the unfold.
1667−{-# INLINE_NORMAL concatWith #-}
1485+{-# INLINE_NORMAL concat #-}
1668−concatWith :: forall m a. (Monad m, Unbox a)
1486+concat :: forall m a. (MonadIO m, Unbox a)
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1487+ => D.Stream m (MutArray a) -> D.Stream m a
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1488+concat (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1684,30 +1502,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1684 return $ D.Skip $ OuterLoop st
1502 return $ D.Skip $ OuterLoop st
1686 step' _ (InnerLoop st contents p end) = do
1504 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1505+ x <- liftIO $ peekAt p contents
1688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1506 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1690−-- | Use the "reader" unfold instead.
1692−-- @concat = unfoldMany reader@
1694−-- We can try this if there are any fusion issues in the unfold.
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
1701{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1508{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703flattenArrays :: forall m a. (MonadIO m, Unbox a)
1509flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704 => D.Stream m (MutArray a) -> D.Stream m a
1510 => D.Stream m (MutArray a) -> D.Stream m a
1705flattenArrays = concat
1511flattenArrays = concat
1513+-- | Use the "readerRev" unfold instead.
1515+-- @concat = unfoldMany readerRev@
1517+-- We can try this if there are any fusion issues in the unfold.
1707−{-# INLINE_NORMAL concatRevWith #-}
1519+{-# INLINE_NORMAL concatRev #-}
1708−concatRevWith :: forall m a. (Monad m, Unbox a)
1520+concatRev :: forall m a. (MonadIO m, Unbox a)
1709− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1521+ => D.Stream m (MutArray a) -> D.Stream m a
1710−concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1522+concatRev (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1725,23 +1537,11 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1725 return $ D.Skip $ OuterLoop st
1537 return $ D.Skip $ OuterLoop st
1727 step' _ (InnerLoop st contents p start) = do
1539 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1540+ x <- liftIO $ peekAt p contents
1729 let cur = INDEX_PREV(p,a)
1541 let cur = INDEX_PREV(p,a)
1730 return $ D.Yield x (InnerLoop st contents cur start)
1542 return $ D.Yield x (InnerLoop st contents cur start)
1732−-- | Use the "readerRev" unfold instead.
1734−-- @concat = unfoldMany readerRev@
1736−-- We can try this if there are any fusion issues in the unfold.
1738−{-# INLINE_NORMAL concatRev #-}
1739−concatRev :: forall m a. (MonadIO m, Unbox a)
1740− => D.Stream m (MutArray a) -> D.Stream m a
1741−concatRev = concatRevWith liftIO
1743{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1544{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
1745flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1545flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1746 => D.Stream m (MutArray a) -> D.Stream m a
1546 => D.Stream m (MutArray a) -> D.Stream m a
1747flattenArraysRev = concatRev
1547flattenArraysRev = concatRev
@@ -1973,7 +1773,7 @@ foldr f z arr = D.foldr f z $ read arr
1974-- XXX Keep the bound intact to not lose any free space? Perf impact?
1774-- XXX Keep the bound intact to not lose any free space? Perf impact?
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1776+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
1977-- array.
1777-- array.
1979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
1779-- 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
1982-- Any free space left in the array after appending @n@ elements is lost.
1782-- Any free space left in the array after appending @n@ elements is lost.
1984-- /Internal/
1784-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1785+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1786+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1988 -> m (MutArray a)
1788 -> m (MutArray a)
1989 -> Fold m a (MutArray a)
1789 -> Fold m a (MutArray a)
1790+writeAppendNUnsafe n action =
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1791+ fmap fromArrayUnsafe $ FL.foldlM' step initial
@@ -2000,7 +1801,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2000 -- otherwise we lose that space.
1801 -- otherwise we lose that space.
2002 if free < needed
1803 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1804+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2004 else return arr
1805 else return arr
2005 return $ toArrayUnsafe arr1
1806 return $ toArrayUnsafe arr1
@@ -2008,51 +1809,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2008 liftIO $ pokeAt end contents x
1809 liftIO $ pokeAt end contents x
2009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1810 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2011−{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012−{-# INLINE writeAppendNUnsafe #-}
2013−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2016− -> Fold m a (MutArray a)
2017−writeAppendNUnsafe = unsafeAppendN
2019-- | Append @n@ elements to an existing array. Any free space left in the array
1812-- | Append @n@ elements to an existing array. Any free space left in the array
2020-- after appending @n@ elements is lost.
1813-- after appending @n@ elements is lost.
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1815+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2024−{-# INLINE_NORMAL appendN #-}
1817+{-# INLINE_NORMAL writeAppendN #-}
2025−appendN :: forall m a. (MonadIO m, Unbox a) =>
2026− Int -> m (MutArray a) -> Fold m a (MutArray a)
2027−appendN n initial = FL.take n (unsafeAppendN n initial)
2029−-- XXX Deprecate in major
2030−-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031−{-# INLINE writeAppendN #-}
2032writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1818writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
2033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1819 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1820+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1822+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2037-- append the input stream. If there is no reserved space available in the
1823-- append the input stream. If there is no reserved space available in the
2038-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
1824-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
2039-- where @oldSize@ is the current size of the array in bytes.
1825-- where @oldSize@ is the current size of the array in bytes.
2041-- Note that the returned array may be a mutated version of original array.
1827-- Note that the returned array may be a mutated version of original array.
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1829+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2045-- /Pre-release/
1831-- /Pre-release/
2046−{-# INLINE appendWith #-}
2047−appendWith :: forall m a. (MonadIO m, Unbox a) =>
2048− (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2049−appendWith sizer = FL.foldlM' (snocWith sizer)
2051−{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
2052{-# INLINE writeAppendWith #-}
1832{-# INLINE writeAppendWith #-}
2053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1833writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
2054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1834 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1835+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2057-- | @append action@ mutates the array generated by @action@ to append the
1837-- | @append action@ mutates the array generated by @action@ to append the
2058-- input stream. If there is no reserved space available in the array it is
1838-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1840,26 @@ writeAppendWith = appendWith
2061-- Note that the returned array may be a mutated version of original array.
1841-- Note that the returned array may be a mutated version of original array.
2063−-- >>> append = MutArray.appendWith (* 2)
1843+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
2065−{-# INLINE append #-}
2066−append :: forall m a. (MonadIO m, Unbox a) =>
2067− m (MutArray a) -> Fold m a (MutArray a)
2068−append = appendWith (* 2)
2070−-- XXX Deprecate in major
2071−-- {-# DEPRECATED writeAppend "Please use append instead." #-}
2072{-# INLINE writeAppend #-}
1845{-# INLINE writeAppend #-}
2073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
1846writeAppend :: forall m a. (MonadIO m, Unbox a) =>
2074 m (MutArray a) -> Fold m a (MutArray a)
1847 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1848+writeAppend = writeAppendWith (* 2)
2077-- XXX We can carry bound as well in the state to make sure we do not lose the
1850-- XXX We can carry bound as well in the state to make sure we do not lose the
2078-- remaining capacity. Need to check perf impact.
1851-- remaining capacity. Need to check perf impact.
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
1853+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
2081−-- function as argument.
1854+-- as argument.
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1856+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2085-- /Pre-release/
1858-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
1859+{-# INLINE_NORMAL writeNWithUnsafe #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1860+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1861 => (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
@@ -2097,64 +1870,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1871 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2100−{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101−{-# INLINE writeNWithUnsafe #-}
2102−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104−writeNWithUnsafe = unsafeCreateOfWith
2106{-# INLINE_NORMAL writeNUnsafeAs #-}
1873{-# INLINE_NORMAL writeNUnsafeAs #-}
2107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
1874writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
2108 => PinnedState -> Int -> Fold m a (MutArray a)
1875 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1876+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
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
2112-- driver must not call the step function more than 'n' times otherwise it will
1879-- driver must not call the step function more than 'n' times otherwise it will
2113-- corrupt the memory and crash. This function exists mainly because any
1880-- corrupt the memory and crash. This function exists mainly because any
2114-- conditional in the step function blocks fusion causing 10x performance
1881-- conditional in the step function blocks fusion causing 10x performance
2115-- slowdown.
1882-- slowdown.
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1884+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
2119−{-# INLINE_NORMAL unsafeCreateOf #-}
2120−unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121− => Int -> Fold m a (MutArray a)
2122−unsafeCreateOf = writeNUnsafeAs Unpinned
2124−{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
2125−{-# INLINE writeNUnsafe #-}
1886+{-# INLINE_NORMAL writeNUnsafe #-}
2126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
1887writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
2127 => Int -> Fold m a (MutArray a)
1888 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1889+writeNUnsafe = writeNUnsafeAs Unpinned
2130−-- | Like 'unsafeCreateOf' but creates a pinned array.
1891+-- | Like 'writeNUnsafe' but creates a pinned array.
2131−{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132−unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133− => Int -> Fold m a (MutArray a)
2134−unsafePinnedCreateOf = writeNUnsafeAs Pinned
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137−{-# INLINE pinnedWriteNUnsafe #-}
1892+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
2138pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
1893pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
2139 => Int -> Fold m a (MutArray a)
1894 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1895+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
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
2143-- allocated using the @alloc@ function.
1898-- allocated using the @alloc@ function.
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
1900+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1901+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2148−{-# INLINE_NORMAL createOfWith #-}
1903+{-# INLINE_NORMAL writeNWith #-}
2149−createOfWith :: forall m a. (MonadIO m, Unbox a)
2150− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151−createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2153−-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154−{-# INLINE writeNWith #-}
2155writeNWith :: forall m a. (MonadIO m, Unbox a)
1904writeNWith :: forall m a. (MonadIO m, Unbox a)
2156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1905 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1906+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2159{-# INLINE_NORMAL writeNAs #-}
1908{-# INLINE_NORMAL writeNAs #-}
2160writeNAs ::
1909writeNAs ::
@@ -2162,42 +1911,28 @@ writeNAs ::
2162 => PinnedState
1911 => PinnedState
2164 -> Fold m a (MutArray a)
1913 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1914+writeNAs ps = writeNWith (newAs ps)
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
2168-- 'MutArray'.
1917-- 'MutArray'.
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
1919+-- >>> writeN = MutArray.writeNWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
1920+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1921+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2174−{-# INLINE_NORMAL createOf #-}
1923+{-# INLINE_NORMAL writeN #-}
2175−createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176−createOf = writeNAs Unpinned
2178−-- XXX Deprecate in major
2179−-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180−{-# INLINE writeN #-}
2181writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1924writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1925+writeN = writeNAs Unpinned
2184−-- | Like 'createOf' but creates a pinned array.
1927+-- | Like 'writeN' but creates a pinned array.
2185−{-# INLINE_NORMAL pinnedCreateOf #-}
2187− forall m a. (MonadIO m, Unbox a)
2189− -> Fold m a (MutArray a)
2190−pinnedCreateOf = writeNAs Pinned
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
1928+{-# INLINE_NORMAL pinnedWriteN #-}
2194pinnedWriteN ::
1929pinnedWriteN ::
2195 forall m a. (MonadIO m, Unbox a)
1930 forall m a. (MonadIO m, Unbox a)
2197 -> Fold m a (MutArray a)
1932 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1933+pinnedWriteN = writeNAs Pinned
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1935+-- | Like writeNWithUnsafe but writes the array in reverse order.
2202-- /Internal/
1937-- /Internal/
2203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
1938{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1953,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2219 $ ArrayUnsafe contents ptr end
1954 $ ArrayUnsafe contents ptr end
2221−-- | Like createOfWith but writes the array in reverse order.
1956+-- | Like writeNWith but writes the array in reverse order.
2223-- /Internal/
1958-- /Internal/
2224{-# INLINE_NORMAL writeRevNWith #-}
1959{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1961,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
2226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1961 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
1962writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
2229−-- | Like 'createOf' but writes the array in reverse order.
1964+-- | Like writeN but writes the array in reverse order.
2231-- /Pre-release/
1966-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
1967+{-# INLINE_NORMAL writeRevN #-}
2233−revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234−revCreateOf = writeRevNWith new
2236−{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237−{-# INLINE writeRevN #-}
2238writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1968writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1969+writeRevN = writeRevNWith new
2241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
1971-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
2242-- input stream to a 'MutArray' aligned to the given size.
1972-- input stream to a 'MutArray' aligned to the given size.
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
1974+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1975+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
2247-- /Pre-release/
1977-- /Pre-release/
2249{-# INLINE_NORMAL pinnedWriteNAligned #-}
1979{-# INLINE_NORMAL pinnedWriteNAligned #-}
2250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1980pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
2251 => Int -> Int -> Fold m a (MutArray a)
1981 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1982+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
2254-- XXX Buffer to a list instead?
1984-- XXX Buffer to a list instead?
2256-- | Buffer a stream into a stream of arrays.
1986-- | Buffer a stream into a stream of arrays.
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1988+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2260-- Breaking an array into an array stream can be useful to consume a large
1990-- Breaking an array into an array stream can be useful to consume a large
2261-- array sequentially such that memory of the array is released incrementatlly.
1991-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1997,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
2267{-# INLINE_NORMAL buildChunks #-}
1997{-# INLINE_NORMAL buildChunks #-}
2268buildChunks :: (MonadIO m, Unbox a) =>
1998buildChunks :: (MonadIO m, Unbox a) =>
2269 Int -> Fold m a (StreamK n (MutArray a))
1999 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
2272{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2002{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
2274writeChunks :: (MonadIO m, Unbox a) =>
2003writeChunks :: (MonadIO m, Unbox a) =>
2275 Int -> Fold m a (StreamK n (MutArray a))
2004 Int -> Fold m a (StreamK n (MutArray a))
2276writeChunks = buildChunks
2005writeChunks = buildChunks
@@ -2278,29 +2007,29 @@ writeChunks = buildChunks
2278{-# INLINE_NORMAL writeWithAs #-}
2007{-# INLINE_NORMAL writeWithAs #-}
2279writeWithAs :: forall m a. (MonadIO m, Unbox a)
2008writeWithAs :: forall m a. (MonadIO m, Unbox a)
2280 => PinnedState -> Int -> Fold m a (MutArray a)
2009 => 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)
2282writeWithAs ps elemCount =
2011writeWithAs ps elemCount =
2283 FL.rmapM extract $ FL.foldlM' step initial
2012 FL.rmapM extract $ FL.foldlM' step initial
2287 initial = do
2016 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2017+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
2289 newAs ps elemCount
2018 newAs ps elemCount
2291 step arr@(MutArray _ start end bound) x
2020 step arr@(MutArray _ start end bound) x
2292 | INDEX_NEXT(end,a) > bound = do
2021 | INDEX_NEXT(end,a) > bound = do
2293 let oldSize = end - start
2022 let oldSize = end - start
2294 newSize = max (oldSize * 2) 1
2023 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
2024+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
2296 snocUnsafe arr1 x
2025 snocUnsafe arr1 x
2297 step arr x = snocUnsafe arr x
2026 step arr x = snocUnsafe arr x
2299 extract = liftIO . rightSize
2028 extract = liftIO . rightSize
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
2030+-- XXX Compare writeWith with fromStreamD which uses an array of streams
2302-- implementation. We can write this using buildChunks above if that is faster.
2031-- 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
2304-- fromStreamD.
2033-- fromStreamD.
2306-- XXX The realloc based implementation needs to make one extra copy if we use
2035-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +2044,39 @@ writeWithAs ps elemCount =
2315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2044-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2316-- malloc to compare against.
2045-- malloc to compare against.
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
2319-- starts at a size big enough to hold minCount elements, the size is doubled
2048-- starts at a size big enough to hold minCount elements, the size is doubled
2320-- every time the array needs to be grown.
2049-- every time the array needs to be grown.
2322-- /Caution! Do not use this on infinite streams./
2051-- /Caution! Do not use this on infinite streams./
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
2053+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
2054+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2055+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2328-- /Pre-release/
2057-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
2058+{-# INLINE_NORMAL writeWith #-}
2330−createWith :: forall m a. (MonadIO m, Unbox a)
2331− => Int -> Fold m a (MutArray a)
2332−-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333−createWith = writeWithAs Unpinned
2335−{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336−{-# INLINE writeWith #-}
2337writeWith :: forall m a. (MonadIO m, Unbox a)
2059writeWith :: forall m a. (MonadIO m, Unbox a)
2338 => Int -> Fold m a (MutArray a)
2060 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2061+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2062+writeWith = writeWithAs Unpinned
2341-- | Fold the whole input to a single array.
2064-- | Fold the whole input to a single array.
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2066+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2344-- rounded up to the element size.
2067-- rounded up to the element size.
2346-- /Caution! Do not use this on infinite streams./
2069-- /Caution! Do not use this on infinite streams./
2348−{-# INLINE create #-}
2349−create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350−create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2352−-- XXX Deprecate in major
2353−-- {-# DEPRECATED write "Please use create instead." #-}
2354{-# INLINE write #-}
2071{-# INLINE write #-}
2355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2072write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2358−-- | Like 'create' but creates a pinned array.
2359−{-# INLINE pinnedCreate #-}
2360−pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2362− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2073+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
2075+-- | Like 'write' but creates a pinned array.
2365{-# INLINE pinnedWrite #-}
2076{-# INLINE pinnedWrite #-}
2366pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2077pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2078+pinnedWrite =
2079+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2369-------------------------------------------------------------------------------
2081-------------------------------------------------------------------------------
2370-- construct from streams, known size
2082-- construct from streams, known size
@@ -2384,18 +2096,17 @@ fromStreamDNAs ps limit str = do
2384 liftIO $ pokeAt ptr arrContents x
2096 liftIO $ pokeAt ptr arrContents x
2385 return $ INDEX_NEXT(ptr,a)
2097 return $ INDEX_NEXT(ptr,a)
2387−-- | Use the 'createOf' fold instead.
2099+-- | Use the 'writeN' fold instead.
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2101+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
2391{-# INLINE_NORMAL fromStreamN #-}
2103{-# INLINE_NORMAL fromStreamN #-}
2392fromStreamN :: forall m a. (MonadIO m, Unbox a)
2104fromStreamN :: forall m a. (MonadIO m, Unbox a)
2393 => Int -> D.Stream m a -> m (MutArray a)
2105 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2106+-- fromStreamDN n = D.fold (writeN n)
2395fromStreamN = fromStreamDNAs Unpinned
2107fromStreamN = fromStreamDNAs Unpinned
2397{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2109{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
2399fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2110fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2400 => Int -> D.Stream m a -> m (MutArray a)
2111 => Int -> D.Stream m a -> m (MutArray a)
2401fromStreamDN = fromStreamN
2112fromStreamDN = fromStreamN
@@ -2418,20 +2129,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
2418-- /Pre-release/
2129-- /Pre-release/
2419{-# INLINE fromListRevN #-}
2130{-# INLINE fromListRevN #-}
2420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2131fromListRevN :: (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
2423-- | Convert a pure stream in Identity monad to a mutable array.
2134-- | Convert a pure stream in Identity monad to a mutable array.
2424{-# INLINABLE fromPureStreamN #-}
2135{-# INLINABLE fromPureStreamN #-}
2425fromPureStreamN :: (MonadIO m, Unbox a) =>
2136fromPureStreamN :: (MonadIO m, Unbox a) =>
2426 Int -> Stream Identity a -> m (MutArray a)
2137 Int -> Stream Identity a -> m (MutArray a)
2427fromPureStreamN n xs =
2138fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2139+ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
2430-- | Convert a pure stream in Identity monad to a mutable array.
2141-- | Convert a pure stream in Identity monad to a mutable array.
2431{-# INLINABLE fromPureStream #-}
2142{-# INLINABLE fromPureStream #-}
2432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2143fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2433fromPureStream xs =
2144fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2145+ D.fold write $ D.morphInner (return . runIdentity) xs
2436{-# INLINABLE fromPtrN #-}
2147{-# INLINABLE fromPtrN #-}
2437fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
2148fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2151,7 @@ fromPtrN len addr = do
2440 -- XXX We can implement a stream copy in a similar way by streaming Word64
2151 -- XXX We can implement a stream copy in a similar way by streaming Word64
2441 -- first and then remaining Word8.
2152 -- first and then remaining Word8.
2442 arr <- new len
2153 arr <- new len
2443− _ <- unsafeAsPtr arr
2154+ _ <- asUnpinnedPtrUnsafe arr
2444 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2155 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2445 return (arr {arrEnd = len})
2156 return (arr {arrEnd = len})
@@ -2456,7 +2167,7 @@ fromByteStr# addr = do
2456 len <- liftIO $ c_strlen (Ptr addr)
2167 len <- liftIO $ c_strlen (Ptr addr)
2457 let lenInt = fromIntegral len
2168 let lenInt = fromIntegral len
2458 arr <- new lenInt
2169 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)
2460 return (arr {arrEnd = lenInt})
2171 return (arr {arrEnd = lenInt})
2462-------------------------------------------------------------------------------
2173-------------------------------------------------------------------------------
@@ -2515,7 +2226,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
2515fromChunksK = fromChunkskAs Unpinned
2226fromChunksK = fromChunkskAs Unpinned
2517{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2228{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
2519fromArrayStreamK :: (Unbox a, MonadIO m) =>
2229fromArrayStreamK :: (Unbox a, MonadIO m) =>
2520 StreamK m (MutArray a) -> m (MutArray a)
2230 StreamK m (MutArray a) -> m (MutArray a)
2521fromArrayStreamK = fromChunksK
2231fromArrayStreamK = fromChunksK
@@ -2527,7 +2237,7 @@ fromStreamDAs ps m =
2527 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2237 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2529-- | Create an 'Array' from a stream. This is useful when we want to create a
2239-- | 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
2531-- as efficient when the size is already known.
2241-- as efficient when the size is already known.
2533-- Note that if the input stream is too large memory allocation for the array
2243-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2249,19 @@ fromStreamDAs ps m =
2539fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2249fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540fromStream = fromStreamDAs Unpinned
2250fromStream = fromStreamDAs Unpinned
2542−-- fromStream (Stream m) = P.fold create m
2252+-- fromStream (Stream m) = P.fold write m
2543-- CAUTION: a very large number (millions) of arrays can degrade performance
2253-- CAUTION: a very large number (millions) of arrays can degrade performance
2544-- due to GC overhead because we need to buffer the arrays before we flatten
2254-- due to GC overhead because we need to buffer the arrays before we flatten
2545-- all the arrays.
2255-- all the arrays.
2547−-- XXX Compare if this is faster or "fold create".
2257+-- XXX Compare if this is faster or "fold write".
2549-- | We could take the approach of doubling the memory allocation on each
2259-- | We could take the approach of doubling the memory allocation on each
2550-- overflow. This would result in more or less the same amount of copying as in
2260-- overflow. This would result in more or less the same amount of copying as in
2551-- the chunking approach. However, if we have to shrink in the end then it may
2261-- the chunking approach. However, if we have to shrink in the end then it may
2552-- result in an extra copy of the entire data.
2262-- result in an extra copy of the entire data.
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2264+-- >>> fromStreamD = StreamD.fold MutArray.write
2556{-# INLINE fromStreamD #-}
2266{-# INLINE fromStreamD #-}
2557{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
2267{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2291,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
2581-- Cloning
2291-- Cloning
2582-------------------------------------------------------------------------------
2292-------------------------------------------------------------------------------
2584−-- Arrays are aligned on 64-bit boundaries. The fastest way to copy an array is
2585−-- to unsafeCast it to Word64, read it, write it to Word64 array and unsafeCast
2586−-- it again. We can use SIMD read/write as well.
2588{-# INLINE cloneAs #-}
2294{-# INLINE cloneAs #-}
2589cloneAs ::
2295cloneAs ::
2590 ( MonadIO m
2296 ( MonadIO m
@@ -2676,7 +2382,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
2676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2382 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2677spliceWith sizer dst@(MutArray _ start end bound) src = do
2383spliceWith sizer dst@(MutArray _ start end bound) src = do
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2385+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
2680 in D.fold f (toStreamD src)
2386 in D.fold f (toStreamD src)
2682 assert (end <= bound) (return ())
2388 assert (end <= bound) (return ())
@@ -2744,7 +2450,7 @@ splitOn predicate arr =
2744{-# INLINE breakOn #-}
2450{-# INLINE breakOn #-}
2745breakOn :: MonadIO m
2451breakOn :: MonadIO m
2746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2452 => 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
2748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2454 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749 -- Need efficient stream based primitives that work on Word64.
2455 -- Need efficient stream based primitives that work on Word64.
2750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2456 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2473,33 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2770−-- | Like 'splitAt' but does not check whether the index is valid.
2772−{-# INLINE unsafeSplitAt #-}
2773−unsafeSplitAt :: forall a. Unbox a =>
2774− Int -> MutArray a -> (MutArray a, MutArray a)
2775−unsafeSplitAt i MutArray{..} =
2776− let off = i * SIZE_OF(a)
2779− { arrContents = arrContents
2780− , arrStart = arrStart
2785− { arrContents = arrContents
2788− , arrBound = arrBound
2792-- | Create two slices of an array without copying the original array. The
2476-- | Create two slices of an array without copying the original array. The
2793-- specified index @i@ is the first index of the second slice.
2477-- specified index @i@ is the first index of the second slice.
2795{-# INLINE splitAt #-}
2479{-# INLINE splitAt #-}
2796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2480splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2481+splitAt i arr@MutArray{..} =
2798 let maxIndex = length arr - 1
2482 let maxIndex = length arr - 1
2799 in if i < 0
2483 in if i < 0
2800 then error "sliceAt: negative array index"
2484 then error "sliceAt: negative array index"
2801 else if i > maxIndex
2485 else if i > maxIndex
2802 then error $ "sliceAt: specified array index " ++ show i
2486 then error $ "sliceAt: specified array index " ++ show i
2803 ++ " is beyond the maximum index " ++ show maxIndex
2487 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2488+ else let off = i * SIZE_OF(a)
2491+ { arrContents = arrContents
2492+ , arrStart = arrStart
2497+ { arrContents = arrContents
2500+ , arrBound = arrBound
2806-------------------------------------------------------------------------------
2504-------------------------------------------------------------------------------
2807-- Casting
2505-- Casting
@@ -2851,13 +2549,9 @@ cast arr =
2851-- guarantees that unsafe calls will be performed in the calling thread. Making
2549-- guarantees that unsafe calls will be performed in the calling thread. Making
2852-- it safe to pass heap-allocated objects to unsafe functions.
2550-- it safe to pass heap-allocated objects to unsafe functions.
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2552+-- Should we just name it asPtr, the unsafety is implicit for any pointer
2855-- operations. And we are safe from Haskell perspective because we will be
2553-- operations. And we are safe from Haskell perspective because we will be
2856-- pinning the memory.
2554-- pinning the memory.
2858−-- XXX we cannot pass the length of the ptr here as in some cases it may not be
2859−-- available e.g. a null terminated C string. However, we can create another
2860−-- flavor of the API e.g. asPtrN.
2862-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2556-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2863-- array as a pointer to some operating system call or to a "safe" FFI call.
2557-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2569,16 @@ cast arr =
2876-- /Pre-release/
2570-- /Pre-release/
2878−{-# INLINE unsafePinnedAsPtr #-}
2879−unsafePinnedAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2880−unsafePinnedAsPtr arr f =
2881− Unboxed.unsafePinnedAsPtr
2882− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2884−{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
2885{-# INLINE asPtrUnsafe #-}
2572{-# INLINE asPtrUnsafe #-}
2886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2573asPtrUnsafe :: 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))
2889−{-# INLINE unsafeAsPtr #-}
2578+{-# INLINE asUnpinnedPtrUnsafe #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2579+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2580+asUnpinnedPtrUnsafe arr f =
2892− Unboxed.unsafeAsPtr
2581+ Unboxed.asUnpinnedPtrUnsafe
2893 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2582 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2895-------------------------------------------------------------------------------
2584-------------------------------------------------------------------------------
@@ -2951,11 +2640,19 @@ byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2951-- can leave some memory unused. They can split the last array to fit it
2640-- can leave some memory unused. They can split the last array to fit it
2952-- exactly in the space.
2641-- exactly in the space.
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.
2648+-- @maxElems@ must be greater than 0.
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2651+{-# INLINE_NORMAL pCompactLE #-}
2955−pCompactLeAs ::
2652+pCompactLE ::
2956 forall m a. (MonadIO m, Unbox a)
2653 forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2654+ => Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2655+pCompactLE maxElems = Parser step initial extract
@@ -2986,8 +2683,7 @@ pCompactLeAs ps maxElems = Parser step initial extract
2988 if byteCapacity buf < maxBytes
2685 if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2686+ then realloc maxBytes buf
2991 else return buf
2687 else return buf
2992 buf2 <- spliceUnsafe buf1 arr
2688 buf2 <- spliceUnsafe buf1 arr
2993 return $ Parser.Partial 0 (Just buf2)
2689 return $ Parser.Partial 0 (Just buf2)
@@ -2995,30 +2691,6 @@ pCompactLeAs ps maxElems = Parser step initial extract
2995 extract Nothing = return $ Parser.Done 0 nil
2691 extract Nothing = return $ Parser.Done 0 nil
2996 extract (Just buf) = return $ Parser.Done 0 buf
2692 extract (Just buf) = return $ Parser.Done 0 buf
2998−-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2999−-- only if the combined size would be less than or equal to @maxElems@
3000−-- elements. Note that it won't split an array if the original array is already
3001−-- larger than maxElems.
3003−-- @maxElems@ must be greater than 0.
3005−-- Generates unpinned arrays irrespective of the pinning status of input
3009−{-# INLINE pCompactLE #-}
3011− forall m a. (MonadIO m, Unbox a)
3012− => Int -> Parser (MutArray a) m (MutArray a)
3013−pCompactLE = pCompactLeAs Unpinned
3015−-- | Pinned version of 'pCompactLE'.
3016−{-# INLINE pPinnedCompactLE #-}
3018− forall m a. (MonadIO m, Unbox a)
3019− => Int -> Parser (MutArray a) m (MutArray a)
3020−pPinnedCompactLE = pCompactLeAs Pinned
3022data SpliceState s arr
2694data SpliceState s arr
3023 = SpliceInitial s
2695 = SpliceInitial s
3024 | SpliceBuffering s arr
2696 | SpliceBuffering s arr
@@ -3030,10 +2702,18 @@ data SpliceState s arr
3030-- immutable array never has additional space so a new array is allocated
2702-- immutable array never has additional space so a new array is allocated
3031-- instead of mutating it.
2703-- instead of mutating it.
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.
2710+-- @maxElems@ must be greater than 0.
3033−{-# INLINE_NORMAL compactLeAs #-}
2713+{-# INLINE_NORMAL rCompactLE #-}
3034−compactLeAs :: forall m a. (MonadIO m, Unbox a)
2714+rCompactLE :: forall m a. (MonadIO m, Unbox a)
3035− => PinnedState -> Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
2715+ => Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
3036−compactLeAs ps maxElems (D.Stream step state) =
2716+rCompactLE maxElems (D.Stream step state) =
3037 D.Stream step' (SpliceInitial state)
2717 D.Stream step' (SpliceInitial state)
@@ -3069,8 +2749,7 @@ compactLeAs ps maxElems (D.Stream step state) =
3069 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
2749 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3071 buf1 <- if byteCapacity buf < maxBytes
2751 buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
2752+ then realloc maxBytes buf
3074 else return buf
2753 else return buf
3075 buf2 <- spliceUnsafe buf1 arr
2754 buf2 <- spliceUnsafe buf1 arr
3076 return $ D.Skip (SpliceBuffering s buf2)
2755 return $ D.Skip (SpliceBuffering s buf2)
@@ -3081,12 +2760,14 @@ compactLeAs ps maxElems (D.Stream step state) =
3082 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
2761 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3084−
2763+-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
2764+-- until the size becomes greater than or equal to @minElems@.
3085−{-# INLINE_NORMAL fCompactGeAs #-}
2766+{-# INLINE_NORMAL fCompactGE #-}
3086−fCompactGeAs ::
2767+fCompactGE ::
3087 forall m a. (MonadIO m, Unbox a)
2768 forall m a. (MonadIO m, Unbox a)
3088− => PinnedState -> Int -> FL.Fold m (MutArray a) (MutArray a)
2769+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3089−fCompactGeAs ps minElems = Fold step initial extract extract
2770+fCompactGE minElems = Fold step initial extract extract
@@ -3114,8 +2795,7 @@ fCompactGeAs ps minElems = Fold step initial extract extract
3114 let len = byteLength buf + byteLength arr
2795 let len = byteLength buf + byteLength arr
3116 if byteCapacity buf < len
2797 if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
2798+ then realloc (max len minBytes) buf
3119 else return buf
2799 else return buf
3120 buf2 <- spliceUnsafe buf1 arr
2800 buf2 <- spliceUnsafe buf1 arr
3121 if len >= minBytes
2801 if len >= minBytes
@@ -3125,30 +2805,15 @@ fCompactGeAs ps minElems = Fold step initial extract extract
3125 extract Nothing = return nil
2805 extract Nothing = return nil
3126 extract (Just buf) = return buf
2806 extract (Just buf) = return buf
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
2808+-- | Like 'compactGE' but for transforming folds instead of stream.
3129−-- until the size becomes greater than or equal to @minElems@.
3131−-- Generates unpinned arrays irrespective of the pinning status of input
2810+-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3133−{-# INLINE fCompactGE #-}
3135− forall m a. (MonadIO m, Unbox a)
3136− => Int -> FL.Fold m (MutArray a) (MutArray a)
3137−fCompactGE = fCompactGeAs Unpinned
3139−-- | Pinned version of 'fCompactGE'.
3140−{-# INLINE fPinnedCompactGE #-}
3142− forall m a. (MonadIO m, Unbox a)
3143− => Int -> FL.Fold m (MutArray a) (MutArray a)
3144−fPinnedCompactGE = fCompactGeAs Pinned
3146−{-# INLINE_NORMAL lCompactGeAs #-}
2812+{-# INLINE_NORMAL lCompactGE #-}
3147−lCompactGeAs :: forall m a. (MonadIO m, Unbox a)
2813+lCompactGE :: forall m a. (MonadIO m, Unbox a)
3148− => PinnedState -> Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
2814+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3149−-- The fold version turns out to be a little bit slower.
2815+-- lCompactGE n = Fold.many (fCompactGE n)
3150−-- lCompactGeAs ps n = FL.many (fCompactGeAs ps n)
3151−lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
2816+lCompactGE minElems (Fold step1 initial1 _ final1) =
3152 Fold step initial extract final
2817 Fold step initial extract final
@@ -3186,8 +2851,7 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
3186 step (Tuple' (Just buf) r1) arr = do
2851 step (Tuple' (Just buf) r1) arr = do
3187 let len = byteLength buf + byteLength arr
2852 let len = byteLength buf + byteLength arr
3188 buf1 <- if byteCapacity buf < len
2853 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
3191 else return buf
2855 else return buf
3192 buf2 <- spliceUnsafe buf1 arr
2856 buf2 <- spliceUnsafe buf1 arr
3193 runInner len r1 buf2
2857 runInner len r1 buf2
@@ -3207,23 +2871,6 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
3207 FL.Partial rr -> final1 rr
2871 FL.Partial rr -> final1 rr
3208 FL.Done _ -> return ()
2872 FL.Done _ -> return ()
3210−-- | Like 'compactGE' but for transforming folds instead of stream.
3212−-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3214−-- Generates unpinned arrays irrespective of the pinning status of input
3216−{-# INLINE lCompactGE #-}
3217−lCompactGE :: forall m a. (MonadIO m, Unbox a)
3218− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3219−lCompactGE = lCompactGeAs Unpinned
3221−-- | Pinned version of 'lCompactGE'.
3222−{-# INLINE lPinnedCompactGE #-}
3223−lPinnedCompactGE :: forall m a. (MonadIO m, Unbox a)
3224− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3225−lPinnedCompactGE = lCompactGeAs Pinned
3227-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
2874-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228-- the size becomes greater than or equal to @n@.
2875-- the size becomes greater than or equal to @n@.