@@ -31,57 +31,39 @@ module Streamly.Internal.Data.MutArray.Type
3131 -- ** Type
3232 -- $arrayNotes
3333 MutArray (..)
34−
35− -- ** Conversion
36− -- *** Pinned and Unpinned
34+ , MutByteArray
35+ , MutableByteArray
3736 , pin
3837 , unpin
3938 , isPinned
4039
41− -- ** Casting
42− , cast
43− , castUnsafe -- XXX unsafeCast
44− , asBytes
45− , unsafePinnedAsPtr
46− , unsafeAsPtr
47−
40+ -- -- * Constructing and Writing
4841 -- ** Construction
49− , empty
50−
51− -- *** New
52− -- | New arrays are always empty arrays with some reserve capacity to
53− -- extend the length without reallocating.
54− , emptyOf
55− , newArrayWith -- emptyAlignedWith
56− , pinnedEmptyOf
57− , pinnedNewAligned -- XXX not required
58− -- , new -- uninitialized array of specified length
59−
60− -- *** Cloning
61− , clone
62− , pinnedClone
42+ , nil
6343
64− -- *** Slicing
65− -- | Get a subarray without copying
66− , getSliceUnsafe -- XXX unsafeGetSlice
67− , getSlice
68− , splitAt -- XXX should be able to express using getSlice
69− , breakOn
44+ -- *** Uninitialized Arrays
45+ , pinnedNew
46+ , pinnedNewBytes
47+ , pinnedNewAligned
48+ , new
49+ , newArrayWith
7050
71− -- *** Stream Folds
51+ -- *** From streams
7252 , ArrayUnsafe (..)
73− , unsafeCreateOfWith
74− , unsafeCreateOf
75− , unsafePinnedCreateOf
76− , pinnedCreateOf
77− , createOfWith
78− , createOf
79− , revCreateOf
80−
81− , pinnedCreate
82− , createWith
83− , create
84− -- , revCreate
53+ , writeNWithUnsafe
54+ , writeNWith
55+ , writeNUnsafe
56+ , pinnedWriteNUnsafe
57+ , writeN
58+ , pinnedWriteN
59+ , pinnedWriteNAligned
60+
61+ , writeWith
62+ , write
63+ , pinnedWrite
64+
65+ , writeRevN
66+ -- , writeRev
8567
8668 -- *** From containers
8769 , fromListN
@@ -90,18 +72,16 @@ module Streamly.Internal.Data.MutArray.Type
9072 , pinnedFromList
9173 , fromListRevN
9274 , fromListRev
93− , fromStreamN
94− , fromStream
75+ , fromStreamDN
76+ , fromStreamD
9577 , fromPureStreamN
9678 , fromPureStream
9779 , fromByteStr#
9880 , fromPtrN
99− , fromChunksK
100− , fromChunksRealloced -- fromSmallChunks
10181
10282 -- ** Random writes
10383 , putIndex
104− , putIndexUnsafe -- XXX unsafePutIndex
84+ , putIndexUnsafe
10585 , putIndices
10686 -- , putFromThenTo
10787 -- , putFrom -- start writing at the given position
@@ -109,69 +89,76 @@ module Streamly.Internal.Data.MutArray.Type
10989 -- , putFromTo
11090 -- , putFromRev
11191 -- , putUptoRev
112− , modifyIndexUnsafe -- XXX unsafeModifyIndex
92+ , modifyIndexUnsafe
11393 , modifyIndex
11494 , modifyIndices
11595 , modify
11696 , swapIndices
11797 , unsafeSwapIndices
11898
119− -- ** Reading
99+ -- ** Growing and Shrinking
100+ -- | Arrays grow only at the end, though it is possible to grow on both sides
101+ -- and therefore have a cons as well as snoc. But that will require two
102+ -- bounds in the array representation.
120103
121− -- *** Indexing
122− , getIndex
123− , getIndexUnsafe -- XXX unsafeGetIndex
124− -- , getFromThenTo
125− , getIndexRev -- getRevIndex?
126− , indexReader
127− , indexReaderWith
104+ -- *** Appending elements
105+ , snocWith
106+ , snoc
107+ , snocLinear
108+ , snocMay
109+ , snocUnsafe
128110
129− -- *** To Streams
111+ -- *** Appending streams
112+ , writeAppendNUnsafe
113+ , writeAppendN
114+ , writeAppendWith
115+ , writeAppend
116+
117+ -- ** Eliminating and Reading
118+
119+ -- *** To streams
120+ , reader
121+ , readerRevWith
122+ , readerRev
123+
124+ -- *** To containers
125+ , toStreamDWith
126+ , toStreamDRevWith
127+ , toStreamKWith
128+ , toStreamKRevWith
130129 , read
131130 , readRev
132− , toStreamWith
133− , toStreamRevWith
134131 , toStreamK
135− , toStreamKWith
136132 , toStreamKRev
137− , toStreamKRevWith
138−
139− -- *** To Containers
140133 , toList
141134
142− -- *** Unfolds
143135 -- experimental
144136 , producerWith
145137 , producer
146138
147− , reader
148− , readerRevWith
149− , readerRev
150−
151− -- ** Size and Capacity
152− -- *** Size
153− , length
154− , byteLength
155−
156− -- *** Capacity
157− -- , capacity
158− , byteCapacity
159− , bytesFree
139+ -- *** Random reads
140+ , getIndex
141+ , getIndexUnsafe
142+ , getIndices
143+ , getIndicesD
144+ -- , getFromThenTo
145+ , getIndexRev
160146
161− -- *** Capacity Management
147+ -- ** Memory Management
162148 , blockSize
163149 , arrayChunkBytes
164150 , allocBytesToElemCount
165− , realloc -- this is "resize"
166− , grow
167− , growExp
151+ , realloc
152+ , resize
153+ , resizeExp
168154 , rightSize
169155
170− -- ** Folding
171− , foldl'
172− , foldr
173− , byteCmp
174− , byteEq
156+ -- ** Size
157+ , length
158+ , byteLength
159+ -- , capacity
160+ , byteCapacity
161+ , bytesFree
175162
176163 -- ** In-place Mutation Algorithms
177164 , strip
@@ -183,121 +170,65 @@ module Streamly.Internal.Data.MutArray.Type
183170 , mergeBy
184171 , bubble
185172
186− -- ** Growing and Shrinking
187− -- | Arrays grow only at the end, though it is possible to grow on both
188− -- sides and therefore have a cons as well as snoc. But that will require
189− -- both lower and upper bound in the array representation.
190−
191− -- *** Appending elements
192− , snocWith
193− , snoc
194− , snocLinear
195− , snocMay
196− , snocUnsafe -- XXX unsafeSnoc
197−
198− -- *** Appending streams
199− , unsafeAppendN
200− , appendN
201− , appendWith
202− , append
203−
204− -- *** Appending arrays
205− , spliceCopy
206− , spliceWith
207− , splice
208− , spliceExp
209− , spliceUnsafe -- XXX unsafeSplice
210− -- , putSlice
211− -- , appendSlice
212− -- , appendSliceFrom
213−
214− -- ** Serialization using Unbox
215− , pokeAppend
216− , pokeAppendMay
217− , pokeSkipUnsafe -- unsafePokeSkip
173+ -- ** Casting
174+ , cast
175+ , castUnsafe
176+ , asBytes
177+ , asPtrUnsafe
178+ , asUnpinnedPtrUnsafe
218179
219− -- ** Deserialization using Unbox
220− , peekUncons
221− , peekUnconsUnsafe -- unsafePeekUncons
222− , peekSkipUnsafe -- unsafePeekSkip
180+ -- ** Folding
181+ , foldl'
182+ , foldr
183+ , cmp
184+ , byteCmp
185+ , byteEq
223186
224− -- Arrays of arrays
187+ -- ** Arrays of arrays
225188 -- We can add dimensionality parameter to the array type to get
226189 -- multidimensional arrays. Multidimensional arrays would just be a
227190 -- convenience wrapper on top of single dimensional arrays.
228191
229− -- ** Streams of Arrays
230− -- *** Chunk
231− -- | Group a stream into arrays.
192+ -- | Operations dealing with multiple arrays, streams of arrays or
193+ -- multidimensional array representations.
194+
195+ -- *** Construct from streams
232196 , chunksOf
233197 , pinnedChunksOf
234− , buildChunks
198+ , writeChunks
235199
236− -- *** Split
237− -- | Split an array into slices.
200+ -- *** Eliminate to streams
201+ , flattenArrays
202+ , flattenArraysRev
203+ , fromArrayStreamK
238204
205+ -- *** Construct from arrays
206+ -- get chunks without copying
207+ , getSliceUnsafe
208+ , getSlice
239209 -- , getSlicesFromLenN
240− , splitOn
241− -- , slicesOf
242−
243− -- *** Concat
244− -- | Append the arrays in a stream to form a stream of elements.
245− , concatWith
246− , concatRevWith
247− , concat
248− , concatRev
249−
250− -- *** Compact
251− -- | Append the arrays in a stream to form a stream of larger arrays.
252− , SpliceState (..)
253− , pCompactLE
254− , pPinnedCompactLE
255− , compactLeAs
256− , fCompactGE
257− , fPinnedCompactGE
258− , lCompactGE
259− , lPinnedCompactGE
260− , compactGE
261− , compactEQ
210+ , splitAt -- XXX should be able to express using getSlice
211+ , breakOn
212+
213+ -- ** Cloning arrays
214+ , clone
215+ , pinnedClone
216+
217+ -- ** Appending arrays
218+ , spliceCopy
219+ , spliceWith
220+ , splice
221+ , spliceExp
222+ , spliceUnsafe
223+ -- , putSlice
224+ -- , appendSlice
225+ -- , appendSliceFrom
262226
263227 -- ** Utilities
264228 , roundUpToPower2
265229 , memcpy
266230 , memcmp
267231 , c_memchr
268−
269− -- * Deprecated
270− , asPtrUnsafe
271− , writeChunks
272− , flattenArrays
273− , flattenArraysRev
274− , fromArrayStreamK
275− , fromStreamDN
276− , fromStreamD
277− , 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
301232 )
302233where
303234
@@ -308,7 +239,6 @@ where
308239
309240import Control.Monad (when, void)
310241import Control.Monad.IO.Class (MonadIO(..))
311−import Data.Bifunctor (first)
312242import Data.Bits (shiftR, (.|.), (.&.))
313243import Data.Functor.Identity (Identity(..))
314244import Data.Proxy (Proxy(..))
@@ -317,6 +247,7 @@ import Foreign.C.Types (CSize(..), CInt(..))
317247import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
318248import Streamly.Internal.Data.MutByteArray.Type
319249 ( MutByteArray(..)
250+ , MutableByteArray
320251 , PinnedState(..)
321252 , getMutableByteArray#
322253 , putSliceUnsafe
@@ -335,17 +266,13 @@ import GHC.Ptr (Ptr(..))
335266import Streamly.Internal.Data.Fold.Type (Fold(..))
336267import Streamly.Internal.Data.Producer.Type (Producer (..))
337268import Streamly.Internal.Data.Stream.Type (Stream)
338−import Streamly.Internal.Data.Parser.Type (Parser (..))
339269import Streamly.Internal.Data.StreamK.Type (StreamK)
340270import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341−import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
342271import Streamly.Internal.Data.Unfold.Type (Unfold(..))
343272import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
344273
345274import qualified Streamly.Internal.Data.Fold.Type as FL
346275import qualified Streamly.Internal.Data.MutByteArray.Type as Unboxed
347−import qualified Streamly.Internal.Data.Parser.Type as Parser
348−-- import qualified Streamly.Internal.Data.Fold.Type as Fold
349276import qualified Streamly.Internal.Data.Producer as Producer
350277import qualified Streamly.Internal.Data.Stream.Type as D
351278import qualified Streamly.Internal.Data.Stream.Lift as D
@@ -353,7 +280,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
353280import qualified Prelude
354281
355282import Prelude hiding
356− (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
283+ (Foldable(..), read, unlines, splitAt, reverse, truncate)
357284
358285#include "DocTestDataMutArray.hs"
359286
@@ -479,8 +406,6 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
479406-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
480407-- allocatePinned in GHC source.
481408
482−-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483−
484409-- | @newArrayWith allocator alignment count@ allocates a new array of zero
485410-- length and with a capacity to hold @count@ elements, using @allocator
486411-- size alignment@ as the memory allocator function.
@@ -504,25 +429,12 @@ newArrayWith alloc alignSize count = do
504429 , arrBound = size
505430 }
506431
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." #-}
520432nil ::
521433#ifdef DEVBUILD
522434 Unbox a =>
523435#endif
524436 MutArray a
525−nil = empty
437+nil = MutArray Unboxed.nil 0 0 0
526438
527439{-# INLINE newBytesAs #-}
528440newBytesAs :: MonadIO m =>
@@ -539,13 +451,12 @@ newBytesAs ps bytes = do
539451 , arrBound = bytes
540452 }
541453
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.
454+-- | Allocates a pinned empty array that can hold 'count' items. The memory of
455+-- the array is uninitialized and the allocation is aligned as per the
456+-- 'Unboxed' instance of the type.
545457--
546458-- /Pre-release/
547459{-# INLINE pinnedNewBytes #-}
548−{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
549460pinnedNewBytes :: MonadIO m =>
550461#ifdef DEVBUILD
551462 Unbox a =>
@@ -570,31 +481,21 @@ newAs ps =
570481 (error "new: alignment is not used in unpinned arrays.")
571482
572483-- 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." #-}
484+--
485+-- | Allocates an empty pinned array that can hold 'count' items. The memory of
486+-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
487+-- instance of the type.
488+--
582489{-# INLINE pinnedNew #-}
583490pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
584−pinnedNew = pinnedEmptyOf
491+pinnedNew = newAs Pinned
585492
586−-- | Allocates an unpinned array of zero length but growable to the specified
587−-- capacity without reallocation.
493+-- | Allocates an empty unpinned array that can hold 'count' items. The memory
494+-- of the array is uninitialized.
588495--
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." #-}
595496{-# INLINE new #-}
596497new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
597−new = emptyOf
498+new = newAs Unpinned
598499
599500-------------------------------------------------------------------------------
600501-- Random writes
@@ -642,7 +543,7 @@ putIndices arr = FL.foldlM' step (return ())
642543
643544 where
644545
645− step () (i, x) = putIndex i arr x
546+ step () (i, x) = liftIO (putIndex i arr x)
646547
647548-- | Modify a given index of an array using a modifier function.
648549--
@@ -838,19 +739,22 @@ arrayChunkBytes = 1024
838739roundDownTo :: Int -> Int -> Int
839740roundDownTo elemSize size = size - (size `mod` elemSize)
840741
742+-- XXX See if resizing can be implemented by reading the old array as a stream
743+-- and then using writeN to the new array.
744+--
841745-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
842746-- Since this is not inlined Unboxed consrraint leads to dictionary passing
843747-- which complicates some inspection tests.
844748--
845−{-# NOINLINE reallocExplicitAs #-}
846−reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847−reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
749+{-# NOINLINE reallocExplicit #-}
750+reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
751+reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
848752 assertM(arrEnd <= arrBound)
849753
850754 -- Allocate new array
851755 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
852756 contents <-
853− if ps == Pinned
757+ if Unboxed.isPinned arrContents
854758 then Unboxed.pinnedNew newCapMaxInBytes
855759 else Unboxed.new newCapMaxInBytes
856760 let !(MutByteArray mbarrFrom#) = arrContents
@@ -875,10 +779,6 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
875779 , arrBound = newCapInBytes
876780 }
877781
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−
882782-- | @realloc newCapacity array@ reallocates the array to the specified
883783-- capacity in bytes.
884784--
@@ -890,12 +790,7 @@ reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
890790-- If the original array is pinned, the newly allocated array is also pinned.
891791{-# INLINABLE realloc #-}
892792realloc :: 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
793+realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
899794
900795-- | @reallocWith label capSizer minIncrBytes array@. The label is used
901796-- in error messages and the capSizer is used to determine the capacity of the
@@ -918,14 +813,14 @@ reallocWith label capSizer minIncrBytes arr = do
918813 where
919814
920815 badSize newSize =
921− Prelude.concat
816+ concat
922817 [ label
923818 , ": new array size (in bytes) is less than required size "
924819 , show newSize
925820 , ". Please check the sizing function passed."
926821 ]
927822
928−-- | @grow newCapacity array@ changes the total capacity of the array so that
823+-- | @resize newCapacity array@ changes the total capacity of the array so that
929824-- it is enough to hold the specified number of elements. Nothing is done if
930825-- the specified capacity is less than the length of the array.
931826--
@@ -933,46 +828,34 @@ reallocWith label capSizer minIncrBytes arr = do
933828-- the block size (4K).
934829--
935830-- /Pre-release/
936−{-# INLINE grow #-}
937−grow :: forall m a. (MonadIO m, Unbox a) =>
831+{-# INLINE resize #-}
832+resize :: forall m a. (MonadIO m, Unbox a) =>
938833 Int -> MutArray a -> m (MutArray a)
939−grow nElems arr@MutArray{..} = do
834+resize nElems arr@MutArray{..} = do
940835 let req = SIZE_OF(a) * nElems
941− cap = arrBound - arrStart
942− if req < cap
836+ len = arrEnd - arrStart
837+ if req < len
943838 then return arr
944839 else realloc req arr
945840
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.
841+-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
842+-- then it is rounded up to the closest power of 2.
954843--
955844-- /Pre-release/
956−{-# INLINE growExp #-}
957−growExp :: forall m a. (MonadIO m, Unbox a) =>
845+{-# INLINE resizeExp #-}
846+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
958847 Int -> MutArray a -> m (MutArray a)
959−growExp nElems arr@MutArray{..} = do
848+resizeExp nElems arr@MutArray{..} = do
960849 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
961850 req1 =
962851 if req > largeObjectThreshold
963852 then roundUpToPower2 req
964853 else req
965− cap = arrBound - arrStart
966− if req1 < cap
854+ len = arrEnd - arrStart
855+ if req1 < len
967856 then return arr
968857 else realloc req1 arr
969858
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−
976859-- | Resize the allocated memory to drop any reserved free space at the end of
977860-- the array and reallocate it to reduce wastage.
978861--
@@ -1037,7 +920,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
1037920{-# INLINE snocMay #-}
1038921snocMay :: forall m a. (MonadIO m, Unbox a) =>
1039922 MutArray a -> a -> m (Maybe (MutArray a))
1040−snocMay arr@MutArray{..} x = do
923+snocMay arr@MutArray{..} x = liftIO $ do
1041924 let newEnd = INDEX_NEXT(arrEnd,a)
1042925 if newEnd <= arrBound
1043926 then Just <$> snocNewEnd newEnd arr x
@@ -1051,7 +934,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1051934 -> a
1052935 -> m (MutArray a)
1053936snocWithRealloc sizer arr x = do
1054− arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
937+ arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1055938 snocUnsafe arr1 x
1056939
1057940-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -1073,7 +956,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
1073956 -> MutArray a
1074957 -> a
1075958 -> m (MutArray a)
1076−snocWith allocSize arr x = do
959+snocWith allocSize arr x = liftIO $ do
1077960 let newEnd = INDEX_NEXT(arrEnd arr,a)
1078961 if newEnd <= arrBound arr
1079962 then snocNewEnd newEnd arr x
@@ -1117,126 +1000,6 @@ snoc = snocWith f
11171000 then oldSize * 2
11181001 else roundUpToPower2 oldSize * 2
11191002
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−
12401003-------------------------------------------------------------------------------
12411004-- Random reads
12421005-------------------------------------------------------------------------------
@@ -1279,10 +1042,15 @@ getIndexRev i MutArray{..} = do
12791042data GetIndicesState contents start end st =
12801043 GetIndicesState contents start end st
12811044
1282−{-# INLINE indexReaderWith #-}
1283−indexReaderWith :: (Monad m, Unbox a) =>
1045+-- | Given an unfold that generates array indices, read the elements on those
1046+-- indices from the supplied MutArray. An error is thrown if an index is out of
1047+-- bounds.
1048+--
1049+-- /Pre-release/
1050+{-# INLINE getIndicesD #-}
1051+getIndicesD :: (Monad m, Unbox a) =>
12841052 (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
1053+getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
12861054
12871055 where
12881056
@@ -1301,26 +1069,9 @@ indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
13011069 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
13021070 D.Stop -> return D.Stop
13031071
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−
1310−-- | Given an unfold that generates array indices, read the elements on those
1311−-- indices from the supplied MutArray. An error is thrown if an index is out of
1312−-- bounds.
1313−--
1314−-- /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." #-}
13211072{-# INLINE getIndices #-}
13221073getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1323−getIndices = indexReader
1074+getIndices = getIndicesD liftIO
13241075
13251076-------------------------------------------------------------------------------
13261077-- Subarrays
@@ -1615,7 +1366,7 @@ chunksOfAs ps n (D.Stream step state) =
16151366--
16161367-- Same as the following but may be more efficient:
16171368--
1618−-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1369+-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
16191370--
16201371-- /Pre-release/
16211372{-# INLINE_NORMAL chunksOf #-}
@@ -1624,14 +1375,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
16241375-- XXX the idiomatic implementation leads to large regression in the D.reverse'
16251376-- benchmark. It seems it has difficulty producing optimized code when
16261377-- converting to StreamK. Investigate GHC optimizations.
1627−-- chunksOf n = D.foldMany (createOf n)
1378+-- chunksOf n = D.foldMany (writeN n)
16281379chunksOf = chunksOfAs Unpinned
16291380
16301381-- | Like 'chunksOf' but creates pinned arrays.
16311382{-# INLINE_NORMAL pinnedChunksOf #-}
16321383pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
16331384 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1634−-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1385+-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
16351386pinnedChunksOf = chunksOfAs Pinned
16361387
16371388-- | When we are buffering a stream of unknown size into an array we do not
@@ -1664,10 +1415,16 @@ data FlattenState s contents a =
16641415 OuterLoop s
16651416 | InnerLoop s contents !Int !Int
16661417
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)
1418+-- | Use the "reader" unfold instead.
1419+--
1420+-- @flattenArrays = unfoldMany reader@
1421+--
1422+-- We can try this if there are any fusion issues in the unfold.
1423+--
1424+{-# INLINE_NORMAL flattenArrays #-}
1425+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1426+ => D.Stream m (MutArray a) -> D.Stream m a
1427+flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
16711428
16721429 where
16731430
@@ -1684,30 +1441,19 @@ concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
16841441 return $ D.Skip $ OuterLoop st
16851442
16861443 step' _ (InnerLoop st contents p end) = do
1687− x <- liftio $ peekAt p contents
1444+ x <- liftIO $ peekAt p contents
16881445 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
16891446
1690−-- | Use the "reader" unfold instead.
1447+-- | Use the "readerRev" unfold instead.
16911448--
1692−-- @concat = unfoldMany reader@
1449+-- @flattenArrays = unfoldMany readerRev@
16931450--
16941451-- We can try this if there are any fusion issues in the unfold.
16951452--
1696−{-# INLINE_NORMAL concat #-}
1697−concat :: forall m a. (MonadIO m, Unbox a)
1698− => D.Stream m (MutArray a) -> D.Stream m a
1699−concat = concatWith liftIO
1700−
1701−{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702−{-# INLINE flattenArrays #-}
1703−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1453+{-# INLINE_NORMAL flattenArraysRev #-}
1454+flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
17041455 => 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)
1456+flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
17111457
17121458 where
17131459
@@ -1725,27 +1471,10 @@ concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
17251471 return $ D.Skip $ OuterLoop st
17261472
17271473 step' _ (InnerLoop st contents p start) = do
1728− x <- liftio $ peekAt p contents
1474+ x <- liftIO $ peekAt p contents
17291475 let cur = INDEX_PREV(p,a)
17301476 return $ D.Yield x (InnerLoop st contents cur start)
17311477
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−
1743−{-# DEPRECATED flattenArraysRev "Please use \"unfoldMany readerRev\" instead." #-}
1744−{-# INLINE flattenArraysRev #-}
1745−flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1746− => D.Stream m (MutArray a) -> D.Stream m a
1747−flattenArraysRev = concatRev
1748−
17491478-------------------------------------------------------------------------------
17501479-- Unfolds
17511480-------------------------------------------------------------------------------
@@ -1863,11 +1592,11 @@ toList MutArray{..} = liftIO $ go arrStart
18631592 x <- peekAt p arrContents
18641593 (:) x <$> go (INDEX_NEXT(p,a))
18651594
1866−{-# INLINE_NORMAL toStreamWith #-}
1867−toStreamWith ::
1595+{-# INLINE_NORMAL toStreamDWith #-}
1596+toStreamDWith ::
18681597 forall m a. (Monad m, Unbox a)
18691598 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1870−toStreamWith liftio MutArray{..} = D.Stream step arrStart
1599+toStreamDWith liftio MutArray{..} = D.Stream step arrStart
18711600
18721601 where
18731602
@@ -1883,7 +1612,7 @@ toStreamWith liftio MutArray{..} = D.Stream step arrStart
18831612--
18841613{-# INLINE_NORMAL read #-}
18851614read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1886−read = toStreamWith liftIO
1615+read = toStreamDWith liftIO
18871616
18881617{-# INLINE toStreamKWith #-}
18891618toStreamKWith ::
@@ -1902,11 +1631,11 @@ toStreamKWith liftio MutArray{..} = go arrStart
19021631toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
19031632toStreamK = toStreamKWith liftIO
19041633
1905−{-# INLINE_NORMAL toStreamRevWith #-}
1906−toStreamRevWith ::
1634+{-# INLINE_NORMAL toStreamDRevWith #-}
1635+toStreamDRevWith ::
19071636 forall m a. (Monad m, Unbox a)
19081637 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1909−toStreamRevWith liftio MutArray{..} =
1638+toStreamDRevWith liftio MutArray{..} =
19101639 let p = INDEX_PREV(arrEnd,a)
19111640 in D.Stream step p
19121641
@@ -1924,7 +1653,7 @@ toStreamRevWith liftio MutArray{..} =
19241653--
19251654{-# INLINE_NORMAL readRev #-}
19261655readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1927−readRev = toStreamRevWith liftIO
1656+readRev = toStreamDRevWith liftIO
19281657
19291658{-# INLINE toStreamKRevWith #-}
19301659toStreamKRevWith ::
@@ -1973,7 +1702,7 @@ foldr f z arr = D.foldr f z $ read arr
19731702
19741703-- XXX Keep the bound intact to not lose any free space? Perf impact?
19751704
1976−-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
1705+-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
19771706-- array.
19781707--
19791708-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1982,12 +1711,13 @@ foldr f z arr = D.foldr f z $ read arr
19821711-- Any free space left in the array after appending @n@ elements is lost.
19831712--
19841713-- /Internal/
1985−{-# INLINE_NORMAL unsafeAppendN #-}
1986−unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1714+{-# INLINE_NORMAL writeAppendNUnsafe #-}
1715+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
19871716 Int
19881717 -> m (MutArray a)
19891718 -> Fold m a (MutArray a)
1990−unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
1719+writeAppendNUnsafe n action =
1720+ fmap fromArrayUnsafe $ FL.foldlM' step initial
19911721
19921722 where
19931723
@@ -2000,7 +1730,7 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20001730 -- otherwise we lose that space.
20011731 arr1 <-
20021732 if free < needed
2003− then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1733+ then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
20041734 else return arr
20051735 return $ toArrayUnsafe arr1
20061736
@@ -2008,51 +1738,30 @@ unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
20081738 liftIO $ pokeAt end contents x
20091739 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20101740
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−
20191741-- | Append @n@ elements to an existing array. Any free space left in the array
20201742-- after appending @n@ elements is lost.
20211743--
2022−-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1744+-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
20231745--
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 #-}
1746+{-# INLINE_NORMAL writeAppendN #-}
20321747writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
20331748 Int -> m (MutArray a) -> Fold m a (MutArray a)
2034−writeAppendN = appendN
1749+writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
20351750
2036−-- | @appendWith realloc action@ mutates the array generated by @action@ to
1751+-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
20371752-- append the input stream. If there is no reserved space available in the
20381753-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
20391754-- where @oldSize@ is the current size of the array in bytes.
20401755--
20411756-- Note that the returned array may be a mutated version of original array.
20421757--
2043−-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1758+-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
20441759--
20451760-- /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." #-}
20521761{-# INLINE writeAppendWith #-}
20531762writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
20541763 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2055−writeAppendWith = appendWith
1764+writeAppendWith sizer = FL.foldlM' (snocWith sizer)
20561765
20571766-- | @append action@ mutates the array generated by @action@ to append the
20581767-- input stream. If there is no reserved space available in the array it is
@@ -2060,33 +1769,26 @@ writeAppendWith = appendWith
20601769--
20611770-- Note that the returned array may be a mutated version of original array.
20621771--
2063−-- >>> append = MutArray.appendWith (* 2)
1772+-- >>> writeAppend = MutArray.writeAppendWith (* 2)
20641773--
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." #-}
20721774{-# INLINE writeAppend #-}
20731775writeAppend :: forall m a. (MonadIO m, Unbox a) =>
20741776 m (MutArray a) -> Fold m a (MutArray a)
2075−writeAppend = append
1777+writeAppend = writeAppendWith (* 2)
20761778
20771779-- XXX We can carry bound as well in the state to make sure we do not lose the
20781780-- remaining capacity. Need to check perf impact.
20791781--
2080−-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081−-- function as argument.
1782+-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1783+-- as argument.
20821784--
2083−-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1785+-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
20841786--
20851787-- /Pre-release/
2086−{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087−unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1788+{-# INLINE_NORMAL writeNWithUnsafe #-}
1789+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
20881790 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2089−unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1791+writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20901792
20911793 where
20921794
@@ -2097,64 +1799,40 @@ unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
20971799 return
20981800 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
20991801
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−
21061802{-# INLINE_NORMAL writeNUnsafeAs #-}
21071803writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
21081804 => PinnedState -> Int -> Fold m a (MutArray a)
2109−writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1805+writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
21101806
2111−-- | Like 'createOf' but does not check the array bounds when writing. The fold
1807+-- | Like 'writeN' but does not check the array bounds when writing. The fold
21121808-- driver must not call the step function more than 'n' times otherwise it will
21131809-- corrupt the memory and crash. This function exists mainly because any
21141810-- conditional in the step function blocks fusion causing 10x performance
21151811-- slowdown.
21161812--
2117−-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
1813+-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
21181814--
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 #-}
1815+{-# INLINE_NORMAL writeNUnsafe #-}
21261816writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
21271817 => Int -> Fold m a (MutArray a)
2128−writeNUnsafe = unsafeCreateOf
1818+writeNUnsafe = writeNUnsafeAs Unpinned
21291819
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 #-}
1820+-- | Like 'writeNUnsafe' but creates a pinned array.
1821+{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
21381822pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
21391823 => Int -> Fold m a (MutArray a)
2140−pinnedWriteNUnsafe = unsafePinnedCreateOf
1824+pinnedWriteNUnsafe = writeNUnsafeAs Pinned
21411825
2142−-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
1826+-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
21431827-- allocated using the @alloc@ function.
21441828--
2145−-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146−-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1829+-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1830+-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
21471831--
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 #-}
1832+{-# INLINE_NORMAL writeNWith #-}
21551833writeNWith :: forall m a. (MonadIO m, Unbox a)
21561834 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2157−writeNWith = createOfWith
1835+writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
21581836
21591837{-# INLINE_NORMAL writeNAs #-}
21601838writeNAs ::
@@ -2162,42 +1840,28 @@ writeNAs ::
21621840 => PinnedState
21631841 -> Int
21641842 -> Fold m a (MutArray a)
2165−writeNAs ps = createOfWith (newAs ps)
1843+writeNAs ps = writeNWith (newAs ps)
21661844
2167−-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
1845+-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
21681846-- 'MutArray'.
21691847--
2170−-- >>> createOf = MutArray.createOfWith MutArray.new
2171−-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172−-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1848+-- >>> writeN = MutArray.writeNWith MutArray.new
1849+-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1850+-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
21731851--
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 #-}
1852+{-# INLINE_NORMAL writeN #-}
21811853writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2182−writeN = createOf
2183−
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
1854+writeN = writeNAs Unpinned
21911855
2192−{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193−{-# INLINE pinnedWriteN #-}
1856+-- | Like 'writeN' but creates a pinned array.
1857+{-# INLINE_NORMAL pinnedWriteN #-}
21941858pinnedWriteN ::
21951859 forall m a. (MonadIO m, Unbox a)
21961860 => Int
21971861 -> Fold m a (MutArray a)
2198−pinnedWriteN = pinnedCreateOf
1862+pinnedWriteN = writeNAs Pinned
21991863
2200−-- | Like unsafeCreateOfWith but writes the array in reverse order.
1864+-- | Like writeNWithUnsafe but writes the array in reverse order.
22011865--
22021866-- /Internal/
22031867{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -2218,7 +1882,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
22181882 return
22191883 $ ArrayUnsafe contents ptr end
22201884
2221−-- | Like createOfWith but writes the array in reverse order.
1885+-- | Like writeNWith but writes the array in reverse order.
22221886--
22231887-- /Internal/
22241888{-# INLINE_NORMAL writeRevNWith #-}
@@ -2226,36 +1890,31 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
22261890 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
22271891writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
22281892
2229−-- | Like 'createOf' but writes the array in reverse order.
1893+-- | Like writeN but writes the array in reverse order.
22301894--
22311895-- /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 #-}
1896+{-# INLINE_NORMAL writeRevN #-}
22381897writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2239−writeRevN = revCreateOf
1898+writeRevN = writeRevNWith new
22401899
22411900-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
22421901-- input stream to a 'MutArray' aligned to the given size.
22431902--
2244−-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245−-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1903+-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1904+-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
22461905--
22471906-- /Pre-release/
22481907--
22491908{-# INLINE_NORMAL pinnedWriteNAligned #-}
22501909pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
22511910 => Int -> Int -> Fold m a (MutArray a)
2252−pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1911+pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
22531912
22541913-- XXX Buffer to a list instead?
22551914
22561915-- | Buffer a stream into a stream of arrays.
22571916--
2258−-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1917+-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
22591918--
22601919-- Breaking an array into an array stream can be useful to consume a large
22611920-- array sequentially such that memory of the array is released incrementatlly.
@@ -2264,43 +1923,37 @@ pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
22641923--
22651924-- /Unimplemented/
22661925--
2267−{-# INLINE_NORMAL buildChunks #-}
2268−buildChunks :: (MonadIO m, Unbox a) =>
2269− Int -> Fold m a (StreamK n (MutArray a))
2270−buildChunks n = FL.many (createOf n) FL.toStreamK
2271−
2272−{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273−{-# INLINE writeChunks #-}
1926+{-# INLINE_NORMAL writeChunks #-}
22741927writeChunks :: (MonadIO m, Unbox a) =>
22751928 Int -> Fold m a (StreamK n (MutArray a))
2276−writeChunks = buildChunks
1929+writeChunks n = FL.many (writeN n) FL.toStreamK
22771930
22781931{-# INLINE_NORMAL writeWithAs #-}
22791932writeWithAs :: forall m a. (MonadIO m, Unbox a)
22801933 => PinnedState -> Int -> Fold m a (MutArray a)
2281−-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
1934+-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
22821935writeWithAs ps elemCount =
22831936 FL.rmapM extract $ FL.foldlM' step initial
22841937
22851938 where
22861939
22871940 initial = do
2288− when (elemCount < 0) $ error "createWith: elemCount is negative"
2289− newAs ps elemCount
1941+ when (elemCount < 0) $ error "writeWith: elemCount is negative"
1942+ liftIO $ newAs ps elemCount
22901943
22911944 step arr@(MutArray _ start end bound) x
22921945 | INDEX_NEXT(end,a) > bound = do
22931946 let oldSize = end - start
22941947 newSize = max (oldSize * 2) 1
2295− arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
1948+ arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
22961949 snocUnsafe arr1 x
22971950 step arr x = snocUnsafe arr x
22981951
22991952 extract = liftIO . rightSize
23001953
2301−-- XXX Compare createWith with fromStreamD which uses an array of streams
2302−-- implementation. We can write this using buildChunks above if that is faster.
2303−-- If createWith is faster then we should use that to implement
1954+-- XXX Compare writeWith with fromStreamD which uses an array of streams
1955+-- implementation. We can write this using writeChunks above if that is faster.
1956+-- If writeWith is faster then we should use that to implement
23041957-- fromStreamD.
23051958--
23061959-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -2315,56 +1968,39 @@ writeWithAs ps elemCount =
23151968-- XXX check if GHC's memory allocator is efficient enough. We can try the C
23161969-- malloc to compare against.
23171970
2318−-- | @createWith minCount@ folds the whole input to a single array. The array
1971+-- | @writeWith minCount@ folds the whole input to a single array. The array
23191972-- starts at a size big enough to hold minCount elements, the size is doubled
23201973-- every time the array needs to be grown.
23211974--
23221975-- /Caution! Do not use this on infinite streams./
23231976--
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)
1977+-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
1978+-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
1979+-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
23271980--
23281981-- /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 #-}
1982+{-# INLINE_NORMAL writeWith #-}
23371983writeWith :: forall m a. (MonadIO m, Unbox a)
23381984 => Int -> Fold m a (MutArray a)
2339−writeWith = createWith
1985+-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
1986+writeWith = writeWithAs Unpinned
23401987
23411988-- | Fold the whole input to a single array.
23421989--
2343−-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
1990+-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
23441991-- rounded up to the element size.
23451992--
23461993-- /Caution! Do not use this on infinite streams./
23471994--
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." #-}
23541995{-# INLINE write #-}
23551996write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2356−write = create
1997+write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23571998
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)
2363−
2364−{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
1999+-- | Like 'write' but creates a pinned array.
23652000{-# INLINE pinnedWrite #-}
23662001pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2367−pinnedWrite = pinnedCreate
2002+pinnedWrite =
2003+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
23682004
23692005-------------------------------------------------------------------------------
23702006-- construct from streams, known size
@@ -2374,7 +2010,7 @@ pinnedWrite = pinnedCreate
23742010fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
23752011 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
23762012fromStreamDNAs ps limit str = do
2377− (arr :: MutArray a) <- newAs ps limit
2013+ (arr :: MutArray a) <- liftIO $ newAs ps limit
23782014 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
23792015 return $ arr {arrEnd = end}
23802016
@@ -2384,21 +2020,15 @@ fromStreamDNAs ps limit str = do
23842020 liftIO $ pokeAt ptr arrContents x
23852021 return $ INDEX_NEXT(ptr,a)
23862022
2387−-- | Use the 'createOf' fold instead.
2023+-- | Use the 'writeN' fold instead.
23882024--
2389−-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
2025+-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
23902026--
2391−{-# INLINE_NORMAL fromStreamN #-}
2392−fromStreamN :: forall m a. (MonadIO m, Unbox a)
2393− => Int -> D.Stream m a -> m (MutArray a)
2394−-- fromStreamDN n = D.fold (createOf n)
2395−fromStreamN = fromStreamDNAs Unpinned
2396−
2397−{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2398−{-# INLINE fromStreamDN #-}
2027+{-# INLINE_NORMAL fromStreamDN #-}
23992028fromStreamDN :: forall m a. (MonadIO m, Unbox a)
24002029 => Int -> D.Stream m a -> m (MutArray a)
2401−fromStreamDN = fromStreamN
2030+-- fromStreamDN n = D.fold (writeN n)
2031+fromStreamDN = fromStreamDNAs Unpinned
24022032
24032033-- | Create a 'MutArray' from the first N elements of a list. The array is
24042034-- allocated to size N, if the list terminates before N elements then the
@@ -2418,20 +2048,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
24182048-- /Pre-release/
24192049{-# INLINE fromListRevN #-}
24202050fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2421−fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2051+fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
24222052
24232053-- | Convert a pure stream in Identity monad to a mutable array.
24242054{-# INLINABLE fromPureStreamN #-}
24252055fromPureStreamN :: (MonadIO m, Unbox a) =>
24262056 Int -> Stream Identity a -> m (MutArray a)
24272057fromPureStreamN n xs =
2428− D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2058+ liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
24292059
24302060-- | Convert a pure stream in Identity monad to a mutable array.
24312061{-# INLINABLE fromPureStream #-}
24322062fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
24332063fromPureStream xs =
2434− D.fold create $ D.morphInner (return . runIdentity) xs
2064+ liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
24352065
24362066{-# INLINABLE fromPtrN #-}
24372067fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2440,7 +2070,7 @@ fromPtrN len addr = do
24402070 -- XXX We can implement a stream copy in a similar way by streaming Word64
24412071 -- first and then remaining Word8.
24422072 arr <- new len
2443− _ <- unsafeAsPtr arr
2073+ _ <- asUnpinnedPtrUnsafe arr
24442074 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
24452075 return (arr {arrEnd = len})
24462076
@@ -2456,32 +2086,11 @@ fromByteStr# addr = do
24562086 len <- liftIO $ c_strlen (Ptr addr)
24572087 let lenInt = fromIntegral len
24582088 arr <- new lenInt
2459− _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2089+ _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
24602090 return (arr {arrEnd = lenInt})
24612091
24622092-------------------------------------------------------------------------------
2463−-- convert a stream of arrays to a single array by reallocating and copying
2464−-------------------------------------------------------------------------------
2465−
2466−-- XXX Both of these implementations of splicing seem to perform equally well.
2467−-- We need to perform benchmarks over a range of sizes though.
2468−
2469−-- | Also see 'fromChunksK'.
2470−{-# INLINE fromChunksRealloced #-}
2471−fromChunksRealloced :: forall m a. (MonadIO m, Unbox a)
2472− => Stream m (MutArray a) -> m (MutArray a)
2473−fromChunksRealloced s = do
2474− res <- D.uncons s
2475− case res of
2476− Just (a, strm) -> do
2477− arr <- D.foldlM' spliceExp (pure a) strm
2478− -- Reallocation is exponential so there may be 50% empty space in
2479− -- worst case. One more reallocation to reclaim the space.
2480− rightSize arr
2481− Nothing -> pure nil
2482−
2483−-------------------------------------------------------------------------------
2484−-- convert a stream of arrays to a single array by buffering arrays first
2093+-- convert stream to a single array
24852094-------------------------------------------------------------------------------
24862095
24872096{-# INLINE arrayStreamKLength #-}
@@ -2491,72 +2100,46 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
24912100-- | Convert an array stream to an array. Note that this requires peak memory
24922101-- that is double the size of the array stream.
24932102--
2494−{-# INLINE fromChunkskAs #-}
2495−fromChunkskAs :: (Unbox a, MonadIO m) =>
2103+{-# INLINE fromArrayStreamKAs #-}
2104+fromArrayStreamKAs :: (Unbox a, MonadIO m) =>
24962105 PinnedState -> StreamK m (MutArray a) -> m (MutArray a)
2497−fromChunkskAs ps as = do
2106+fromArrayStreamKAs ps as = do
24982107 len <- arrayStreamKLength as
24992108 arr <- newAs ps len
25002109 -- XXX is StreamK fold faster or StreamD fold?
25012110 K.foldlM' spliceUnsafe (pure arr) as
25022111 -- fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
25032112
2504−-- XXX Need to compare this with fromChunks and fromChunkList and keep the
2505−-- fastest or simplest one if all are equally fast.
2506−
25072113-- | Convert an array stream to an array. Note that this requires peak memory
25082114-- that is double the size of the array stream.
25092115--
2510−-- Also see 'fromChunksRealloced'.
2511−--
2512−{-# INLINE fromChunksK #-}
2513−fromChunksK :: (Unbox a, MonadIO m) =>
2514− StreamK m (MutArray a) -> m (MutArray a)
2515−fromChunksK = fromChunkskAs Unpinned
2516−
2517−{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
25182116{-# INLINE fromArrayStreamK #-}
25192117fromArrayStreamK :: (Unbox a, MonadIO m) =>
25202118 StreamK m (MutArray a) -> m (MutArray a)
2521−fromArrayStreamK = fromChunksK
2119+fromArrayStreamK = fromArrayStreamKAs Unpinned
25222120
25232121{-# INLINE fromStreamDAs #-}
25242122fromStreamDAs ::
25252123 (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
25262124fromStreamDAs ps m =
2527− arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
2528−
2529−-- | 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
2531−-- as efficient when the size is already known.
2532−--
2533−-- Note that if the input stream is too large memory allocation for the array
2534−-- may fail. When the stream size is not known, `chunksOf` followed by
2535−-- processing of indvidual arrays in the resulting stream should be preferred.
2536−--
2537−-- /Pre-release/
2538−{-# INLINE fromStream #-}
2539−fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540−fromStream = fromStreamDAs Unpinned
2125+ arrayStreamKFromStreamDAs Unpinned m >>= fromArrayStreamKAs ps
25412126
2542−-- fromStream (Stream m) = P.fold create m
25432127-- CAUTION: a very large number (millions) of arrays can degrade performance
25442128-- due to GC overhead because we need to buffer the arrays before we flatten
25452129-- all the arrays.
25462130--
2547−-- XXX Compare if this is faster or "fold create".
2131+-- XXX Compare if this is faster or "fold write".
25482132--
25492133-- | We could take the approach of doubling the memory allocation on each
25502134-- overflow. This would result in more or less the same amount of copying as in
25512135-- the chunking approach. However, if we have to shrink in the end then it may
25522136-- result in an extra copy of the entire data.
25532137--
2554−-- >>> fromStreamD = StreamD.fold MutArray.create
2138+-- >>> fromStreamD = StreamD.fold MutArray.write
25552139--
25562140{-# INLINE fromStreamD #-}
2557−{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
25582141fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2559−fromStreamD = fromStream
2142+fromStreamD = fromStreamDAs Unpinned
25602143
25612144-- | Create a 'MutArray' from a list. The list must be of finite size.
25622145--
@@ -2581,10 +2164,6 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
25812164-- Cloning
25822165-------------------------------------------------------------------------------
25832166
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−
25882167{-# INLINE cloneAs #-}
25892168cloneAs ::
25902169 ( MonadIO m
@@ -2594,7 +2173,7 @@ cloneAs ::
25942173 )
25952174 => PinnedState -> MutArray a -> m (MutArray a)
25962175cloneAs ps src =
2597− do
2176+ liftIO $ do
25982177 let startSrc = arrStart src
25992178 srcLen = arrEnd src - startSrc
26002179 newArrContents <-
@@ -2633,16 +2212,17 @@ spliceCopy :: forall m a. MonadIO m =>
26332212 Unbox a =>
26342213#endif
26352214 MutArray a -> MutArray a -> m (MutArray a)
2636−spliceCopy arr1 arr2 = do
2215+spliceCopy arr1 arr2 = liftIO $ do
26372216 let start1 = arrStart arr1
26382217 start2 = arrStart arr2
26392218 len1 = arrEnd arr1 - start1
26402219 len2 = arrEnd arr2 - start2
2641− let len = len1 + len2
2220+ let newLen = len1 + len2
26422221 newArrContents <-
26432222 if Unboxed.isPinned (arrContents arr1)
2644− then liftIO $ Unboxed.pinnedNew len
2645− else liftIO $ Unboxed.new len
2223+ then Unboxed.pinnedNew newLen
2224+ else Unboxed.new newLen
2225+ let len = len1 + len2
26462226 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
26472227 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
26482228 return $ MutArray newArrContents 0 len len
@@ -2654,7 +2234,7 @@ spliceCopy arr1 arr2 = do
26542234spliceUnsafe :: MonadIO m =>
26552235 MutArray a -> MutArray a -> m (MutArray a)
26562236spliceUnsafe dst src =
2657− do
2237+ liftIO $ do
26582238 let startSrc = arrStart src
26592239 srcLen = arrEnd src - startSrc
26602240 endDst = arrEnd dst
@@ -2676,7 +2256,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
26762256 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
26772257spliceWith sizer dst@(MutArray _ start end bound) src = do
26782258{-
2679− let f = appendWith (`sizer` byteLength src) (return dst)
2259+ let f = writeAppendWith (`sizer` byteLength src) (return dst)
26802260 in D.fold f (toStreamD src)
26812261-}
26822262 assert (end <= bound) (return ())
@@ -2692,7 +2272,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
26922272 $ "splice: newSize is less than the total size "
26932273 ++ "of arrays being appended. Please check the "
26942274 ++ "sizer function passed."
2695− realloc newSizeInBytes dst
2275+ liftIO $ realloc newSizeInBytes dst
26962276 else return dst
26972277 spliceUnsafe dst1 src
26982278
@@ -2729,22 +2309,11 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
27292309-- Splitting
27302310-------------------------------------------------------------------------------
27312311
2732−-- | Generate a stream of array slices using a predicate. The array element
2733−-- matching the predicate is dropped.
2734−--
2735−-- /Pre-release/
2736−{-# INLINE splitOn #-}
2737−splitOn :: (MonadIO m, Unbox a) =>
2738− (a -> Bool) -> MutArray a -> Stream m (MutArray a)
2739−splitOn predicate arr =
2740− fmap (\(i, len) -> getSliceUnsafe i len arr)
2741− $ D.indexOnSuffix predicate (read arr)
2742−
27432312-- | Drops the separator byte
27442313{-# INLINE breakOn #-}
27452314breakOn :: MonadIO m
27462315 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2747−breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2316+breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
27482317 -- XXX We do not need memchr here, we can use a Haskell equivalent.
27492318 -- Need efficient stream based primitives that work on Word64.
27502319 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2767,41 +2336,32 @@ breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
27672336 }
27682337 )
27692338
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−
27922339-- | Create two slices of an array without copying the original array. The
27932340-- specified index @i@ is the first index of the second slice.
27942341--
2795−{-# INLINE splitAt #-}
27962342splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2797−splitAt i arr =
2343+splitAt i arr@MutArray{..} =
27982344 let maxIndex = length arr - 1
27992345 in if i < 0
28002346 then error "sliceAt: negative array index"
28012347 else if i > maxIndex
28022348 then error $ "sliceAt: specified array index " ++ show i
28032349 ++ " is beyond the maximum index " ++ show maxIndex
2804− else unsafeSplitAt i arr
2350+ else let off = i * SIZE_OF(a)
2351+ p = arrStart + off
2352+ in ( MutArray
2353+ { arrContents = arrContents
2354+ , arrStart = arrStart
2355+ , arrEnd = p
2356+ , arrBound = p
2357+ }
2358+ , MutArray
2359+ { arrContents = arrContents
2360+ , arrStart = p
2361+ , arrEnd = arrEnd
2362+ , arrBound = arrBound
2363+ }
2364+ )
28052365
28062366-------------------------------------------------------------------------------
28072367-- Casting
@@ -2851,13 +2411,9 @@ cast arr =
28512411-- guarantees that unsafe calls will be performed in the calling thread. Making
28522412-- it safe to pass heap-allocated objects to unsafe functions.
28532413
2854−-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
2414+-- Should we just name it asPtr, the unsafety is implicit for any pointer
28552415-- operations. And we are safe from Haskell perspective because we will be
28562416-- 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.
28612417
28622418-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
28632419-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2875,21 +2431,16 @@ cast arr =
28752431--
28762432-- /Pre-release/
28772433--
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." #-}
28852434{-# INLINE asPtrUnsafe #-}
28862435asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2887−asPtrUnsafe = unsafePinnedAsPtr
2436+asPtrUnsafe arr f =
2437+ Unboxed.asPtrUnsafe
2438+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28882439
2889−{-# INLINE unsafeAsPtr #-}
2890−unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891−unsafeAsPtr arr f =
2892− Unboxed.unsafeAsPtr
2440+{-# INLINE asUnpinnedPtrUnsafe #-}
2441+asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2442+asUnpinnedPtrUnsafe arr f =
2443+ Unboxed.asUnpinnedPtrUnsafe
28932444 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
28942445
28952446-------------------------------------------------------------------------------
@@ -2907,26 +2458,28 @@ unsafeAsPtr arr f =
29072458-- /Pre-release/
29082459{-# INLINE byteCmp #-}
29092460byteCmp :: 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
2461+byteCmp arr1 arr2 =
2462+ liftIO
2463+ $ do
2464+ let marr1 = getMutableByteArray# (arrContents arr1)
2465+ marr2 = getMutableByteArray# (arrContents arr2)
2466+ !(I# st1#) = arrStart arr1
2467+ !(I# st2#) = arrStart arr2
2468+ !(I# len#) = byteLength arr1
2469+ case compare (byteLength arr1) (byteLength arr2) of
2470+ EQ -> do
2471+ r <- liftIO $ IO $ \s# ->
2472+ let res =
2473+ I#
2474+ (compareByteArrays#
2475+ (unsafeCoerce# marr1)
2476+ st1#
2477+ (unsafeCoerce# marr2)
2478+ st2#
2479+ len#)
2480+ in (# s#, res #)
2481+ return $ compare r 0
2482+ x -> return x
29302483
29312484{-# INLINE cmp #-}
29322485{-# DEPRECATED cmp "Please use byteCmp instead." #-}
@@ -2943,309 +2496,7 @@ byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
29432496byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
29442497
29452498-------------------------------------------------------------------------------
2946−-- Compact
2947−-------------------------------------------------------------------------------
2948−
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 ::
2956− forall m a. (MonadIO m, Unbox a)
2957− => PinnedState -> Int -> Parser (MutArray a) m (MutArray a)
2958−pCompactLeAs ps maxElems = Parser step initial extract
2959−
2960− where
2961−
2962− maxBytes = maxElems * SIZE_OF(a)
2963−
2964− functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2965−
2966− initial =
2967− return
2968− $ if maxElems <= 0
2969− then error
2970− $ functionName
2971− ++ ": the size of arrays ["
2972− ++ show maxElems ++ "] must be a natural number"
2973− else Parser.IPartial Nothing
2974−
2975− step Nothing arr =
2976− return
2977− $ let len = byteLength arr
2978− in if len >= maxBytes
2979− then Parser.Done 0 arr
2980− else Parser.Partial 0 (Just arr)
2981− -- XXX Split the last array to use the space more compactly.
2982− step (Just buf) arr =
2983− let len = byteLength buf + byteLength arr
2984− in if len > maxBytes
2985− then return $ Parser.Done 1 buf
2986− else do
2987− buf1 <-
2988− if byteCapacity buf < maxBytes
2989− then liftIO $ reallocExplicitAs
2990− ps (SIZE_OF(a)) maxBytes buf
2991− else return buf
2992− buf2 <- spliceUnsafe buf1 arr
2993− return $ Parser.Partial 0 (Just buf2)
2994−
2995− extract Nothing = return $ Parser.Done 0 nil
2996− extract (Just buf) = return $ Parser.Done 0 buf
2997−
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−
3022−data SpliceState s arr
3023− = SpliceInitial s
3024− | SpliceBuffering s arr
3025− | SpliceYielding arr (SpliceState s arr)
3026− | SpliceFinish
3027−
3028−-- This mutates the first array (if it has space) to append values from the
3029−-- second one. This would work for immutable arrays as well because an
3030−-- immutable array never has additional space so a new array is allocated
3031−-- instead of mutating it.
3032−
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) =
3037− D.Stream step' (SpliceInitial state)
3038−
3039− where
3040−
3041− maxBytes = maxElems * SIZE_OF(a)
3042−
3043− functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
3044−
3045− {-# INLINE_LATE step' #-}
3046− step' gst (SpliceInitial st) = do
3047− when (maxElems <= 0) $
3048− -- XXX we can pass the module string from the higher level API
3049− error $ functionName ++ ": the size of arrays [" ++ show maxElems
3050− ++ "] must be a natural number"
3051− r <- step gst st
3052− case r of
3053− D.Yield arr s -> return $
3054− let len = byteLength arr
3055− in if len >= maxBytes
3056− then D.Skip (SpliceYielding arr (SpliceInitial s))
3057− else D.Skip (SpliceBuffering s arr)
3058− D.Skip s -> return $ D.Skip (SpliceInitial s)
3059− D.Stop -> return D.Stop
3060−
3061− -- XXX Split the last array to use the space more compactly.
3062− step' gst (SpliceBuffering st buf) = do
3063− r <- step gst st
3064− case r of
3065− D.Yield arr s -> do
3066− let len = byteLength buf + byteLength arr
3067− if len > maxBytes
3068− then return $
3069− D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3070− else do
3071− buf1 <- if byteCapacity buf < maxBytes
3072− then liftIO $ reallocExplicitAs
3073− ps (SIZE_OF(a)) maxBytes buf
3074− else return buf
3075− buf2 <- spliceUnsafe buf1 arr
3076− return $ D.Skip (SpliceBuffering s buf2)
3077− D.Skip s -> return $ D.Skip (SpliceBuffering s buf)
3078− D.Stop -> return $ D.Skip (SpliceYielding buf SpliceFinish)
3079−
3080− step' _ SpliceFinish = return D.Stop
3081−
3082− step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3083−
3084−
3085−{-# INLINE_NORMAL fCompactGeAs #-}
3086−fCompactGeAs ::
3087− 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
3090−
3091− where
3092−
3093− minBytes = minElems * SIZE_OF(a)
3094−
3095− functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3096−
3097− initial =
3098− return
3099− $ if minElems < 0
3100− then error
3101− $ functionName
3102− ++ ": the size of arrays ["
3103− ++ show minElems ++ "] must be a natural number"
3104− else FL.Partial Nothing
3105−
3106− step Nothing arr =
3107− return
3108− $ let len = byteLength arr
3109− in if len >= minBytes
3110− then FL.Done arr
3111− else FL.Partial (Just arr)
3112− -- XXX Buffer arrays as a list to avoid copy and reallocations
3113− step (Just buf) arr = do
3114− let len = byteLength buf + byteLength arr
3115− buf1 <-
3116− if byteCapacity buf < len
3117− then liftIO $ reallocExplicitAs
3118− ps (SIZE_OF(a)) (max minBytes len) buf
3119− else return buf
3120− buf2 <- spliceUnsafe buf1 arr
3121− if len >= minBytes
3122− then return $ FL.Done buf2
3123− else return $ FL.Partial (Just buf2)
3124−
3125− extract Nothing = return nil
3126− extract (Just buf) = return buf
3127−
3128−-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129−-- until the size becomes greater than or equal to @minElems@.
3130−--
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) =
3152− Fold step initial extract final
3153−
3154− where
3155−
3156− minBytes = minElems * SIZE_OF(a)
3157−
3158− functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
3159−
3160− initial = do
3161− when (minElems <= 0) $
3162− -- XXX we can pass the module string from the higher level API
3163− error $ functionName ++ ": the size of arrays ["
3164− ++ show minElems ++ "] must be a natural number"
3165−
3166− r <- initial1
3167− return $ first (Tuple' Nothing) r
3168−
3169− {-# INLINE runInner #-}
3170− runInner len acc buf =
3171− if len >= minBytes
3172− then do
3173− r <- step1 acc buf
3174− case r of
3175− FL.Done _ -> return $ FL.Done ()
3176− FL.Partial s -> do
3177− _ <- final1 s
3178− res <- initial1
3179− 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
3194−
3195− -- 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
3197− -- partial.
3198− --
3199− -- extract forces the pending buffer to be sent to the fold which is not
3200− -- what we want.
3201− extract _ = error "lCompactGE: not designed for scanning"
3202−
3203− final (Tuple' Nothing r1) = final1 r1
3204− final (Tuple' (Just buf) r1) = do
3205− r <- step1 r1 buf
3206− case r of
3207− FL.Partial rr -> final1 rr
3208− FL.Done _ -> return ()
3209−
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
3228−-- the size becomes greater than or equal to @n@.
3229−--
3230−-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
3231−--
3232−{-# INLINE compactGE #-}
3233−compactGE ::
3234− (MonadIO m, Unbox a)
3235− => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236−compactGE n = D.foldMany (fCompactGE n)
3237−
3238−-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
3239−-- arrays of exact size @n@.
3240−--
3241−-- /Unimplemented/
3242−{-# INLINE compactEQ #-}
3243−compactEQ :: -- (MonadIO m, Unbox a) =>
3244− Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3245−compactEQ _n = undefined -- D.parseManyD (pCompactEQ n)
3246−
3247−-------------------------------------------------------------------------------
3248−-- In-place mutation algorithms
2499+-- NFData
32492500-------------------------------------------------------------------------------
32502501
32512502-- | Strip elements which match with predicate from both ends.