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