@@ -40,22 +40,22 @@ module Streamly.Internal.Data.MutArray.Type
4040
4141 -- ** Casting
4242 , cast
43− , castUnsafe -- XXX unsafeCast
43+ , castUnsafe
4444 , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
45+ , asPtrUnsafe
46+ , asUnpinnedPtrUnsafe
4747
4848 -- ** Construction
49− , empty
49+ , nil
5050
5151 -- *** New
5252 -- | New arrays are always empty arrays with some reserve capacity to
5353 -- extend the length without reallocating.
54− , emptyOf
55− , newArrayWith -- emptyAlignedWith
56− , pinnedEmptyOf
57− , pinnedNewAligned -- XXX not required
58− -- , new -- uninitialized array of specified length
54+ , new
55+ , newArrayWith
56+ , pinnedNew
57+ , pinnedNewBytes
58+ , pinnedNewAligned
5959
6060 -- *** Cloning
6161 , clone
@@ -63,25 +63,27 @@ module Streamly.Internal.Data.MutArray.Type
6363
6464 -- *** Slicing
6565 -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
66+ , getSliceUnsafe
6767 , getSlice
6868 , splitAt -- XXX should be able to express using getSlice
6969 , breakOn
7070
7171 -- *** Stream Folds
7272 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
74− , unsafeCreateOf
75− , unsafePinnedCreateOf
76− , pinnedCreateOf
77− , createOfWith
78− , createOf
79− , revCreateOf
80−
81− , pinnedCreate
82− , createWith
83− , create
84− -- , revCreate
73+ , writeNWithUnsafe
74+ , writeNWith
75+ , writeNUnsafe
76+ , pinnedWriteNUnsafe
77+ , writeN
78+ , pinnedWriteN
79+ , pinnedWriteNAligned
80+
81+ , writeWith
82+ , write
83+ , pinnedWrite
84+
85+ , writeRevN
86+ -- , writeRev
8587
8688 -- *** From containers
8789 , fromListN
@@ -97,11 +99,11 @@ module Streamly.Internal.Data.MutArray.Type
9799 , fromByteStr#
98100 , fromPtrN
99101 , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
102+ , fromChunksRealloced
101103
102104 -- ** Random writes
103105 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
106+ , putIndexUnsafe
105107 , putIndices
106108 -- , putFromThenTo
107109 -- , putFrom -- start writing at the given position
@@ -109,7 +111,7 @@ module Streamly.Internal.Data.MutArray.Type
109111 -- , putFromTo
110112 -- , putFromRev
111113 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
114+ , modifyIndexUnsafe
113115 , modifyIndex
114116 , modifyIndices
115117 , modify
@@ -120,11 +122,11 @@ module Streamly.Internal.Data.MutArray.Type
120122
121123 -- *** Indexing
122124 , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
125+ , getIndexUnsafe
126+ , getIndices -- XXX indexReader
127+ , getIndicesWith -- XXX indexReaderWith
124128 -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
126− , indexReader
127− , indexReaderWith
129+ , getIndexRev
128130
129131 -- *** To Streams
130132 , read
@@ -162,9 +164,9 @@ module Streamly.Internal.Data.MutArray.Type
162164 , blockSize
163165 , arrayChunkBytes
164166 , allocBytesToElemCount
165− , realloc -- this is "resize"
166− , grow
167− , growExp
167+ , realloc
168+ , resize
169+ , resizeExp
168170 , rightSize
169171
170172 -- ** Folding
@@ -193,34 +195,24 @@ module Streamly.Internal.Data.MutArray.Type
193195 , snoc
194196 , snocLinear
195197 , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
198+ , snocUnsafe
197199
198200 -- *** Appending streams
199− , unsafeAppendN
200− , appendN
201− , appendWith
202− , append
201+ , writeAppendNUnsafe
202+ , writeAppendN
203+ , writeAppendWith
204+ , writeAppend
203205
204206 -- *** Appending arrays
205207 , spliceCopy
206208 , spliceWith
207209 , splice
208210 , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
211+ , spliceUnsafe
210212 -- , putSlice
211213 -- , appendSlice
212214 -- , appendSliceFrom
213215
214− -- ** Serialization using Unbox
215− , pokeAppend
216− , pokeAppendMay
217− , pokeSkipUnsafe -- unsafePokeSkip
218−
219− -- ** Deserialization using Unbox
220− , peekUncons
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
223−
224216 -- Arrays of arrays
225217 -- We can add dimensionality parameter to the array type to get
226218 -- multidimensional arrays. Multidimensional arrays would just be a
@@ -242,23 +234,18 @@ module Streamly.Internal.Data.MutArray.Type
242234
243235 -- *** Concat
244236 -- | Append the arrays in a stream to form a stream of elements.
245− , concatWith
246− , concatRevWith
247− , concat
248− , concatRev
237+ , concatChunks
238+ , concatChunksRev
249239
250240 -- *** Compact
251241 -- | Append the arrays in a stream to form a stream of larger arrays.
252242 , SpliceState (..)
253− , pCompactLE
254− , pPinnedCompactLE
255− , compactLeAs
256− , fCompactGE
257− , fPinnedCompactGE
258− , lCompactGE
259− , lPinnedCompactGE
260− , compactGE
261− , compactEQ
243+ , pCompactChunksLE
244+ , rCompactChunksLE
245+ , fCompactChunksGE
246+ , lCompactChunksGE
247+ , compactChunksGE
248+ , compactChunksEQ
262249
263250 -- ** Utilities
264251 , roundUpToPower2
@@ -267,7 +254,6 @@ module Streamly.Internal.Data.MutArray.Type
267254 , c_memchr
268255
269256 -- * Deprecated
270− , asPtrUnsafe
271257 , writeChunks
272258 , flattenArrays
273259 , flattenArraysRev
@@ -275,29 +261,6 @@ module Streamly.Internal.Data.MutArray.Type
275261 , fromStreamDN
276262 , fromStreamD
277263 , cmp
278− , getIndices
279− , getIndicesWith
280− , resize
281− , resizeExp
282− , nil
283− , new
284− , pinnedNew
285− , pinnedNewBytes
286− , writeAppendNUnsafe
287− , writeAppendN
288− , writeAppendWith
289− , writeAppend
290− , writeNWithUnsafe
291− , writeNWith
292− , writeNUnsafe
293− , pinnedWriteNUnsafe
294− , writeN
295− , pinnedWriteN
296− , pinnedWriteNAligned -- XXX not required
297− , writeWith
298− , write
299− , pinnedWrite
300− , writeRevN
301264 )
302265where
303266
@@ -353,7 +316,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
353316import qualified Prelude
354317
355318import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
319+ (Foldable(..), read, unlines, splitAt, reverse, truncate)
357320
358321#include "DocTestDataMutArray.hs"
359322
@@ -479,8 +442,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479442-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480443-- allocatePinned in GHC source.
481444
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484445-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485446-- length and with a capacity to hold @count@ elements, using @allocator
486447-- size alignment@ as the memory allocator function.
@@ -504,25 +465,12 @@ newArrayWith alloc alignSize count = do
504465 , arrBound = size
505466 }
506467
507−-- For arrays "nil" sounds a bit odd. empty is better. The only problem with
508−-- empty is that it is also used by the Alternative type class. But assuming we
509−-- will mostly import the Array module qualified this should be fine.
510−
511−-- | Create an empty array.
512−empty ::
513−#ifdef DEVBUILD
514− Unbox a =>
515−#endif
516− MutArray a
517−empty = MutArray Unboxed.empty 0 0 0
518−
519−{-# DEPRECATED nil "Please use empty instead." #-}
520468nil ::
521469#ifdef DEVBUILD
522470 Unbox a =>
523471#endif
524472 MutArray a
525−nil = empty
473+nil = MutArray Unboxed.nil 0 0 0
526474
527475{-# INLINE newBytesAs #-}
528476newBytesAs :: MonadIO m =>
@@ -539,13 +487,12 @@ newBytesAs ps bytes = do
539487 , arrBound = bytes
540488 }
541489
542−-- | Allocates a pinned empty array that with a reserved capacity of bytes.
543−-- The memory of the array is uninitialized and the allocation is aligned as
544−-- per the 'Unboxed' instance of the type.
490+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
491+-- the array is uninitialized and the allocation is aligned as per the
492+-- 'Unboxed' instance of the type.
545493--
546494-- /Pre-release/
547495{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549496pinnedNewBytes :: MonadIO m =>
550497#ifdef DEVBUILD
551498 Unbox a =>
@@ -570,31 +517,21 @@ newAs ps =
570517 (error "new: alignment is not used in unpinned arrays.")
571518
572519-- XXX can unaligned allocation be more efficient when alignment is not needed?
573−
574−-- | Allocates a pinned array of zero length but growable to the specified
575−-- capacity without reallocation.
576−{-# INLINE pinnedEmptyOf #-}
577−pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
578−pinnedEmptyOf = newAs Pinned
579−
580−-- XXX Deprecate in major
581−-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
520+--
521+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
522+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
523+-- instance of the type.
524+--
582525{-# INLINE pinnedNew #-}
583526pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
527+pinnedNew = newAs Pinned
585528
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
529+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
530+-- of the array is uninitialized.
588531--
589−{-# INLINE emptyOf #-}
590−emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591−emptyOf = newAs Unpinned
592−
593−-- XXX Deprecate in major
594−-- {-# DEPRECATED new "Please use emptyOf instead." #-}
595532{-# INLINE new #-}
596533new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
534+new = newAs Unpinned
598535
599536-------------------------------------------------------------------------------
600537-- Random writes
@@ -642,7 +579,7 @@ putIndices arr = FL.foldlM' step (return ())
642579
643580 where
644581
645− step () (i, x) = putIndex i arr x
582+ step () (i, x) = liftIO (putIndex i arr x)
646583
647584-- | Modify a given index of an array using a modifier function.
648585--
@@ -838,19 +775,22 @@ arrayChunkBytes = 1024
838775roundDownTo :: Int -> Int -> Int
839776roundDownTo elemSize size = size - (size `mod` elemSize)
840777
778+-- XXX See if resizing can be implemented by reading the old array as a stream
779+-- and then using writeN to the new array.
780+--
841781-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842782-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843783-- which complicates some inspection tests.
844784--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
785+{-# NOINLINE reallocExplicit #-}
786+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
787+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848788 assertM(arrEnd <= arrBound)
849789
850790 -- Allocate new array
851791 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852792 contents <-
853− if ps == Pinned
793+ if Unboxed.isPinned arrContents
854794 then Unboxed.pinnedNew newCapMaxInBytes
855795 else Unboxed.new newCapMaxInBytes
856796 let !(MutByteArray mbarrFrom#) = arrContents
@@ -875,10 +815,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875815 , arrBound = newCapInBytes
876816 }
877817
878−-- XXX Should these be called reallocBytes etc?
879−-- XXX We may also need reallocAs to allocate as pinned/unpinned explicitly. In
880−-- fact clone/pinnedClone can be implemented using reallocAs.
881−
882818-- | @realloc newCapacity array@ reallocates the array to the specified
883819-- capacity in bytes.
884820--
@@ -890,12 +826,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890826-- If the original array is pinned, the newly allocated array is also pinned.
891827{-# INLINABLE realloc #-}
892828realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
893−realloc bytes arr =
894− let ps =
895− if isPinned arr
896− then Pinned
897− else Unpinned
898− in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
829+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899830
900831-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901832-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +849,14 @@ reallocWith label capSizer minIncrBytes arr = do
918849 where
919850
920851 badSize newSize =
921− Prelude.concat
852+ concat
922853 [ label
923854 , ": new array size (in bytes) is less than required size "
924855 , show newSize
925856 , ". Please check the sizing function passed."
926857 ]
927858
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
859+-- | @resize newCapacity array@ changes the total capacity of the array so that
929860-- it is enough to hold the specified number of elements. Nothing is done if
930861-- the specified capacity is less than the length of the array.
931862--
@@ -933,46 +864,34 @@ reallocWith label capSizer minIncrBytes arr = do
933864-- the block size (4K).
934865--
935866-- /Pre-release/
936−{-# INLINE grow #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
867+{-# INLINE resize #-}
868+resize :: forall m a. (MonadIO m, Unbox a) =>
938869 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
870+resize nElems arr@MutArray{..} = do
940871 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
942− if req < cap
872+ len = arrEnd - arrStart
873+ if req < len
943874 then return arr
944875 else realloc req arr
945876
946−{-# DEPRECATED resize "Please use grow instead." #-}
947−{-# INLINE resize #-}
948−resize :: forall m a. (MonadIO m, Unbox a) =>
949− Int -> MutArray a -> m (MutArray a)
950−resize = grow
951−
952−-- | Like 'grow' but if the requested byte capacity is more than
953−-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
877+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
878+-- then it is rounded up to the closest power of 2.
954879--
955880-- /Pre-release/
956−{-# INLINE growExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
881+{-# INLINE resizeExp #-}
882+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958883 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
884+resizeExp nElems arr@MutArray{..} = do
960885 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
961886 req1 =
962887 if req > largeObjectThreshold
963888 then roundUpToPower2 req
964889 else req
965− cap = arrBound - arrStart
966− if req1 < cap
890+ len = arrEnd - arrStart
891+ if req1 < len
967892 then return arr
968893 else realloc req1 arr
969894
970−{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971−{-# INLINE resizeExp #-}
972−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973− Int -> MutArray a -> m (MutArray a)
974−resizeExp = growExp
975−
976895-- | Resize the allocated memory to drop any reserved free space at the end of
977896-- the array and reallocate it to reduce wastage.
978897--
@@ -1037,7 +956,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037956{-# INLINE snocMay #-}
1038957snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039958 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
959+snocMay arr@MutArray{..} x = liftIO $ do
1041960 let newEnd = INDEX_NEXT(arrEnd,a)
1042961 if newEnd <= arrBound
1043962 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +970,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1051970 -> a
1052971 -> m (MutArray a)
1053972snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
973+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055974 snocUnsafe arr1 x
1056975
1057976-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +992,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073992 -> MutArray a
1074993 -> a
1075994 -> m (MutArray a)
1076−snocWith allocSize arr x = do
995+snocWith allocSize arr x = liftIO $ do
1077996 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078997 if newEnd <= arrBound arr
1079998 then snocNewEnd newEnd arr x
@@ -1117,126 +1036,6 @@ snoc = snocWith f
11171036 then oldSize * 2
11181037 else roundUpToPower2 oldSize * 2
11191038
1120−-------------------------------------------------------------------------------
1121−-- Serialization/Deserialization
1122−-------------------------------------------------------------------------------
1123−
1124−{-# INLINE pokeNewEnd #-}
1125−pokeNewEnd :: (MonadIO m, Unbox a) =>
1126− Int -> MutArray Word8 -> a -> m (MutArray Word8)
1127−pokeNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1128− assert (newEnd <= arrBound) (return ())
1129− liftIO $ pokeAt arrEnd arrContents x
1130− return $ arr {arrEnd = newEnd}
1131−
1132−-- | Really really unsafe, unboxes a Haskell type and appends the resulting
1133−-- bytes to the byte array, may cause silent data corruption or if you are
1134−-- lucky a segfault if the array does not have enough space to append the
1135−-- element.
1136−--
1137−-- /Internal/
1138−{-# INLINE pokeAppendUnsafe #-}
1139−pokeAppendUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1140− MutArray Word8 -> a -> m (MutArray Word8)
1141−pokeAppendUnsafe arr@MutArray{..} = pokeNewEnd (arrEnd + SIZE_OF(a)) arr
1142−
1143−-- | Skip the specified number of bytes in the array. The data in the skipped
1144−-- region remains uninitialzed.
1145−{-# INLINE pokeSkipUnsafe #-}
1146−pokeSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1147−pokeSkipUnsafe n arr@MutArray{..} = do
1148− let newEnd = arrEnd + n
1149− in assert (newEnd <= arrBound) (arr {arrEnd = newEnd})
1150−
1151−-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152−-- capacity becomes full.
1153−--
1154−-- /Internal/
1155−{-# INLINE pokeAppendMay #-}
1156−pokeAppendMay :: forall m a. (MonadIO m, Unbox a) =>
1157− MutArray Word8 -> a -> m (Maybe (MutArray Word8))
1158−pokeAppendMay arr@MutArray{..} x = liftIO $ do
1159− let newEnd = arrEnd + SIZE_OF(a)
1160− if newEnd <= arrBound
1161− then Just <$> pokeNewEnd newEnd arr x
1162− else return Nothing
1163−
1164−{-# NOINLINE pokeWithRealloc #-}
1165−pokeWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1166− (Int -> Int)
1167− -> MutArray Word8
1168− -> a
1169− -> m (MutArray Word8)
1170−pokeWithRealloc sizer arr x = do
1171− arr1 <- liftIO $ reallocWith "pokeWithRealloc" sizer (SIZE_OF(a)) arr
1172− pokeAppendUnsafe arr1 x
1173−
1174−{-# INLINE pokeAppendWith #-}
1175−pokeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1176− (Int -> Int)
1177− -> MutArray Word8
1178− -> a
1179− -> m (MutArray Word8)
1180−pokeAppendWith allocSize arr x = liftIO $ do
1181− let newEnd = arrEnd arr + SIZE_OF(a)
1182− if newEnd <= arrBound arr
1183− then pokeNewEnd newEnd arr x
1184− else pokeWithRealloc allocSize arr x
1185−
1186−-- | Unbox a Haskell type and append the resulting bytes to a mutable byte
1187−-- array. The array is grown exponentially when more space is needed.
1188−--
1189−-- Definition:
1190−--
1191−-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1192−--
1193−{-# INLINE pokeAppend #-}
1194−pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195− MutArray Word8 -> a -> m (MutArray Word8)
1196−pokeAppend = pokeAppendWith f
1197−
1198− where
1199−
1200− f oldSize =
1201− if isPower2 oldSize
1202− then oldSize * 2
1203− else roundUpToPower2 oldSize * 2
1204−
1205−-- | Really really unsafe, create a Haskell value from an unboxed byte array,
1206−-- does not check if the array is big enough, may return garbage or if you are
1207−-- lucky may cause a segfault.
1208−--
1209−-- /Internal/
1210−{-# INLINE peekUnconsUnsafe #-}
1211−peekUnconsUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1212− MutArray Word8 -> m (a, MutArray Word8)
1213−peekUnconsUnsafe MutArray{..} = do
1214− let start1 = arrStart + SIZE_OF(a)
1215− assert (start1 <= arrEnd) (return ())
1216− liftIO $ do
1217− r <- peekAt arrStart arrContents
1218− return (r, MutArray arrContents start1 arrEnd arrBound)
1219−
1220−-- | Discard the specified number of bytes in the array.
1221−{-# INLINE peekSkipUnsafe #-}
1222−peekSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1223−peekSkipUnsafe n MutArray{..} =
1224− let start1 = arrStart + n
1225− in assert (start1 <= arrEnd) (MutArray arrContents start1 arrEnd arrBound)
1226−
1227−-- | Create a Haskell value from its unboxed representation from the head of a
1228−-- byte array, return the value and the remaining array.
1229−{-# INLINE peekUncons #-}
1230−peekUncons :: forall m a. (MonadIO m, Unbox a) =>
1231− MutArray Word8 -> m (Maybe a, MutArray Word8)
1232−peekUncons arr@MutArray{..} = do
1233− let start1 = arrStart + SIZE_OF(a)
1234− if start1 > arrEnd
1235− then return (Nothing, arr)
1236− else liftIO $ do
1237− r <- peekAt arrStart arrContents
1238− return (Just r, MutArray arrContents start1 arrEnd arrBound)
1239−
12401039-------------------------------------------------------------------------------
12411040-- Random reads
12421041-------------------------------------------------------------------------------
@@ -1279,10 +1078,10 @@ getIndexRev i MutArray{..} = do
12791078data GetIndicesState contents start end st =
12801079 GetIndicesState contents start end st
12811080
1282−{-# INLINE indexReaderWith #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1081+{-# INLINE getIndicesWith #-}
1082+getIndicesWith :: (Monad m, Unbox a) =>
12841083 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1285−indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
1084+getIndicesWith liftio (D.Stream stepi sti) = Unfold step inject
12861085
12871086 where
12881087
@@ -1301,26 +1100,14 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
13011100 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
13021101 D.Stop -> return D.Stop
13031102
1304−{-# DEPRECATED getIndicesWith "Please use indexReaderWith instead." #-}
1305−{-# INLINE getIndicesWith #-}
1306−getIndicesWith :: (Monad m, Unbox a) =>
1307− (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1308−getIndicesWith = indexReaderWith
1309−
13101103-- | Given an unfold that generates array indices, read the elements on those
13111104-- indices from the supplied MutArray. An error is thrown if an index is out of
13121105-- bounds.
13131106--
13141107-- /Pre-release/
1315−{-# INLINE indexReader #-}
1316−indexReader :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1317−indexReader = indexReaderWith liftIO
1318−
1319−-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320−{-# DEPRECATED getIndices "Please use indexReader instead." #-}
13211108{-# INLINE getIndices #-}
13221109getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1110+getIndices = getIndicesWith liftIO
13241111
13251112-------------------------------------------------------------------------------
13261113-- Subarrays
@@ -1615,7 +1402,7 @@ chunksOfAs ps n (D.Stream step state) =
16151402--
16161403-- Same as the following but may be more efficient:
16171404--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1405+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
16191406--
16201407-- /Pre-release/
16211408{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1411,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
16241411-- XXX the idiomatic implementation leads to large regression in the D.reverse'
16251412-- benchmark. It seems it has difficulty producing optimized code when
16261413-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1414+-- chunksOf n = D.foldMany (writeN n)
16281415chunksOf = chunksOfAs Unpinned
16291416
16301417-- | Like 'chunksOf' but creates pinned arrays.
16311418{-# INLINE_NORMAL pinnedChunksOf #-}
16321419pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
16331420 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1421+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
16351422pinnedChunksOf = chunksOfAs Pinned
16361423
16371424-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1451,16 @@ data FlattenState s contents a =
16641451 OuterLoop s
16651452 | InnerLoop s contents !Int !Int
16661453
1667−{-# INLINE_NORMAL concatWith #-}
1668−concatWith :: forall m a. (Monad m, Unbox a)
1669− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1670−concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1454+-- | Use the "reader" unfold instead.
1455+--
1456+-- @concatChunks = unfoldMany reader@
1457+--
1458+-- We can try this if there are any fusion issues in the unfold.
1459+--
1460+{-# INLINE_NORMAL concatChunks #-}
1461+concatChunks :: forall m a. (MonadIO m, Unbox a)
1462+ => D.Stream m (MutArray a) -> D.Stream m a
1463+concatChunks (D.Stream step state) = D.Stream step' (OuterLoop state)
16711464
16721465 where
16731466
@@ -1684,30 +1477,24 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841477 return $ D.Skip $ OuterLoop st
16851478
16861479 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1480+ x <- liftIO $ peekAt p contents
16881481 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891482
1690−-- | Use the "reader" unfold instead.
1483+{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1484+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1485+ => D.Stream m (MutArray a) -> D.Stream m a
1486+flattenArrays = concatChunks
1487+
1488+-- | Use the "readerRev" unfold instead.
16911489--
1692−-- @concat = unfoldMany reader@
1490+-- @concatChunks = unfoldMany readerRev@
16931491--
16941492-- We can try this if there are any fusion issues in the unfold.
16951493--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1494+{-# INLINE_NORMAL concatChunksRev #-}
1495+concatChunksRev :: forall m a. (MonadIO m, Unbox a)
16981496 => D.Stream m (MutArray a) -> D.Stream m a
1699−concat = concatWith liftIO
1700−
1701−{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1704− => D.Stream m (MutArray a) -> D.Stream m a
1705−flattenArrays = concat
1706−
1707−{-# INLINE_NORMAL concatRevWith #-}
1708−concatRevWith :: forall m a. (Monad m, Unbox a)
1709− => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1710−concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
1497+concatChunksRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111498
17121499 where
17131500
@@ -1725,26 +1512,14 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251512 return $ D.Skip $ OuterLoop st
17261513
17271514 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1515+ x <- liftIO $ peekAt p contents
17291516 let cur = INDEX_PREV(p,a)
17301517 return $ D.Yield x (InnerLoop st contents cur start)
17311518
1732−-- | Use the "readerRev" unfold instead.
1733−--
1734−-- @concat = unfoldMany readerRev@
1735−--
1736−-- We can try this if there are any fusion issues in the unfold.
1737−--
1738−{-# INLINE_NORMAL concatRev #-}
1739−concatRev :: forall m a. (MonadIO m, Unbox a)
1740− => D.Stream m (MutArray a) -> D.Stream m a
1741−concatRev = concatRevWith liftIO
1742−
17431519{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
17451520flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17461521 => D.Stream m (MutArray a) -> D.Stream m a
1747−flattenArraysRev = concatRev
1522+flattenArraysRev = concatChunksRev
17481523
17491524-------------------------------------------------------------------------------
17501525-- Unfolds
@@ -1973,7 +1748,7 @@ foldr f z arr = D.foldr f z $ read arr
19731748
19741749-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751750
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1751+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
19771752-- array.
19781753--
19791754-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1757,13 @@ foldr f z arr = D.foldr f z $ read arr
19821757-- Any free space left in the array after appending @n@ elements is lost.
19831758--
19841759-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1760+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1761+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871762 Int
19881763 -> m (MutArray a)
19891764 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1765+writeAppendNUnsafe n action =
1766+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911767
19921768 where
19931769
@@ -2000,7 +1776,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001776 -- otherwise we lose that space.
20011777 arr1 <-
20021778 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1779+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041780 else return arr
20051781 return $ toArrayUnsafe arr1
20061782
@@ -2008,51 +1784,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20081784 liftIO $ pokeAt end contents x
20091785 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101786
2011−{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012−{-# INLINE writeAppendNUnsafe #-}
2013−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2014− Int
2015− -> m (MutArray a)
2016− -> Fold m a (MutArray a)
2017−writeAppendNUnsafe = unsafeAppendN
2018−
20191787-- | Append @n@ elements to an existing array. Any free space left in the array
20201788-- after appending @n@ elements is lost.
20211789--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1790+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231791--
2024−{-# INLINE_NORMAL appendN #-}
2025−appendN :: forall m a. (MonadIO m, Unbox a) =>
2026− Int -> m (MutArray a) -> Fold m a (MutArray a)
2027−appendN n initial = FL.take n (unsafeAppendN n initial)
2028−
2029−-- XXX Deprecate in major
2030−-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031−{-# INLINE writeAppendN #-}
1792+{-# INLINE_NORMAL writeAppendN #-}
20321793writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331794 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1795+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351796
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1797+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371798-- append the input stream. If there is no reserved space available in the
20381799-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391800-- where @oldSize@ is the current size of the array in bytes.
20401801--
20411802-- Note that the returned array may be a mutated version of original array.
20421803--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1804+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441805--
20451806-- /Pre-release/
2046−{-# INLINE appendWith #-}
2047−appendWith :: forall m a. (MonadIO m, Unbox a) =>
2048− (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2049−appendWith sizer = FL.foldlM' (snocWith sizer)
2050−
2051−{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
20521807{-# INLINE writeAppendWith #-}
20531808writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541809 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1810+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561811
20571812-- | @append action@ mutates the array generated by @action@ to append the
20581813-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1815,26 @@ writeAppendWith = appendWith
20601815--
20611816-- Note that the returned array may be a mutated version of original array.
20621817--
2063−-- >>> append = MutArray.appendWith (* 2)
1818+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641819--
2065−{-# INLINE append #-}
2066−append :: forall m a. (MonadIO m, Unbox a) =>
2067− m (MutArray a) -> Fold m a (MutArray a)
2068−append = appendWith (* 2)
2069−
2070−-- XXX Deprecate in major
2071−-- {-# DEPRECATED writeAppend "Please use append instead." #-}
20721820{-# INLINE writeAppend #-}
20731821writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741822 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1823+writeAppend = writeAppendWith (* 2)
20761824
20771825-- XXX We can carry bound as well in the state to make sure we do not lose the
20781826-- remaining capacity. Need to check perf impact.
20791827--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1828+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1829+-- as argument.
20821830--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1831+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841832--
20851833-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1834+{-# INLINE_NORMAL writeNWithUnsafe #-}
1835+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881836 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1837+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901838
20911839 where
20921840
@@ -2097,64 +1845,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20971845 return
20981846 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991847
2100−{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101−{-# INLINE writeNWithUnsafe #-}
2102−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104−writeNWithUnsafe = unsafeCreateOfWith
2105−
21061848{-# INLINE_NORMAL writeNUnsafeAs #-}
21071849writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
21081850 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1851+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
21101852
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1853+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121854-- driver must not call the step function more than 'n' times otherwise it will
21131855-- corrupt the memory and crash. This function exists mainly because any
21141856-- conditional in the step function blocks fusion causing 10x performance
21151857-- slowdown.
21161858--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1859+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
21181860--
2119−{-# INLINE_NORMAL unsafeCreateOf #-}
2120−unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121− => Int -> Fold m a (MutArray a)
2122−unsafeCreateOf = writeNUnsafeAs Unpinned
2123−
2124−{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
2125−{-# INLINE writeNUnsafe #-}
1861+{-# INLINE_NORMAL writeNUnsafe #-}
21261862writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271863 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1864+writeNUnsafe = writeNUnsafeAs Unpinned
21291865
2130−-- | Like 'unsafeCreateOf' but creates a pinned array.
2131−{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132−unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133− => Int -> Fold m a (MutArray a)
2134−unsafePinnedCreateOf = writeNUnsafeAs Pinned
2135−
2136−{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137−{-# INLINE pinnedWriteNUnsafe #-}
1866+-- | Like 'writeNUnsafe' but creates a pinned array.
1867+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
21381868pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
21391869 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1870+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
21411871
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1872+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431873-- allocated using the @alloc@ function.
21441874--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1875+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1876+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471877--
2148−{-# INLINE_NORMAL createOfWith #-}
2149−createOfWith :: forall m a. (MonadIO m, Unbox a)
2150− => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151−createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2152−
2153−-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154−{-# INLINE writeNWith #-}
1878+{-# INLINE_NORMAL writeNWith #-}
21551879writeNWith :: forall m a. (MonadIO m, Unbox a)
21561880 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1881+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21581882
21591883{-# INLINE_NORMAL writeNAs #-}
21601884writeNAs ::
@@ -2162,42 +1886,28 @@ writeNAs ::
21621886 => PinnedState
21631887 -> Int
21641888 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1889+writeNAs ps = writeNWith (newAs ps)
21661890
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1891+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681892-- 'MutArray'.
21691893--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1894+-- >>> writeN = MutArray.writeNWith MutArray.new
1895+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1896+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
21731897--
2174−{-# INLINE_NORMAL createOf #-}
2175−createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176−createOf = writeNAs Unpinned
2177−
2178−-- XXX Deprecate in major
2179−-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180−{-# INLINE writeN #-}
1898+{-# INLINE_NORMAL writeN #-}
21811899writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
1900+writeN = writeNAs Unpinned
21831901
2184−-- | Like 'createOf' but creates a pinned array.
2185−{-# INLINE_NORMAL pinnedCreateOf #-}
2186−pinnedCreateOf ::
2187− forall m a. (MonadIO m, Unbox a)
2188− => Int
2189− -> Fold m a (MutArray a)
2190−pinnedCreateOf = writeNAs Pinned
2191−
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
1902+-- | Like 'writeN' but creates a pinned array.
1903+{-# INLINE_NORMAL pinnedWriteN #-}
21941904pinnedWriteN ::
21951905 forall m a. (MonadIO m, Unbox a)
21961906 => Int
21971907 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1908+pinnedWriteN = writeNAs Pinned
21991909
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1910+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011911--
22021912-- /Internal/
22031913{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1928,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22181928 return
22191929 $ ArrayUnsafe contents ptr end
22201930
2221−-- | Like createOfWith but writes the array in reverse order.
1931+-- | Like writeNWith but writes the array in reverse order.
22221932--
22231933-- /Internal/
22241934{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1936,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261936 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271937writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281938
2229−-- | Like 'createOf' but writes the array in reverse order.
1939+-- | Like writeN but writes the array in reverse order.
22301940--
22311941-- /Pre-release/
2232−{-# INLINE_NORMAL revCreateOf #-}
2233−revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234−revCreateOf = writeRevNWith new
2235−
2236−{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237−{-# INLINE writeRevN #-}
1942+{-# INLINE_NORMAL writeRevN #-}
22381943writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1944+writeRevN = writeRevNWith new
22401945
22411946-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
22421947-- input stream to a 'MutArray' aligned to the given size.
22431948--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1949+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1950+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
22461951--
22471952-- /Pre-release/
22481953--
22491954{-# INLINE_NORMAL pinnedWriteNAligned #-}
22501955pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
22511956 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1957+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
22531958
22541959-- XXX Buffer to a list instead?
22551960
22561961-- | Buffer a stream into a stream of arrays.
22571962--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1963+-- >>> buildChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591964--
22601965-- Breaking an array into an array stream can be useful to consume a large
22611966-- array sequentially such that memory of the array is released incrementatlly.
@@ -2267,10 +1972,9 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22671972{-# INLINE_NORMAL buildChunks #-}
22681973buildChunks :: (MonadIO m, Unbox a) =>
22691974 Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
1975+buildChunks n = FL.many (writeN n) FL.toStreamK
22711976
22721977{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
22741978writeChunks :: (MonadIO m, Unbox a) =>
22751979 Int -> Fold m a (StreamK n (MutArray a))
22761980writeChunks = buildChunks
@@ -2278,29 +1982,29 @@ writeChunks = buildChunks
22781982{-# INLINE_NORMAL writeWithAs #-}
22791983writeWithAs :: forall m a. (MonadIO m, Unbox a)
22801984 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
1985+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
22821986writeWithAs ps elemCount =
22831987 FL.rmapM extract $ FL.foldlM' step initial
22841988
22851989 where
22861990
22871991 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2289− newAs ps elemCount
1992+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1993+ liftIO $ newAs ps elemCount
22901994
22911995 step arr@(MutArray _ start end bound) x
22921996 | INDEX_NEXT(end,a) > bound = do
22931997 let oldSize = end - start
22941998 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
1999+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
22962000 snocUnsafe arr1 x
22972001 step arr x = snocUnsafe arr x
22982002
22992003 extract = liftIO . rightSize
23002004
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
2005+-- XXX Compare writeWith with fromStreamD which uses an array of streams
23022006-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
2007+-- If writeWith is faster then we should use that to implement
23042008-- fromStreamD.
23052009--
23062010-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +2019,39 @@ writeWithAs ps elemCount =
23152019-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23162020-- malloc to compare against.
23172021
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
2022+-- | @writeWith minCount@ folds the whole input to a single array. The array
23192023-- starts at a size big enough to hold minCount elements, the size is doubled
23202024-- every time the array needs to be grown.
23212025--
23222026-- /Caution! Do not use this on infinite streams./
23232027--
2324−-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
2325−-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
2326−-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
2028+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2029+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2030+-- >>> writeWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
23272031--
23282032-- /Pre-release/
2329−{-# INLINE_NORMAL createWith #-}
2330−createWith :: forall m a. (MonadIO m, Unbox a)
2331− => Int -> Fold m a (MutArray a)
2332−-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333−createWith = writeWithAs Unpinned
2334−
2335−{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336−{-# INLINE writeWith #-}
2033+{-# INLINE_NORMAL writeWith #-}
23372034writeWith :: forall m a. (MonadIO m, Unbox a)
23382035 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
2036+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2037+writeWith = writeWithAs Unpinned
23402038
23412039-- | Fold the whole input to a single array.
23422040--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
2041+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23442042-- rounded up to the element size.
23452043--
23462044-- /Caution! Do not use this on infinite streams./
23472045--
2348−{-# INLINE create #-}
2349−create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350−create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2351−
2352−-- XXX Deprecate in major
2353−-- {-# DEPRECATED write "Please use create instead." #-}
23542046{-# INLINE write #-}
23552047write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
2357−
2358−-- | Like 'create' but creates a pinned array.
2359−{-# INLINE pinnedCreate #-}
2360−pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2361−pinnedCreate =
2362− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2048+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23632049
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
2050+-- | Like 'write' but creates a pinned array.
23652051{-# INLINE pinnedWrite #-}
23662052pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2053+pinnedWrite =
2054+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23682055
23692056-------------------------------------------------------------------------------
23702057-- construct from streams, known size
@@ -2374,7 +2061,7 @@ pinnedWrite = pinnedCreate
23742061fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
23752062 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
23762063fromStreamDNAs ps limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
2064+ (arr :: MutArray a) <- liftIO $ newAs ps limit
23782065 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
23792066 return $ arr {arrEnd = end}
23802067
@@ -2384,18 +2071,17 @@ fromStreamDNAs ps limit str = do
23842071 liftIO $ pokeAt ptr arrContents x
23852072 return $ INDEX_NEXT(ptr,a)
23862073
2387−-- | Use the 'createOf' fold instead.
2074+-- | Use the 'writeN' fold instead.
23882075--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2076+-- >>> fromStreamN n = Stream.fold (MutArray.writeN n)
23902077--
23912078{-# INLINE_NORMAL fromStreamN #-}
23922079fromStreamN :: forall m a. (MonadIO m, Unbox a)
23932080 => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2081+-- fromStreamDN n = D.fold (writeN n)
23952082fromStreamN = fromStreamDNAs Unpinned
23962083
23972084{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
23992085fromStreamDN :: forall m a. (MonadIO m, Unbox a)
24002086 => Int -> D.Stream m a -> m (MutArray a)
24012087fromStreamDN = fromStreamN
@@ -2418,20 +2104,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
24182104-- /Pre-release/
24192105{-# INLINE fromListRevN #-}
24202106fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2107+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24222108
24232109-- | Convert a pure stream in Identity monad to a mutable array.
24242110{-# INLINABLE fromPureStreamN #-}
24252111fromPureStreamN :: (MonadIO m, Unbox a) =>
24262112 Int -> Stream Identity a -> m (MutArray a)
24272113fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2114+ liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
24292115
24302116-- | Convert a pure stream in Identity monad to a mutable array.
24312117{-# INLINABLE fromPureStream #-}
24322118fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
24332119fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2120+ liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
24352121
24362122{-# INLINABLE fromPtrN #-}
24372123fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2126,7 @@ fromPtrN len addr = do
24402126 -- XXX We can implement a stream copy in a similar way by streaming Word64
24412127 -- first and then remaining Word8.
24422128 arr <- new len
2443− _ <- unsafeAsPtr arr
2129+ _ <- asUnpinnedPtrUnsafe arr
24442130 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
24452131 return (arr {arrEnd = len})
24462132
@@ -2456,7 +2142,7 @@ fromByteStr# addr = do
24562142 len <- liftIO $ c_strlen (Ptr addr)
24572143 let lenInt = fromIntegral len
24582144 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2145+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
24602146 return (arr {arrEnd = lenInt})
24612147
24622148-------------------------------------------------------------------------------
@@ -2477,7 +2163,7 @@ fromChunksRealloced s = do
24772163 arr <- D.foldlM' spliceExp (pure a) strm
24782164 -- Reallocation is exponential so there may be 50% empty space in
24792165 -- worst case. One more reallocation to reclaim the space.
2480− rightSize arr
2166+ liftIO $ rightSize arr
24812167 Nothing -> pure nil
24822168
24832169-------------------------------------------------------------------------------
@@ -2515,7 +2201,6 @@ fromChunksK :: (Unbox a, MonadIO m) =>
25152201fromChunksK = fromChunkskAs Unpinned
25162202
25172203{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2518−{-# INLINE fromArrayStreamK #-}
25192204fromArrayStreamK :: (Unbox a, MonadIO m) =>
25202205 StreamK m (MutArray a) -> m (MutArray a)
25212206fromArrayStreamK = fromChunksK
@@ -2527,7 +2212,7 @@ fromStreamDAs ps m =
25272212 arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
25282213
25292214-- | 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
2215+-- single array from a stream of unknown size. 'writeN' is at least twice
25312216-- as efficient when the size is already known.
25322217--
25332218-- Note that if the input stream is too large memory allocation for the array
@@ -2539,19 +2224,19 @@ fromStreamDAs ps m =
25392224fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
25402225fromStream = fromStreamDAs Unpinned
25412226
2542−-- fromStream (Stream m) = P.fold create m
2227+-- fromStream (Stream m) = P.fold write m
25432228-- CAUTION: a very large number (millions) of arrays can degrade performance
25442229-- due to GC overhead because we need to buffer the arrays before we flatten
25452230-- all the arrays.
25462231--
2547−-- XXX Compare if this is faster or "fold create".
2232+-- XXX Compare if this is faster or "fold write".
25482233--
25492234-- | We could take the approach of doubling the memory allocation on each
25502235-- overflow. This would result in more or less the same amount of copying as in
25512236-- the chunking approach. However, if we have to shrink in the end then it may
25522237-- result in an extra copy of the entire data.
25532238--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2239+-- >>> fromStreamD = StreamD.fold MutArray.write
25552240--
25562241{-# INLINE fromStreamD #-}
25572242{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
@@ -2581,10 +2266,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
25812266-- Cloning
25822267-------------------------------------------------------------------------------
25832268
2584−-- Arrays are aligned on 64-bit boundaries. The fastest way to copy an array is
2585−-- to unsafeCast it to Word64, read it, write it to Word64 array and unsafeCast
2586−-- it again. We can use SIMD read/write as well.
2587−
25882269{-# INLINE cloneAs #-}
25892270cloneAs ::
25902271 ( MonadIO m
@@ -2594,7 +2275,7 @@ cloneAs ::
25942275 )
25952276 => PinnedState -> MutArray a -> m (MutArray a)
25962277cloneAs ps src =
2597− do
2278+ liftIO $ do
25982279 let startSrc = arrStart src
25992280 srcLen = arrEnd src - startSrc
26002281 newArrContents <-
@@ -2633,16 +2314,17 @@ spliceCopy :: forall m a. MonadIO m =>
26332314 Unbox a =>
26342315#endif
26352316 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2317+spliceCopy arr1 arr2 = liftIO $ do
26372318 let start1 = arrStart arr1
26382319 start2 = arrStart arr2
26392320 len1 = arrEnd arr1 - start1
26402321 len2 = arrEnd arr2 - start2
2641− let len = len1 + len2
2322+ let newLen = len1 + len2
26422323 newArrContents <-
26432324 if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2325+ then Unboxed.pinnedNew newLen
2326+ else Unboxed.new newLen
2327+ let len = len1 + len2
26462328 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
26472329 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
26482330 return $ MutArray newArrContents 0 len len
@@ -2654,7 +2336,7 @@ spliceCopy arr1 arr2 = do
26542336spliceUnsafe :: MonadIO m =>
26552337 MutArray a -> MutArray a -> m (MutArray a)
26562338spliceUnsafe dst src =
2657− do
2339+ liftIO $ do
26582340 let startSrc = arrStart src
26592341 srcLen = arrEnd src - startSrc
26602342 endDst = arrEnd dst
@@ -2676,7 +2358,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762358 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772359spliceWith sizer dst@(MutArray _ start end bound) src = do
26782360{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2361+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802362 in D.fold f (toStreamD src)
26812363-}
26822364 assert (end <= bound) (return ())
@@ -2692,7 +2374,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
26922374 $ "splice: newSize is less than the total size "
26932375 ++ "of arrays being appended. Please check the "
26942376 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2377+ liftIO $ realloc newSizeInBytes dst
26962378 else return dst
26972379 spliceUnsafe dst1 src
26982380
@@ -2744,7 +2426,7 @@ splitOn predicate arr =
27442426{-# INLINE breakOn #-}
27452427breakOn :: MonadIO m
27462428 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2429+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
27482430 -- XXX We do not need memchr here, we can use a Haskell equivalent.
27492431 -- Need efficient stream based primitives that work on Word64.
27502432 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2449,33 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672449 }
27682450 )
27692451
2770−-- | Like 'splitAt' but does not check whether the index is valid.
2771−--
2772−{-# INLINE unsafeSplitAt #-}
2773−unsafeSplitAt :: forall a. Unbox a =>
2774− Int -> MutArray a -> (MutArray a, MutArray a)
2775−unsafeSplitAt i MutArray{..} =
2776− let off = i * SIZE_OF(a)
2777− p = arrStart + off
2778− in ( MutArray
2779− { arrContents = arrContents
2780− , arrStart = arrStart
2781− , arrEnd = p
2782− , arrBound = p
2783− }
2784− , MutArray
2785− { arrContents = arrContents
2786− , arrStart = p
2787− , arrEnd = arrEnd
2788− , arrBound = arrBound
2789− }
2790− )
2791−
27922452-- | Create two slices of an array without copying the original array. The
27932453-- specified index @i@ is the first index of the second slice.
27942454--
27952455{-# INLINE splitAt #-}
27962456splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2457+splitAt i arr@MutArray{..} =
27982458 let maxIndex = length arr - 1
27992459 in if i < 0
28002460 then error "sliceAt: negative array index"
28012461 else if i > maxIndex
28022462 then error $ "sliceAt: specified array index " ++ show i
28032463 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2464+ else let off = i * SIZE_OF(a)
2465+ p = arrStart + off
2466+ in ( MutArray
2467+ { arrContents = arrContents
2468+ , arrStart = arrStart
2469+ , arrEnd = p
2470+ , arrBound = p
2471+ }
2472+ , MutArray
2473+ { arrContents = arrContents
2474+ , arrStart = p
2475+ , arrEnd = arrEnd
2476+ , arrBound = arrBound
2477+ }
2478+ )
28052479
28062480-------------------------------------------------------------------------------
28072481-- Casting
@@ -2851,13 +2525,9 @@ cast arr =
28512525-- guarantees that unsafe calls will be performed in the calling thread. Making
28522526-- it safe to pass heap-allocated objects to unsafe functions.
28532527
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2528+-- Should we just name it asPtr, the unsafety is implicit for any pointer
28552529-- operations. And we are safe from Haskell perspective because we will be
28562530-- pinning the memory.
2857−--
2858−-- XXX we cannot pass the length of the ptr here as in some cases it may not be
2859−-- available e.g. a null terminated C string. However, we can create another
2860−-- flavor of the API e.g. asPtrN.
28612531
28622532-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
28632533-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2545,16 @@ cast arr =
28752545--
28762546-- /Pre-release/
28772547--
2878−{-# INLINE unsafePinnedAsPtr #-}
2879−unsafePinnedAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2880−unsafePinnedAsPtr arr f =
2881− Unboxed.unsafePinnedAsPtr
2882− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2883−
2884−{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
28852548{-# INLINE asPtrUnsafe #-}
28862549asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2550+asPtrUnsafe arr f =
2551+ Unboxed.asPtrUnsafe
2552+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28882553
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2892− Unboxed.unsafeAsPtr
2554+{-# INLINE asUnpinnedPtrUnsafe #-}
2555+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2556+asUnpinnedPtrUnsafe arr f =
2557+ Unboxed.asUnpinnedPtrUnsafe
28932558 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28942559
28952560-------------------------------------------------------------------------------
@@ -2907,26 +2572,28 @@ unsafeAsPtr arr f =
29072572-- /Pre-release/
29082573{-# INLINE byteCmp #-}
29092574byteCmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2910−byteCmp arr1 arr2 = do
2911− let marr1 = getMutableByteArray# (arrContents arr1)
2912− marr2 = getMutableByteArray# (arrContents arr2)
2913− !(I# st1#) = arrStart arr1
2914− !(I# st2#) = arrStart arr2
2915− !(I# len#) = byteLength arr1
2916− case compare (byteLength arr1) (byteLength arr2) of
2917− EQ -> do
2918− r <- liftIO $ IO $ \s# ->
2919− let res =
2920− I#
2921− (compareByteArrays#
2922− (unsafeCoerce# marr1)
2923− st1#
2924− (unsafeCoerce# marr2)
2925− st2#
2926− len#)
2927− in (# s#, res #)
2928− return $ compare r 0
2929− x -> return x
2575+byteCmp arr1 arr2 =
2576+ liftIO
2577+ $ do
2578+ let marr1 = getMutableByteArray# (arrContents arr1)
2579+ marr2 = getMutableByteArray# (arrContents arr2)
2580+ !(I# st1#) = arrStart arr1
2581+ !(I# st2#) = arrStart arr2
2582+ !(I# len#) = byteLength arr1
2583+ case compare (byteLength arr1) (byteLength arr2) of
2584+ EQ -> do
2585+ r <- liftIO $ IO $ \s# ->
2586+ let res =
2587+ I#
2588+ (compareByteArrays#
2589+ (unsafeCoerce# marr1)
2590+ st1#
2591+ (unsafeCoerce# marr2)
2592+ st2#
2593+ len#)
2594+ in (# s#, res #)
2595+ return $ compare r 0
2596+ x -> return x
29302597
29312598{-# INLINE cmp #-}
29322599{-# DEPRECATED cmp "Please use byteCmp instead." #-}
@@ -2946,48 +2613,46 @@ byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
29462613-- Compact
29472614-------------------------------------------------------------------------------
29482615
2949−-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2950−-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2951−-- can leave some memory unused. They can split the last array to fit it
2952−-- exactly in the space.
2953−
2954−{-# INLINE_NORMAL pCompactLeAs #-}
2955−pCompactLeAs ::
2616+-- | Parser @pCompactChunksLE n@ coalesces adjacent arrays in the input stream
2617+-- only if the combined size would be less than or equal to n.
2618+--
2619+-- /Internal/
2620+{-# INLINE_NORMAL pCompactChunksLE #-}
2621+pCompactChunksLE ::
29562622 forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2623+ => Int -> Parser (MutArray a) m (MutArray a)
2624+pCompactChunksLE n = Parser step initial extract
29592625
29602626 where
29612627
2962− maxBytes = maxElems * SIZE_OF(a)
2628+ nBytes = n * SIZE_OF(a)
29632629
2964− functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2630+ functionName = "Streamly.Internal.Data.MutArray.pCompactChunksLE"
29652631
29662632 initial =
29672633 return
2968− $ if maxElems <= 0
2634+ $ if n <= 0
29692635 then error
29702636 $ functionName
29712637 ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2638+ ++ show n ++ "] must be a natural number"
29732639 else Parser.IPartial Nothing
29742640
29752641 step Nothing arr =
29762642 return
29772643 $ let len = byteLength arr
2978− in if len >= maxBytes
2644+ in if len >= nBytes
29792645 then Parser.Done 0 arr
29802646 else Parser.Partial 0 (Just arr)
2981− -- XXX Split the last array to use the space more compactly.
29822647 step (Just buf) arr =
29832648 let len = byteLength buf + byteLength arr
2984− in if len > maxBytes
2649+ in if len > nBytes
29852650 then return $ Parser.Done 1 buf
29862651 else do
2652+ -- XXX check this in the Nothing case
29872653 buf1 <-
2988− if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2654+ if byteCapacity buf < nBytes
2655+ then liftIO $ realloc nBytes buf
29912656 else return buf
29922657 buf2 <- spliceUnsafe buf1 arr
29932658 return $ Parser.Partial 0 (Just buf2)
@@ -2995,30 +2660,6 @@ pCompactLeAs ps maxElems = Parser step initial extract
29952660 extract Nothing = return $ Parser.Done 0 nil
29962661 extract (Just buf) = return $ Parser.Done 0 buf
29972662
2998−-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2999−-- only if the combined size would be less than or equal to @maxElems@
3000−-- elements. Note that it won't split an array if the original array is already
3001−-- larger than maxElems.
3002−--
3003−-- @maxElems@ must be greater than 0.
3004−--
3005−-- Generates unpinned arrays irrespective of the pinning status of input
3006−-- arrays.
3007−--
3008−-- /Internal/
3009−{-# INLINE pCompactLE #-}
3010−pCompactLE ::
3011− forall m a. (MonadIO m, Unbox a)
3012− => Int -> Parser (MutArray a) m (MutArray a)
3013−pCompactLE = pCompactLeAs Unpinned
3014−
3015−-- | Pinned version of 'pCompactLE'.
3016−{-# INLINE pPinnedCompactLE #-}
3017−pPinnedCompactLE ::
3018− forall m a. (MonadIO m, Unbox a)
3019− => Int -> Parser (MutArray a) m (MutArray a)
3020−pPinnedCompactLE = pCompactLeAs Pinned
3021−
30222663data SpliceState s arr
30232664 = SpliceInitial s
30242665 | SpliceBuffering s arr
@@ -3030,47 +2671,48 @@ data SpliceState s arr
30302671-- immutable array never has additional space so a new array is allocated
30312672-- instead of mutating it.
30322673
3033−{-# INLINE_NORMAL compactLeAs #-}
3034−compactLeAs :: forall m a. (MonadIO m, Unbox a)
3035− => PinnedState -> Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
3036−compactLeAs ps maxElems (D.Stream step state) =
2674+-- | Scan @rCompactChunksLE n@ coalesces adjacent arrays in the input stream
2675+-- only if the combined size would be less than or equal to n.
2676+--
2677+-- /Internal/
2678+{-# INLINE_NORMAL rCompactChunksLE #-}
2679+rCompactChunksLE :: (MonadIO m, Unbox a)
2680+ => Int -> D.Stream m (MutArray a) -> D.Stream m (MutArray a)
2681+rCompactChunksLE n (D.Stream step state) =
30372682 D.Stream step' (SpliceInitial state)
30382683
30392684 where
30402685
3041− maxBytes = maxElems * SIZE_OF(a)
3042−
3043− functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
2686+ functionName = "Streamly.Internal.Data.MutArray.rCompactChunksLE"
30442687
30452688 {-# INLINE_LATE step' #-}
30462689 step' gst (SpliceInitial st) = do
3047− when (maxElems <= 0) $
2690+ when (n <= 0) $
30482691 -- XXX we can pass the module string from the higher level API
3049− error $ functionName ++ ": the size of arrays [" ++ show maxElems
2692+ error $ functionName ++ ": the size of arrays [" ++ show n
30502693 ++ "] must be a natural number"
30512694 r <- step gst st
30522695 case r of
30532696 D.Yield arr s -> return $
30542697 let len = byteLength arr
3055− in if len >= maxBytes
2698+ in if len >= n
30562699 then D.Skip (SpliceYielding arr (SpliceInitial s))
30572700 else D.Skip (SpliceBuffering s arr)
30582701 D.Skip s -> return $ D.Skip (SpliceInitial s)
30592702 D.Stop -> return D.Stop
30602703
3061− -- XXX Split the last array to use the space more compactly.
30622704 step' gst (SpliceBuffering st buf) = do
30632705 r <- step gst st
30642706 case r of
30652707 D.Yield arr s -> do
30662708 let len = byteLength buf + byteLength arr
3067− if len > maxBytes
2709+ if len > n
30682710 then return $
30692711 D.Skip (SpliceYielding buf (SpliceBuffering s arr))
30702712 else do
3071− buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
2713+ -- XXX check this in the SpliceInitial case
2714+ buf1 <- if byteCapacity buf < n
2715+ then liftIO $ realloc n buf
30742716 else return buf
30752717 buf2 <- spliceUnsafe buf1 arr
30762718 return $ D.Skip (SpliceBuffering s buf2)
@@ -3081,124 +2723,113 @@ compactLeAs ps maxElems (D.Stream step state) =
30812723
30822724 step' _ (SpliceYielding arr next) = return $ D.Yield arr next
30832725
3084−
3085−{-# INLINE_NORMAL fCompactGeAs #-}
3086−fCompactGeAs ::
2726+-- | Fold @fCompactChunksGE n@ coalesces adjacent arrays in the input stream
2727+-- until the size becomes greater than or equal to n.
2728+--
2729+{-# INLINE_NORMAL fCompactChunksGE #-}
2730+fCompactChunksGE ::
30872731 forall m a. (MonadIO m, Unbox a)
3088− => PinnedState -> Int -> FL.Fold m (MutArray a) (MutArray a)
3089−fCompactGeAs ps minElems = Fold step initial extract extract
2732+ => Int -> FL.Fold m (MutArray a) (MutArray a)
2733+fCompactChunksGE n = Fold step initial extract extract
30902734
30912735 where
30922736
3093− minBytes = minElems * SIZE_OF(a)
2737+ nBytes = n * SIZE_OF(a)
30942738
3095− functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
2739+ functionName = "Streamly.Internal.Data.MutArray.fCompactChunksGE"
30962740
30972741 initial =
30982742 return
3099− $ if minElems < 0
2743+ $ if n < 0
31002744 then error
31012745 $ functionName
31022746 ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
2747+ ++ show n ++ "] must be a natural number"
31042748 else FL.Partial Nothing
31052749
31062750 step Nothing arr =
31072751 return
31082752 $ let len = byteLength arr
3109− in if len >= minBytes
2753+ in if len >= nBytes
31102754 then FL.Done arr
31112755 else FL.Partial (Just arr)
3112− -- XXX Buffer arrays as a list to avoid copy and reallocations
31132756 step (Just buf) arr = do
31142757 let len = byteLength buf + byteLength arr
31152758 buf1 <-
31162759 if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
2760+ then liftIO $ realloc (max len nBytes) buf
31192761 else return buf
31202762 buf2 <- spliceUnsafe buf1 arr
3121− if len >= minBytes
2763+ if len >= n
31222764 then return $ FL.Done buf2
31232765 else return $ FL.Partial (Just buf2)
31242766
31252767 extract Nothing = return nil
31262768 extract (Just buf) = return buf
31272769
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
2770+-- | Like 'compactChunksGE' but for transforming folds instead of stream.
31302771--
3131−-- Generates unpinned arrays irrespective of the pinning status of input
3132−-- arrays.
3133−{-# INLINE fCompactGE #-}
3134−fCompactGE ::
3135− forall m a. (MonadIO m, Unbox a)
3136− => Int -> FL.Fold m (MutArray a) (MutArray a)
3137−fCompactGE = fCompactGeAs Unpinned
3138−
3139−-- | Pinned version of 'fCompactGE'.
3140−{-# INLINE fPinnedCompactGE #-}
3141−fPinnedCompactGE ::
3142− forall m a. (MonadIO m, Unbox a)
3143− => Int -> FL.Fold m (MutArray a) (MutArray a)
3144−fPinnedCompactGE = fCompactGeAs Pinned
3145−
3146−{-# INLINE_NORMAL lCompactGeAs #-}
3147−lCompactGeAs :: forall m a. (MonadIO m, Unbox a)
3148− => PinnedState -> Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3149−-- The fold version turns out to be a little bit slower.
3150−-- lCompactGeAs ps n = FL.many (fCompactGeAs ps n)
3151−lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
2772+-- >>> lCompactChunksGE n = Fold.many (MutArray.fCompactChunksGE n)
2773+--
2774+{-# INLINE_NORMAL lCompactChunksGE #-}
2775+lCompactChunksGE :: (MonadIO m, Unbox a)
2776+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
2777+-- lCompactChunksGE n = Fold.many (fCompactChunksGE n)
2778+lCompactChunksGE n (Fold step1 initial1 _ final1) =
31522779 Fold step initial extract final
31532780
31542781 where
31552782
3156− minBytes = minElems * SIZE_OF(a)
3157−
3158− functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
2783+ functionName = "Streamly.Internal.Data.MutArray.lCompactChunksGE"
31592784
31602785 initial = do
3161− when (minElems <= 0) $
2786+ when (n <= 0) $
31622787 -- XXX we can pass the module string from the higher level API
31632788 error $ functionName ++ ": the size of arrays ["
3164− ++ show minElems ++ "] must be a natural number"
2789+ ++ show n ++ "] must be a natural number"
31652790
31662791 r <- initial1
31672792 return $ first (Tuple' Nothing) r
31682793
3169− {-# INLINE runInner #-}
3170− runInner len acc buf =
3171− if len >= minBytes
2794+ step (Tuple' Nothing r1) arr =
2795+ let len = byteLength arr
2796+ in if len >= n
2797+ then do
2798+ r <- step1 r1 arr
2799+ case r of
2800+ FL.Done _ -> return $ FL.Done ()
2801+ FL.Partial s -> do
2802+ _ <- final1 s
2803+ res <- initial1
2804+ return $ first (Tuple' Nothing) res
2805+ else return $ FL.Partial $ Tuple' (Just arr) r1
2806+
2807+ step (Tuple' (Just buf) r1) arr = do
2808+ let len = byteLength buf + byteLength arr
2809+ buf1 <- if byteCapacity buf < len
2810+ then liftIO $ realloc (max n len) buf
2811+ else return buf
2812+ buf2 <- spliceUnsafe buf1 arr
2813+
2814+ -- XXX this is common in both the equations of step
2815+ if len >= n
31722816 then do
3173− r <- step1 acc buf
2817+ r <- step1 r1 buf2
31742818 case r of
31752819 FL.Done _ -> return $ FL.Done ()
31762820 FL.Partial s -> do
31772821 _ <- final1 s
31782822 res <- initial1
31792823 return $ first (Tuple' Nothing) res
3180− else return $ FL.Partial $ Tuple' (Just buf) acc
3181−
3182− step (Tuple' Nothing r1) arr =
3183− runInner (byteLength arr) r1 arr
3184−
3185− -- XXX Buffer arrays as a list to avoid copy and reallocations
3186− step (Tuple' (Just buf) r1) arr = do
3187− let len = byteLength buf + byteLength arr
3188− buf1 <- if byteCapacity buf < len
3189− then liftIO $ reallocExplicitAs
3190− ps (SIZE_OF(a)) (max minBytes len) buf
3191− else return buf
3192− buf2 <- spliceUnsafe buf1 arr
3193− runInner len r1 buf2
2824+ else return $ FL.Partial $ Tuple' (Just buf2) r1
31942825
31952826 -- 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
2827+ -- return "m b" rather than using extract post it if we want extract to be
31972828 -- partial.
31982829 --
31992830 -- extract forces the pending buffer to be sent to the fold which is not
32002831 -- what we want.
3201− extract _ = error "lCompactGE: not designed for scanning"
2832+ extract _ = error "lCompactChunksGE: not designed for scanning"
32022833
32032834 final (Tuple' Nothing r1) = final1 r1
32042835 final (Tuple' (Just buf) r1) = do
@@ -3207,42 +2838,25 @@ lCompactGeAs ps minElems (Fold step1 initial1 _ final1) =
32072838 FL.Partial rr -> final1 rr
32082839 FL.Done _ -> return ()
32092840
3210−-- | Like 'compactGE' but for transforming folds instead of stream.
3211−--
3212−-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3213−--
3214−-- Generates unpinned arrays irrespective of the pinning status of input
3215−-- arrays.
3216−{-# INLINE lCompactGE #-}
3217−lCompactGE :: forall m a. (MonadIO m, Unbox a)
3218− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3219−lCompactGE = lCompactGeAs Unpinned
3220−
3221−-- | Pinned version of 'lCompactGE'.
3222−{-# INLINE lPinnedCompactGE #-}
3223−lPinnedCompactGE :: forall m a. (MonadIO m, Unbox a)
3224− => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3225−lPinnedCompactGE = lCompactGeAs Pinned
3226−
3227−-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
2841+-- | @compactChunksGE n stream@ coalesces adjacent arrays in the @stream@ until
32282842-- the size becomes greater than or equal to @n@.
32292843--
3230−-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
2844+-- >>> compactChunksGE n = Stream.foldMany (MutArray.fCompactChunksGE n)
32312845--
3232−{-# INLINE compactGE #-}
3233−compactGE ::
2846+{-# INLINE compactChunksGE #-}
2847+compactChunksGE ::
32342848 (MonadIO m, Unbox a)
32352849 => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236−compactGE n = D.foldMany (fCompactGE n)
2850+compactChunksGE n = D.foldMany (fCompactChunksGE n)
32372851
3238−-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
2852+-- | 'compactChunksEQ n' coalesces adajacent arrays in the input stream to
32392853-- arrays of exact size @n@.
32402854--
32412855-- /Unimplemented/
3242−{-# INLINE compactEQ #-}
3243−compactEQ :: -- (MonadIO m, Unbox a) =>
2856+{-# INLINE compactChunksEQ #-}
2857+compactChunksEQ :: -- (MonadIO m, Unbox a) =>
32442858 Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3245−compactEQ _n = undefined -- D.parseManyD (pCompactEQ n)
2859+compactChunksEQ _n = undefined -- D.parseManyD (pCompactChunksEQ n)
32462860
32472861-------------------------------------------------------------------------------
32482862-- In-place mutation algorithms