@@ -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
@@ -162,9 +164,9 @@ module Streamly.Internal.Data.MutArray.Type
162 , blockSize
164 , blockSize
163 , arrayChunkBytes
165 , arrayChunkBytes
164 , allocBytesToElemCount
166 , allocBytesToElemCount
165− , realloc -- this is "resize"
167+ , realloc
167− , growExp
169+ , resizeExp
168 , rightSize
170 , rightSize
170 -- ** Folding
172 -- ** Folding
@@ -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
@@ -277,27 +263,6 @@ module Streamly.Internal.Data.MutArray.Type
278 , getIndices
264 , getIndices
279 , getIndicesWith
265 , getIndicesWith
286− , writeAppendNUnsafe
293− , pinnedWriteNUnsafe
296− , pinnedWriteNAligned -- XXX not required
@@ -479,8 +444,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
444-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480-- allocatePinned in GHC source.
445-- 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
447-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485-- length and with a capacity to hold @count@ elements, using @allocator
448-- length and with a capacity to hold @count@ elements, using @allocator
486-- size alignment@ as the memory allocator function.
449-- size alignment@ as the memory allocator function.
@@ -504,25 +467,12 @@ newArrayWith alloc alignSize count = do
504 , arrBound = size
467 , 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
471#ifdef DEVBUILD
522 Unbox a =>
472 Unbox a =>
524 MutArray a
474 MutArray a
525−nil = empty
475+nil = MutArray Unboxed.nil 0 0 0
527{-# INLINE newBytesAs #-}
477{-# INLINE newBytesAs #-}
528newBytesAs :: MonadIO m =>
478newBytesAs :: MonadIO m =>
@@ -539,13 +489,12 @@ newBytesAs ps bytes = do
539 , arrBound = bytes
489 , arrBound = bytes
542−-- | Allocates a pinned empty array that with a reserved capacity of bytes.
492+-- | 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
493+-- the array is uninitialized and the allocation is aligned as per the
544−-- per the 'Unboxed' instance of the type.
494+-- 'Unboxed' instance of the type.
546-- /Pre-release/
496-- /Pre-release/
547{-# INLINE pinnedNewBytes #-}
497{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549pinnedNewBytes :: MonadIO m =>
498pinnedNewBytes :: MonadIO m =>
550#ifdef DEVBUILD
499#ifdef DEVBUILD
551 Unbox a =>
500 Unbox a =>
@@ -570,31 +519,21 @@ newAs ps =
570 (error "new: alignment is not used in unpinned arrays.")
519 (error "new: alignment is not used in unpinned arrays.")
572-- XXX can unaligned allocation be more efficient when alignment is not needed?
521-- 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
523+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
575−-- capacity without reallocation.
524+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
576−{-# INLINE pinnedEmptyOf #-}
525+-- instance of the type.
577−pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
526+--
578−pinnedEmptyOf = newAs Pinned
580−-- XXX Deprecate in major
581−-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
582{-# INLINE pinnedNew #-}
527{-# INLINE pinnedNew #-}
583pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
528pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
529+pinnedNew = newAs Pinned
586−-- | Allocates an unpinned array of zero length but growable to the specified
531+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
587−-- capacity without reallocation.
532+-- 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 #-}
534{-# INLINE new #-}
596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
535new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
536+new = newAs Unpinned
599-------------------------------------------------------------------------------
538-------------------------------------------------------------------------------
600-- Random writes
539-- Random writes
@@ -842,15 +781,15 @@ roundDownTo elemSize size = size - (size `mod` elemSize)
842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
781-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843-- which complicates some inspection tests.
782-- which complicates some inspection tests.
845−{-# NOINLINE reallocExplicitAs #-}
784+{-# NOINLINE reallocExplicit #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
785+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
786+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848 assertM(arrEnd <= arrBound)
787 assertM(arrEnd <= arrBound)
850 -- Allocate new array
789 -- Allocate new array
851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
790 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852 contents <-
791 contents <-
853− if ps == Pinned
792+ if Unboxed.isPinned arrContents
854 then Unboxed.pinnedNew newCapMaxInBytes
793 then Unboxed.pinnedNew newCapMaxInBytes
855 else Unboxed.new newCapMaxInBytes
794 else Unboxed.new newCapMaxInBytes
856 let !(MutByteArray mbarrFrom#) = arrContents
795 let !(MutByteArray mbarrFrom#) = arrContents
@@ -890,12 +829,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890-- If the original array is pinned, the newly allocated array is also pinned.
829-- If the original array is pinned, the newly allocated array is also pinned.
891{-# INLINABLE realloc #-}
830{-# INLINABLE realloc #-}
892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
831realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
832+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
834-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901-- in error messages and the capSizer is used to determine the capacity of the
835-- in error messages and the capSizer is used to determine the capacity of the
@@ -925,7 +859,9 @@ reallocWith label capSizer minIncrBytes arr = do
925 , ". Please check the sizing function passed."
859 , ". Please check the sizing function passed."
862+-- XXX should be called expand/extend because it never shortens the array.
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
864+-- | @resize newCapacity array@ changes the total capacity of the array so that
929-- it is enough to hold the specified number of elements. Nothing is done if
865-- it is enough to hold the specified number of elements. Nothing is done if
930-- the specified capacity is less than the length of the array.
866-- the specified capacity is less than the length of the array.
@@ -933,46 +869,36 @@ reallocWith label capSizer minIncrBytes arr = do
933-- the block size (4K).
869-- the block size (4K).
935-- /Pre-release/
871-- /Pre-release/
936−{-# INLINE grow #-}
872+{-# INLINE resize #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
873+resize :: forall m a. (MonadIO m, Unbox a) =>
938 Int -> MutArray a -> m (MutArray a)
874 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
875+resize nElems arr@MutArray{..} = do
940 let req = SIZE_OF(a) * nElems
876 let req = SIZE_OF(a) * nElems
877+ -- XXX Should use arrBound
941− cap = arrBound - arrStart
878+ len = arrEnd - arrStart
942− if req < cap
879+ if req < len
943 then return arr
880 then return arr
944 else realloc req arr
881 else realloc req arr
946−{-# DEPRECATED resize "Please use grow instead." #-}
947−{-# INLINE resize #-}
948−resize :: forall m a. (MonadIO m, Unbox a) =>
949− Int -> MutArray a -> m (MutArray a)
952−-- | Like 'grow' but if the requested byte capacity is more than
883+-- | Like 'resize' but if the requested byte capacity is more than
953-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
884-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
955-- /Pre-release/
886-- /Pre-release/
956−{-# INLINE growExp #-}
887+{-# INLINE resizeExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
888+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958 Int -> MutArray a -> m (MutArray a)
889 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
890+resizeExp nElems arr@MutArray{..} = do
960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
891 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
962 if req > largeObjectThreshold
893 if req > largeObjectThreshold
963 then roundUpToPower2 req
894 then roundUpToPower2 req
896+ -- XXX Should use arrBound
965− cap = arrBound - arrStart
897+ len = arrEnd - arrStart
966− if req1 < cap
898+ if req1 < len
967 then return arr
899 then return arr
968 else realloc req1 arr
900 else realloc req1 arr
970−{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971−{-# INLINE resizeExp #-}
972−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973− Int -> MutArray a -> m (MutArray a)
976-- | Resize the allocated memory to drop any reserved free space at the end of
902-- | Resize the allocated memory to drop any reserved free space at the end of
977-- the array and reallocate it to reduce wastage.
903-- the array and reallocate it to reduce wastage.
@@ -1117,126 +1043,6 @@ snoc = snocWith f
1117 then oldSize * 2
1043 then oldSize * 2
1118 else roundUpToPower2 oldSize * 2
1044 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-------------------------------------------------------------------------------
1046-------------------------------------------------------------------------------
1241-- Random reads
1047-- Random reads
1242-------------------------------------------------------------------------------
1048-------------------------------------------------------------------------------
@@ -1302,7 +1108,6 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1302 D.Stop -> return D.Stop
1108 D.Stop -> return D.Stop
1304{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1110{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305−{-# INLINE getIndicesWith #-}
1306getIndicesWith :: (Monad m, Unbox a) =>
1111getIndicesWith :: (Monad m, Unbox a) =>
1307 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1112 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1308getIndicesWith = indexReaderWith
1113getIndicesWith = indexReaderWith
@@ -1318,7 +1123,6 @@ indexReader = indexReaderWith liftIO
1319-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1124-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1125{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1321−{-# INLINE getIndices #-}
1322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1126getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323getIndices = indexReader
1127getIndices = indexReader
@@ -1615,7 +1419,7 @@ chunksOfAs ps n (D.Stream step state) =
1616-- Same as the following but may be more efficient:
1420-- Same as the following but may be more efficient:
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1422+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
1620-- /Pre-release/
1424-- /Pre-release/
1621{-# INLINE_NORMAL chunksOf #-}
1425{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1428,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
1624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1428-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1625-- benchmark. It seems it has difficulty producing optimized code when
1429-- benchmark. It seems it has difficulty producing optimized code when
1626-- converting to StreamK. Investigate GHC optimizations.
1430-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1431+-- chunksOf n = D.foldMany (writeN n)
1628chunksOf = chunksOfAs Unpinned
1432chunksOf = chunksOfAs Unpinned
1630-- | Like 'chunksOf' but creates pinned arrays.
1434-- | Like 'chunksOf' but creates pinned arrays.
1631{-# INLINE_NORMAL pinnedChunksOf #-}
1435{-# INLINE_NORMAL pinnedChunksOf #-}
1632pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1436pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1633 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1437 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1438+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
1635pinnedChunksOf = chunksOfAs Pinned
1439pinnedChunksOf = chunksOfAs Pinned
1637-- | When we are buffering a stream of unknown size into an array we do not
1441-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1468,16 @@ data FlattenState s contents a =
1664 OuterLoop s
1468 OuterLoop s
1665 | InnerLoop s contents !Int !Int
1469 | InnerLoop s contents !Int !Int
1471+-- | Use the "reader" unfold instead.
1473+-- @concat = unfoldMany reader@
1475+-- We can try this if there are any fusion issues in the unfold.
1667−{-# INLINE_NORMAL concatWith #-}
1477+{-# INLINE_NORMAL concat #-}
1668−concatWith :: forall m a. (Monad m, Unbox a)
1478+concat :: forall m a. (MonadIO m, Unbox a)
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1479+ => D.Stream m (MutArray a) -> D.Stream m a
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1480+concat (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1684,30 +1494,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1684 return $ D.Skip $ OuterLoop st
1494 return $ D.Skip $ OuterLoop st
1686 step' _ (InnerLoop st contents p end) = do
1496 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1497+ x <- liftIO $ peekAt p contents
1688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1498 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." #-}
1500{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703flattenArrays :: forall m a. (MonadIO m, Unbox a)
1501flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704 => D.Stream m (MutArray a) -> D.Stream m a
1502 => D.Stream m (MutArray a) -> D.Stream m a
1705flattenArrays = concat
1503flattenArrays = concat
1505+-- | Use the "readerRev" unfold instead.
1507+-- @concat = unfoldMany readerRev@
1509+-- We can try this if there are any fusion issues in the unfold.
1707−{-# INLINE_NORMAL concatRevWith #-}
1511+{-# INLINE_NORMAL concatRev #-}
1708−concatRevWith :: forall m a. (Monad m, Unbox a)
1512+concatRev :: forall m a. (MonadIO m, Unbox a)
1709− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1513+ => D.Stream m (MutArray a) -> D.Stream m a
1710−concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1514+concatRev (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1725,23 +1529,11 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1725 return $ D.Skip $ OuterLoop st
1529 return $ D.Skip $ OuterLoop st
1727 step' _ (InnerLoop st contents p start) = do
1531 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1532+ x <- liftIO $ peekAt p contents
1729 let cur = INDEX_PREV(p,a)
1533 let cur = INDEX_PREV(p,a)
1730 return $ D.Yield x (InnerLoop st contents cur start)
1534 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." #-}
1536{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
1745flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1537flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1746 => D.Stream m (MutArray a) -> D.Stream m a
1538 => D.Stream m (MutArray a) -> D.Stream m a
1747flattenArraysRev = concatRev
1539flattenArraysRev = concatRev
@@ -1973,7 +1765,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?
1766-- 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
1768+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
1977-- array.
1769-- array.
1979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
1771-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1774,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.
1774-- Any free space left in the array after appending @n@ elements is lost.
1984-- /Internal/
1776-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1777+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1778+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1988 -> m (MutArray a)
1780 -> m (MutArray a)
1989 -> Fold m a (MutArray a)
1781 -> Fold m a (MutArray a)
1782+writeAppendNUnsafe n action =
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1783+ fmap fromArrayUnsafe $ FL.foldlM' step initial
@@ -2000,7 +1793,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2000 -- otherwise we lose that space.
1793 -- otherwise we lose that space.
2002 if free < needed
1795 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1796+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2004 else return arr
1797 else return arr
2005 return $ toArrayUnsafe arr1
1798 return $ toArrayUnsafe arr1
@@ -2008,51 +1801,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
2008 liftIO $ pokeAt end contents x
1801 liftIO $ pokeAt end contents x
2009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1802 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
1804-- | Append @n@ elements to an existing array. Any free space left in the array
2020-- after appending @n@ elements is lost.
1805-- after appending @n@ elements is lost.
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1807+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2024−{-# INLINE_NORMAL appendN #-}
1809+{-# 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) =>
1810writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
2033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1811 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1812+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1814+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2037-- append the input stream. If there is no reserved space available in the
1815-- 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@,
1816-- 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.
1817-- 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.
1819-- Note that the returned array may be a mutated version of original array.
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1821+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2045-- /Pre-release/
1823-- /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 #-}
1824{-# INLINE writeAppendWith #-}
2053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1825writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
2054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1826 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1827+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2057-- | @append action@ mutates the array generated by @action@ to append the
1829-- | @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
1830-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1832,26 @@ writeAppendWith = appendWith
2061-- Note that the returned array may be a mutated version of original array.
1833-- Note that the returned array may be a mutated version of original array.
2063−-- >>> append = MutArray.appendWith (* 2)
1835+-- >>> 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 #-}
1837{-# INLINE writeAppend #-}
2073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
1838writeAppend :: forall m a. (MonadIO m, Unbox a) =>
2074 m (MutArray a) -> Fold m a (MutArray a)
1839 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1840+writeAppend = writeAppendWith (* 2)
2077-- XXX We can carry bound as well in the state to make sure we do not lose the
1842-- 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.
1843-- remaining capacity. Need to check perf impact.
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
1845+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
2081−-- function as argument.
1846+-- as argument.
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1848+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2085-- /Pre-release/
1850-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
1851+{-# INLINE_NORMAL writeNWithUnsafe #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1852+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1853 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1854+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
@@ -2097,64 +1862,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
1863 $ 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 #-}
1865{-# INLINE_NORMAL writeNUnsafeAs #-}
2107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
1866writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
2108 => PinnedState -> Int -> Fold m a (MutArray a)
1867 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1868+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1870+-- | 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
1871-- 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
1872-- corrupt the memory and crash. This function exists mainly because any
2114-- conditional in the step function blocks fusion causing 10x performance
1873-- conditional in the step function blocks fusion causing 10x performance
2115-- slowdown.
1874-- slowdown.
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1876+-- >>> 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 #-}
1878+{-# INLINE_NORMAL writeNUnsafe #-}
2126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
1879writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
2127 => Int -> Fold m a (MutArray a)
1880 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1881+writeNUnsafe = writeNUnsafeAs Unpinned
2130−-- | Like 'unsafeCreateOf' but creates a pinned array.
2131−{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132−unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133− => Int -> Fold m a (MutArray a)
2134−unsafePinnedCreateOf = writeNUnsafeAs Pinned
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
1883+-- | Like 'writeNUnsafe' but creates a pinned array.
2137−{-# INLINE pinnedWriteNUnsafe #-}
1884+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
2138pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
1885pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
2139 => Int -> Fold m a (MutArray a)
1886 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1887+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1889+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
2143-- allocated using the @alloc@ function.
1890-- allocated using the @alloc@ function.
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
1892+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1893+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2148−{-# INLINE_NORMAL createOfWith #-}
1895+{-# 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)
1896writeNWith :: forall m a. (MonadIO m, Unbox a)
2156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1897 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1898+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2159{-# INLINE_NORMAL writeNAs #-}
1900{-# INLINE_NORMAL writeNAs #-}
2160writeNAs ::
1901writeNAs ::
@@ -2162,42 +1903,28 @@ writeNAs ::
2162 => PinnedState
1903 => PinnedState
2164 -> Fold m a (MutArray a)
1905 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1906+writeNAs ps = writeNWith (newAs ps)
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1908+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
2168-- 'MutArray'.
1909-- 'MutArray'.
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
1911+-- >>> writeN = MutArray.writeNWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
1912+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1913+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2174−{-# INLINE_NORMAL createOf #-}
1915+{-# 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)
1916writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1917+writeN = writeNAs Unpinned
2184−-- | Like 'createOf' but creates a pinned array.
1919+-- | 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 #-}
1920+{-# INLINE_NORMAL pinnedWriteN #-}
2194pinnedWriteN ::
1921pinnedWriteN ::
2195 forall m a. (MonadIO m, Unbox a)
1922 forall m a. (MonadIO m, Unbox a)
2197 -> Fold m a (MutArray a)
1924 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1925+pinnedWriteN = writeNAs Pinned
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1927+-- | Like writeNWithUnsafe but writes the array in reverse order.
2202-- /Internal/
1929-- /Internal/
2203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
1930{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1945,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2219 $ ArrayUnsafe contents ptr end
1946 $ ArrayUnsafe contents ptr end
2221−-- | Like createOfWith but writes the array in reverse order.
1948+-- | Like writeNWith but writes the array in reverse order.
2223-- /Internal/
1950-- /Internal/
2224{-# INLINE_NORMAL writeRevNWith #-}
1951{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1953,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
2226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1953 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
1954writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
2229−-- | Like 'createOf' but writes the array in reverse order.
1956+-- | Like writeN but writes the array in reverse order.
2231-- /Pre-release/
1958-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
1959+{-# 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)
1960writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1961+writeRevN = writeRevNWith new
2241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
1963-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
2242-- input stream to a 'MutArray' aligned to the given size.
1964-- input stream to a 'MutArray' aligned to the given size.
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
1966+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1967+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
2247-- /Pre-release/
1969-- /Pre-release/
2249{-# INLINE_NORMAL pinnedWriteNAligned #-}
1971{-# INLINE_NORMAL pinnedWriteNAligned #-}
2250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1972pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
2251 => Int -> Int -> Fold m a (MutArray a)
1973 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1974+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
2254-- XXX Buffer to a list instead?
1976-- XXX Buffer to a list instead?
2256-- | Buffer a stream into a stream of arrays.
1978-- | Buffer a stream into a stream of arrays.
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1980+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2260-- Breaking an array into an array stream can be useful to consume a large
1982-- 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.
1983-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1989,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
2267{-# INLINE_NORMAL buildChunks #-}
1989{-# INLINE_NORMAL buildChunks #-}
2268buildChunks :: (MonadIO m, Unbox a) =>
1990buildChunks :: (MonadIO m, Unbox a) =>
2269 Int -> Fold m a (StreamK n (MutArray a))
1991 Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
1992+buildChunks n = FL.many (writeN n) FL.toStreamK
2272{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
1994{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
2274writeChunks :: (MonadIO m, Unbox a) =>
1995writeChunks :: (MonadIO m, Unbox a) =>
2275 Int -> Fold m a (StreamK n (MutArray a))
1996 Int -> Fold m a (StreamK n (MutArray a))
2276writeChunks = buildChunks
1997writeChunks = buildChunks
@@ -2278,29 +1999,29 @@ writeChunks = buildChunks
2278{-# INLINE_NORMAL writeWithAs #-}
1999{-# INLINE_NORMAL writeWithAs #-}
2279writeWithAs :: forall m a. (MonadIO m, Unbox a)
2000writeWithAs :: forall m a. (MonadIO m, Unbox a)
2280 => PinnedState -> Int -> Fold m a (MutArray a)
2001 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
2002+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
2282writeWithAs ps elemCount =
2003writeWithAs ps elemCount =
2283 FL.rmapM extract $ FL.foldlM' step initial
2004 FL.rmapM extract $ FL.foldlM' step initial
2287 initial = do
2008 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2009+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
2289 newAs ps elemCount
2010 newAs ps elemCount
2291 step arr@(MutArray _ start end bound) x
2012 step arr@(MutArray _ start end bound) x
2292 | INDEX_NEXT(end,a) > bound = do
2013 | INDEX_NEXT(end,a) > bound = do
2293 let oldSize = end - start
2014 let oldSize = end - start
2294 newSize = max (oldSize * 2) 1
2015 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
2016+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
2296 snocUnsafe arr1 x
2017 snocUnsafe arr1 x
2297 step arr x = snocUnsafe arr x
2018 step arr x = snocUnsafe arr x
2299 extract = liftIO . rightSize
2020 extract = liftIO . rightSize
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
2022+-- XXX Compare writeWith with fromStreamD which uses an array of streams
2302-- implementation. We can write this using buildChunks above if that is faster.
2023-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
2024+-- If writeWith is faster then we should use that to implement
2304-- fromStreamD.
2025-- fromStreamD.
2306-- XXX The realloc based implementation needs to make one extra copy if we use
2027-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +2036,39 @@ writeWithAs ps elemCount =
2315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2036-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2316-- malloc to compare against.
2037-- malloc to compare against.
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
2039+-- | @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
2040-- starts at a size big enough to hold minCount elements, the size is doubled
2320-- every time the array needs to be grown.
2041-- every time the array needs to be grown.
2322-- /Caution! Do not use this on infinite streams./
2043-- /Caution! Do not use this on infinite streams./
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
2045+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
2046+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2047+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2328-- /Pre-release/
2049-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
2050+{-# 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)
2051writeWith :: forall m a. (MonadIO m, Unbox a)
2338 => Int -> Fold m a (MutArray a)
2052 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2053+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2054+writeWith = writeWithAs Unpinned
2341-- | Fold the whole input to a single array.
2056-- | Fold the whole input to a single array.
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2058+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2344-- rounded up to the element size.
2059-- rounded up to the element size.
2346-- /Caution! Do not use this on infinite streams./
2061-- /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 #-}
2063{-# INLINE write #-}
2355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2064write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2065+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2358−-- | Like 'create' but creates a pinned array.
2067+-- | Like 'write' 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)
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
2365{-# INLINE pinnedWrite #-}
2068{-# INLINE pinnedWrite #-}
2366pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2069pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2070+pinnedWrite =
2071+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2369-------------------------------------------------------------------------------
2073-------------------------------------------------------------------------------
2370-- construct from streams, known size
2074-- construct from streams, known size
@@ -2384,18 +2088,17 @@ fromStreamDNAs ps limit str = do
2384 liftIO $ pokeAt ptr arrContents x
2088 liftIO $ pokeAt ptr arrContents x
2385 return $ INDEX_NEXT(ptr,a)
2089 return $ INDEX_NEXT(ptr,a)
2387−-- | Use the 'createOf' fold instead.
2091+-- | Use the 'writeN' fold instead.
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2093+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
2391{-# INLINE_NORMAL fromStreamN #-}
2095{-# INLINE_NORMAL fromStreamN #-}
2392fromStreamN :: forall m a. (MonadIO m, Unbox a)
2096fromStreamN :: forall m a. (MonadIO m, Unbox a)
2393 => Int -> D.Stream m a -> m (MutArray a)
2097 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2098+-- fromStreamDN n = D.fold (writeN n)
2395fromStreamN = fromStreamDNAs Unpinned
2099fromStreamN = fromStreamDNAs Unpinned
2397{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2101{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
2399fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2102fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2400 => Int -> D.Stream m a -> m (MutArray a)
2103 => Int -> D.Stream m a -> m (MutArray a)
2401fromStreamDN = fromStreamN
2104fromStreamDN = fromStreamN
@@ -2418,20 +2121,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
2418-- /Pre-release/
2121-- /Pre-release/
2419{-# INLINE fromListRevN #-}
2122{-# INLINE fromListRevN #-}
2420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2123fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2124+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
2423-- | Convert a pure stream in Identity monad to a mutable array.
2126-- | Convert a pure stream in Identity monad to a mutable array.
2424{-# INLINABLE fromPureStreamN #-}
2127{-# INLINABLE fromPureStreamN #-}
2425fromPureStreamN :: (MonadIO m, Unbox a) =>
2128fromPureStreamN :: (MonadIO m, Unbox a) =>
2426 Int -> Stream Identity a -> m (MutArray a)
2129 Int -> Stream Identity a -> m (MutArray a)
2427fromPureStreamN n xs =
2130fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2131+ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
2430-- | Convert a pure stream in Identity monad to a mutable array.
2133-- | Convert a pure stream in Identity monad to a mutable array.
2431{-# INLINABLE fromPureStream #-}
2134{-# INLINABLE fromPureStream #-}
2432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2135fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2433fromPureStream xs =
2136fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2137+ D.fold write $ D.morphInner (return . runIdentity) xs
2436{-# INLINABLE fromPtrN #-}
2139{-# INLINABLE fromPtrN #-}
2437fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
2140fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2143,7 @@ fromPtrN len addr = do
2440 -- XXX We can implement a stream copy in a similar way by streaming Word64
2143 -- XXX We can implement a stream copy in a similar way by streaming Word64
2441 -- first and then remaining Word8.
2144 -- first and then remaining Word8.
2442 arr <- new len
2145 arr <- new len
2443− _ <- unsafeAsPtr arr
2146+ _ <- asUnpinnedPtrUnsafe arr
2444 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2147 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2445 return (arr {arrEnd = len})
2148 return (arr {arrEnd = len})
@@ -2456,7 +2159,7 @@ fromByteStr# addr = do
2456 len <- liftIO $ c_strlen (Ptr addr)
2159 len <- liftIO $ c_strlen (Ptr addr)
2457 let lenInt = fromIntegral len
2160 let lenInt = fromIntegral len
2458 arr <- new lenInt
2161 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2162+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2460 return (arr {arrEnd = lenInt})
2163 return (arr {arrEnd = lenInt})
2462-------------------------------------------------------------------------------
2165-------------------------------------------------------------------------------
@@ -2515,7 +2218,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
2515fromChunksK = fromChunkskAs Unpinned
2218fromChunksK = fromChunkskAs Unpinned
2517{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2220{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
2519fromArrayStreamK :: (Unbox a, MonadIO m) =>
2221fromArrayStreamK :: (Unbox a, MonadIO m) =>
2520 StreamK m (MutArray a) -> m (MutArray a)
2222 StreamK m (MutArray a) -> m (MutArray a)
2521fromArrayStreamK = fromChunksK
2223fromArrayStreamK = fromChunksK
@@ -2527,7 +2229,7 @@ fromStreamDAs ps m =
2527 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2229 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2529-- | Create an 'Array' from a stream. This is useful when we want to create a
2231-- | 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
2232+-- single array from a stream of unknown size. 'writeN' is at least twice
2531-- as efficient when the size is already known.
2233-- as efficient when the size is already known.
2533-- Note that if the input stream is too large memory allocation for the array
2235-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2241,19 @@ fromStreamDAs ps m =
2539fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2241fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540fromStream = fromStreamDAs Unpinned
2242fromStream = fromStreamDAs Unpinned
2542−-- fromStream (Stream m) = P.fold create m
2244+-- fromStream (Stream m) = P.fold write m
2543-- CAUTION: a very large number (millions) of arrays can degrade performance
2245-- 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
2246-- due to GC overhead because we need to buffer the arrays before we flatten
2545-- all the arrays.
2247-- all the arrays.
2547−-- XXX Compare if this is faster or "fold create".
2249+-- XXX Compare if this is faster or "fold write".
2549-- | We could take the approach of doubling the memory allocation on each
2251-- | 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
2252-- 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
2253-- 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.
2254-- result in an extra copy of the entire data.
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2256+-- >>> fromStreamD = StreamD.fold MutArray.write
2556{-# INLINE fromStreamD #-}
2258{-# INLINE fromStreamD #-}
2557{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
2259{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2283,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
2581-- Cloning
2283-- Cloning
2582-------------------------------------------------------------------------------
2284-------------------------------------------------------------------------------
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 #-}
2286{-# INLINE cloneAs #-}
2589cloneAs ::
2287cloneAs ::
2590 ( MonadIO m
2288 ( MonadIO m
@@ -2676,7 +2374,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
2676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2374 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2677spliceWith sizer dst@(MutArray _ start end bound) src = do
2375spliceWith sizer dst@(MutArray _ start end bound) src = do
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2377+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
2680 in D.fold f (toStreamD src)
2378 in D.fold f (toStreamD src)
2682 assert (end <= bound) (return ())
2380 assert (end <= bound) (return ())
@@ -2744,7 +2442,7 @@ splitOn predicate arr =
2744{-# INLINE breakOn #-}
2442{-# INLINE breakOn #-}
2745breakOn :: MonadIO m
2443breakOn :: MonadIO m
2746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2444 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2445+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
2748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2446 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749 -- Need efficient stream based primitives that work on Word64.
2447 -- Need efficient stream based primitives that work on Word64.
2750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2448 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2465,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
2468-- | Create two slices of an array without copying the original array. The
2793-- specified index @i@ is the first index of the second slice.
2469-- specified index @i@ is the first index of the second slice.
2795{-# INLINE splitAt #-}
2471{-# INLINE splitAt #-}
2796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2472splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2473+splitAt i arr@MutArray{..} =
2798 let maxIndex = length arr - 1
2474 let maxIndex = length arr - 1
2799 in if i < 0
2475 in if i < 0
2800 then error "sliceAt: negative array index"
2476 then error "sliceAt: negative array index"
2801 else if i > maxIndex
2477 else if i > maxIndex
2802 then error $ "sliceAt: specified array index " ++ show i
2478 then error $ "sliceAt: specified array index " ++ show i
2803 ++ " is beyond the maximum index " ++ show maxIndex
2479 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2480+ else let off = i * SIZE_OF(a)
2483+ { arrContents = arrContents
2484+ , arrStart = arrStart
2489+ { arrContents = arrContents
2492+ , arrBound = arrBound
2806-------------------------------------------------------------------------------
2496-------------------------------------------------------------------------------
2807-- Casting
2497-- Casting
@@ -2851,13 +2541,9 @@ cast arr =
2851-- guarantees that unsafe calls will be performed in the calling thread. Making
2541-- guarantees that unsafe calls will be performed in the calling thread. Making
2852-- it safe to pass heap-allocated objects to unsafe functions.
2542-- 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
2544+-- 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
2545-- operations. And we are safe from Haskell perspective because we will be
2856-- pinning the memory.
2546-- 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
2548-- | 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.
2549-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2561,16 @@ cast arr =
2876-- /Pre-release/
2562-- /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 #-}
2564{-# INLINE asPtrUnsafe #-}
2886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2565asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2566+asPtrUnsafe arr f =
2567+ Unboxed.asPtrUnsafe
2568+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2889−{-# INLINE unsafeAsPtr #-}
2570+{-# INLINE asUnpinnedPtrUnsafe #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2571+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2572+asUnpinnedPtrUnsafe arr f =
2892− Unboxed.unsafeAsPtr
2573+ Unboxed.asUnpinnedPtrUnsafe
2893 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2574 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2895-------------------------------------------------------------------------------
2576-------------------------------------------------------------------------------
@@ -2946,48 +2627,46 @@ byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2946-- Compact
2627-- Compact
2947-------------------------------------------------------------------------------
2628-------------------------------------------------------------------------------
2949−-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2630+-- | Parser @pCompactLE n@ coalesces adjacent arrays in the input stream
2950−-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2631+-- only if the combined size would be less than or equal to n.
2951−-- can leave some memory unused. They can split the last array to fit it
2632+--
2952−-- exactly in the space.
2633+-- /Internal/
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2634+{-# INLINE_NORMAL pCompactLE #-}
2955−pCompactLeAs ::
2635+pCompactLE ::
2956 forall m a. (MonadIO m, Unbox a)
2636 forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2637+ => Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2638+pCompactLE n = Parser step initial extract
2962− maxBytes = maxElems * SIZE_OF(a)
2642+ nBytes = n * SIZE_OF(a)
2964 functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2644 functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2966 initial =
2646 initial =
2968− $ if maxElems <= 0
2648+ $ if n <= 0
2969 then error
2649 then error
2970 $ functionName
2650 $ functionName
2971 ++ ": the size of arrays ["
2651 ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2652+ ++ show n ++ "] must be a natural number"
2973 else Parser.IPartial Nothing
2653 else Parser.IPartial Nothing
2975 step Nothing arr =
2655 step Nothing arr =
2977 $ let len = byteLength arr
2657 $ let len = byteLength arr
2978− in if len >= maxBytes
2658+ in if len >= nBytes
2979 then Parser.Done 0 arr
2659 then Parser.Done 0 arr
2980 else Parser.Partial 0 (Just arr)
2660 else Parser.Partial 0 (Just arr)
2981− -- XXX Split the last array to use the space more compactly.
2982 step (Just buf) arr =
2661 step (Just buf) arr =
2983 let len = byteLength buf + byteLength arr
2662 let len = byteLength buf + byteLength arr
2984− in if len > maxBytes
2663+ in if len > nBytes
2985 then return $ Parser.Done 1 buf
2664 then return $ Parser.Done 1 buf
2666+ -- XXX check this in the Nothing case
2988− if byteCapacity buf < maxBytes
2668+ if byteCapacity buf < nBytes
2989− then liftIO $ reallocExplicitAs
2669+ then liftIO $ realloc nBytes buf
2990− ps (SIZE_OF(a)) maxBytes buf
2991 else return buf
2670 else return buf
2992 buf2 <- spliceUnsafe buf1 arr
2671 buf2 <- spliceUnsafe buf1 arr
2993 return $ Parser.Partial 0 (Just buf2)
2672 return $ Parser.Partial 0 (Just buf2)
@@ -2995,30 +2674,6 @@ pCompactLeAs ps maxElems = Parser step initial extract
2995 extract Nothing = return $ Parser.Done 0 nil
2674 extract Nothing = return $ Parser.Done 0 nil
2996 extract (Just buf) = return $ Parser.Done 0 buf
2675 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
2677data SpliceState s arr
3023 = SpliceInitial s
2678 = SpliceInitial s
3024 | SpliceBuffering s arr
2679 | SpliceBuffering s arr
@@ -3030,47 +2685,48 @@ data SpliceState s arr
3030-- immutable array never has additional space so a new array is allocated
2685-- immutable array never has additional space so a new array is allocated
3031-- instead of mutating it.
2686-- instead of mutating it.
2688+-- | Scan @rCompactLE n@ coalesces adjacent arrays in the input stream
2689+-- only if the combined size would be less than or equal to n.
3033−{-# INLINE_NORMAL compactLeAs #-}
2692+{-# INLINE_NORMAL rCompactLE #-}
3034−compactLeAs :: forall m a. (MonadIO m, Unbox a)
2693+rCompactLE :: (MonadIO m, Unbox a)
3035− => PinnedState -> Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
2694+ => Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
3036−compactLeAs ps maxElems (D.Stream step state) =
2695+rCompactLE n (D.Stream step state) =
3037 D.Stream step' (SpliceInitial state)
2696 D.Stream step' (SpliceInitial state)
3041− maxBytes = maxElems * SIZE_OF(a)
3043 functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
2700 functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
3045 {-# INLINE_LATE step' #-}
2702 {-# INLINE_LATE step' #-}
3046 step' gst (SpliceInitial st) = do
2703 step' gst (SpliceInitial st) = do
3047− when (maxElems <= 0) $
2704+ when (n <= 0) $
3048 -- XXX we can pass the module string from the higher level API
2705 -- XXX we can pass the module string from the higher level API
3049− error $ functionName ++ ": the size of arrays [" ++ show maxElems
2706+ error $ functionName ++ ": the size of arrays [" ++ show n
3050 ++ "] must be a natural number"
2707 ++ "] must be a natural number"
3051 r <- step gst st
2708 r <- step gst st
3052 case r of
2709 case r of
3053 D.Yield arr s -> return $
2710 D.Yield arr s -> return $
3054 let len = byteLength arr
2711 let len = byteLength arr
3055− in if len >= maxBytes
2712+ in if len >= n
3056 then D.Skip (SpliceYielding arr (SpliceInitial s))
2713 then D.Skip (SpliceYielding arr (SpliceInitial s))
3057 else D.Skip (SpliceBuffering s arr)
2714 else D.Skip (SpliceBuffering s arr)
3058 D.Skip s -> return $ D.Skip (SpliceInitial s)
2715 D.Skip s -> return $ D.Skip (SpliceInitial s)
3059 D.Stop -> return D.Stop
2716 D.Stop -> return D.Stop
3061− -- XXX Split the last array to use the space more compactly.
3062 step' gst (SpliceBuffering st buf) = do
2718 step' gst (SpliceBuffering st buf) = do
3063 r <- step gst st
2719 r <- step gst st
3064 case r of
2720 case r of
3065 D.Yield arr s -> do
2721 D.Yield arr s -> do
3066 let len = byteLength buf + byteLength arr
2722 let len = byteLength buf + byteLength arr
3067− if len > maxBytes
2723+ if len > n
3068 then return $
2724 then return $
3069 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
2725 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
2727+ -- XXX check this in the SpliceInitial case
3071− buf1 <- if byteCapacity buf < maxBytes
2728+ buf1 <- if byteCapacity buf < n
3072− then liftIO $ reallocExplicitAs
2729+ then liftIO $ realloc n buf
3073− ps (SIZE_OF(a)) maxBytes buf
3074 else return buf
2730 else return buf
3075 buf2 <- spliceUnsafe buf1 arr
2731 buf2 <- spliceUnsafe buf1 arr
3076 return $ D.Skip (SpliceBuffering s buf2)
2732 return $ D.Skip (SpliceBuffering s buf2)
@@ -3081,119 +2737,108 @@ compactLeAs ps maxElems (D.Stream step state) =
3082 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
2738 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3084−
2740+-- | Fold @fCompactGE n@ coalesces adjacent arrays in the input stream
2741+-- until the size becomes greater than or equal to n.
3085−{-# INLINE_NORMAL fCompactGeAs #-}
2743+{-# INLINE_NORMAL fCompactGE #-}
3086−fCompactGeAs ::
2744+fCompactGE ::
3087 forall m a. (MonadIO m, Unbox a)
2745 forall m a. (MonadIO m, Unbox a)
3088− => PinnedState -> Int -> FL.Fold m (MutArray a) (MutArray a)
2746+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3089−fCompactGeAs ps minElems = Fold step initial extract extract
2747+fCompactGE n = Fold step initial extract extract
3093− minBytes = minElems * SIZE_OF(a)
2751+ nBytes = n * SIZE_OF(a)
3095 functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
2753 functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3097 initial =
2755 initial =
3099− $ if minElems < 0
2757+ $ if n < 0
3100 then error
2758 then error
3101 $ functionName
2759 $ functionName
3102 ++ ": the size of arrays ["
2760 ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
2761+ ++ show n ++ "] must be a natural number"
3104 else FL.Partial Nothing
2762 else FL.Partial Nothing
3106 step Nothing arr =
2764 step Nothing arr =
3108 $ let len = byteLength arr
2766 $ let len = byteLength arr
3109− in if len >= minBytes
2767+ in if len >= nBytes
3110 then FL.Done arr
2768 then FL.Done arr
3111 else FL.Partial (Just arr)
2769 else FL.Partial (Just arr)
3112− -- XXX Buffer arrays as a list to avoid copy and reallocations
3113 step (Just buf) arr = do
2770 step (Just buf) arr = do
3114 let len = byteLength buf + byteLength arr
2771 let len = byteLength buf + byteLength arr
3116 if byteCapacity buf < len
2773 if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
2774+ then liftIO $ realloc (max len nBytes) buf
3118− ps (SIZE_OF(a)) (max minBytes len) buf
3119 else return buf
2775 else return buf
3120 buf2 <- spliceUnsafe buf1 arr
2776 buf2 <- spliceUnsafe buf1 arr
3121− if len >= minBytes
2777+ if len >= n
3122 then return $ FL.Done buf2
2778 then return $ FL.Done buf2
3123 else return $ FL.Partial (Just buf2)
2779 else return $ FL.Partial (Just buf2)
3125 extract Nothing = return nil
2781 extract Nothing = return nil
3126 extract (Just buf) = return buf
2782 extract (Just buf) = return buf
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
2784+-- | 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
2786+-- >>> 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 #-}
2788+{-# INLINE_NORMAL lCompactGE #-}
3147−lCompactGeAs :: forall m a. (MonadIO m, Unbox a)
2789+lCompactGE :: (MonadIO m, Unbox a)
3148− => PinnedState -> Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
2790+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3149−-- The fold version turns out to be a little bit slower.
2791+-- lCompactGE n = Fold.many (fCompactGE n)
3150−-- lCompactGeAs ps n = FL.many (fCompactGeAs ps n)
3151−lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
2792+lCompactGE n (Fold step1 initial1 _ final1) =
3152 Fold step initial extract final
2793 Fold step initial extract final
3156− minBytes = minElems * SIZE_OF(a)
3158 functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
2797 functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
3160 initial = do
2799 initial = do
3161− when (minElems <= 0) $
2800+ when (n <= 0) $
3162 -- XXX we can pass the module string from the higher level API
2801 -- XXX we can pass the module string from the higher level API
3163 error $ functionName ++ ": the size of arrays ["
2802 error $ functionName ++ ": the size of arrays ["
3164− ++ show minElems ++ "] must be a natural number"
2803+ ++ show n ++ "] must be a natural number"
3166 r <- initial1
2805 r <- initial1
3167 return $ first (Tuple' Nothing) r
2806 return $ first (Tuple' Nothing) r
3169− {-# INLINE runInner #-}
2808+ step (Tuple' Nothing r1) arr =
3170− runInner len acc buf =
2809+ let len = byteLength arr
2814+ FL.Done _ -> return $ FL.Done ()
2818+ return $ first (Tuple' Nothing) res
2819+ else return $ FL.Partial $ Tuple' (Just arr) r1
2821+ step (Tuple' (Just buf) r1) arr = do
2822+ let len = byteLength buf + byteLength arr
2823+ buf1 <- if byteCapacity buf < len
2824+ then liftIO $ realloc (max n len) buf
2826+ buf2 <- spliceUnsafe buf1 arr
2828+ -- XXX this is common in both the equations of step
3171− if len >= minBytes
2829+ if len >= n
3173− r <- step1 acc buf
2831+ r <- step1 r1 buf2
3174 case r of
2832 case r of
3175 FL.Done _ -> return $ FL.Done ()
2833 FL.Done _ -> return $ FL.Done ()
3176 FL.Partial s -> do
2834 FL.Partial s -> do
3177 _ <- final1 s
2835 _ <- final1 s
3178 res <- initial1
2836 res <- initial1
3179 return $ first (Tuple' Nothing) res
2837 return $ first (Tuple' Nothing) res
3180− else return $ FL.Partial $ Tuple' (Just buf) acc
2838+ else return $ FL.Partial $ Tuple' (Just buf2) r1
3182− step (Tuple' Nothing r1) arr =
3183− runInner (byteLength arr) r1 arr
3185− -- XXX Buffer arrays as a list to avoid copy and reallocations
3186− step (Tuple' (Just buf) r1) arr = do
3187− let len = byteLength buf + byteLength arr
3188− buf1 <- if byteCapacity buf < len
3189− then liftIO $ reallocExplicitAs
3190− ps (SIZE_OF(a)) (max minBytes len) buf
3192− buf2 <- spliceUnsafe buf1 arr
3193− runInner len r1 buf2
3195 -- XXX Several folds do extract >=> final, therefore, we need to make final
2840 -- XXX Several folds do extract >=> final, therefore, we need to make final
3196− -- return "m b" rather than using extract post it if we want extract to be
2841+ -- return "m b" rather than using extract post it if we want extract to be
3197 -- partial.
2842 -- partial.
3199 -- extract forces the pending buffer to be sent to the fold which is not
2844 -- extract forces the pending buffer to be sent to the fold which is not
@@ -3207,23 +2852,6 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
3207 FL.Partial rr -> final1 rr
2852 FL.Partial rr -> final1 rr
3208 FL.Done _ -> return ()
2853 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
2855-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228-- the size becomes greater than or equal to @n@.
2856-- the size becomes greater than or equal to @n@.