@@ -31,39 +31,57 @@ module Streamly.Internal.Data.MutArray.Type
3131 -- ** Type
3232 -- $arrayNotes
3333 MutArray (..)
34− , MutByteArray
35− , MutableByteArray
34+
35+ -- ** Conversion
36+ -- *** Pinned and Unpinned
3637 , pin
3738 , unpin
3839 , isPinned
3940
40− -- -- * Constructing and Writing
41+ -- ** Casting
42+ , cast
43+ , castUnsafe -- XXX unsafeCast
44+ , asBytes
45+ , unsafePinnedAsPtr
46+ , unsafeAsPtr
47+
4148 -- ** Construction
42− , nil
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
4363
44− -- *** Uninitialized Arrays
45− , pinnedNew
46− , pinnedNewBytes
47− , pinnedNewAligned
48− , new
49− , newArrayWith
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
5070
51− -- *** From streams
71+ -- *** Stream Folds
5272 , ArrayUnsafe (..)
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
73+ , unsafeCreateOfWith
74+ , unsafeCreateOf
75+ , unsafePinnedCreateOf
76+ , pinnedCreateOf
77+ , createOfWith
78+ , createOf
79+ , revCreateOf
80+
81+ , pinnedCreate
82+ , createWith
83+ , create
84+ -- , revCreate
6785
6886 -- *** From containers
6987 , fromListN
@@ -72,18 +90,18 @@ module Streamly.Internal.Data.MutArray.Type
7290 , pinnedFromList
7391 , fromListRevN
7492 , fromListRev
75− , fromStreamDN
76− , fromStreamD
93+ , fromStreamN
94+ , fromStream
7795 , fromPureStreamN
7896 , fromPureStream
7997 , fromByteStr#
8098 , fromPtrN
81− , fromArrayStreamK
82− , fromArrayStreamRealloced
99+ , fromChunksK
100+ , fromChunksRealloced -- fromSmallChunks
83101
84102 -- ** Random writes
85103 , putIndex
86− , putIndexUnsafe
104+ , putIndexUnsafe -- XXX unsafePutIndex
87105 , putIndices
88106 -- , putFromThenTo
89107 -- , putFrom -- start writing at the given position
@@ -91,77 +109,70 @@ module Streamly.Internal.Data.MutArray.Type
91109 -- , putFromTo
92110 -- , putFromRev
93111 -- , putUptoRev
94− , modifyIndexUnsafe
112+ , modifyIndexUnsafe -- XXX unsafeModifyIndex
95113 , modifyIndex
96114 , modifyIndices
97115 , modify
98116 , swapIndices
99117 , unsafeSwapIndices
100118
101− -- ** Growing and Shrinking
102− -- | Arrays grow only at the end, though it is possible to grow on both sides
103− -- and therefore have a cons as well as snoc. But that will require two
104− -- bounds in the array representation.
105−
106− -- *** Appending elements
107− , snocWith
108− , snoc
109− , snocLinear
110− , snocMay
111− , snocUnsafe
112−
113− -- *** Appending streams
114− , writeAppendNUnsafe
115− , writeAppendN
116− , writeAppendWith
117− , writeAppend
118−
119− -- ** Eliminating and Reading
119+ -- ** Reading
120120
121− -- *** To streams
122− , reader
123− , readerRevWith
124− , readerRev
121+ -- *** Indexing
122+ , getIndex
123+ , getIndexUnsafe -- XXX unsafeGetIndex
124+ -- , getFromThenTo
125+ , getIndexRev -- getRevIndex?
126+ , indexReader
127+ , indexReaderWith
125128
126− -- *** To containers
127− , toStreamDWith
128− , toStreamDRevWith
129− , toStreamKWith
130− , toStreamKRevWith
129+ -- *** To Streams
131130 , read
132131 , readRev
132+ , toStreamWith
133+ , toStreamRevWith
133134 , toStreamK
135+ , toStreamKWith
134136 , toStreamKRev
137+ , toStreamKRevWith
138+
139+ -- *** To Containers
135140 , toList
136141
142+ -- *** Unfolds
137143 -- experimental
138144 , producerWith
139145 , producer
140146
141− -- *** Random reads
142− , getIndex
143− , getIndexUnsafe
144− , getIndices
145− , getIndicesD
146− -- , getFromThenTo
147− , getIndexRev
148−
149− -- ** Memory Management
150− , blockSize
151− , arrayChunkBytes
152− , allocBytesToElemCount
153− , realloc
154− , resize
155− , resizeExp
156− , rightSize
147+ , reader
148+ , readerRevWith
149+ , readerRev
157150
158− -- ** Size
151+ -- ** Size and Capacity
152+ -- *** Size
159153 , length
160154 , byteLength
155+
156+ -- *** Capacity
161157 -- , capacity
162158 , byteCapacity
163159 , bytesFree
164160
161+ -- *** Capacity Management
162+ , blockSize
163+ , arrayChunkBytes
164+ , allocBytesToElemCount
165+ , realloc -- this is "resize"
166+ , grow
167+ , growExp
168+ , rightSize
169+
170+ -- ** Folding
171+ , foldl'
172+ , foldr
173+ , byteCmp
174+ , byteEq
175+
165176 -- ** In-place Mutation Algorithms
166177 , strip
167178 , reverse
@@ -172,64 +183,121 @@ module Streamly.Internal.Data.MutArray.Type
172183 , mergeBy
173184 , bubble
174185
175− -- ** Casting
176− , cast
177− , castUnsafe
178− , asBytes
179− , asPtrUnsafe
180− , asUnpinnedPtrUnsafe
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.
181190
182− -- ** Folding
183− , foldl'
184− , foldr
185− , cmp
186− , byteCmp
187− , byteEq
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
188213
189− -- ** Arrays of arrays
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+
224+ -- Arrays of arrays
190225 -- We can add dimensionality parameter to the array type to get
191226 -- multidimensional arrays. Multidimensional arrays would just be a
192227 -- convenience wrapper on top of single dimensional arrays.
193228
194− -- | Operations dealing with multiple arrays, streams of arrays or
195− -- multidimensional array representations.
196−
197− -- *** Construct from streams
229+ -- ** Streams of Arrays
230+ -- *** Chunk
231+ -- | Group a stream into arrays.
198232 , chunksOf
199233 , pinnedChunksOf
200− , writeChunks
234+ , buildChunks
201235
202− -- *** Eliminate to streams
203− , flattenArrays
204− , flattenArraysRev
236+ -- *** Split
237+ -- | Split an array into slices.
205238
206− -- *** Construct from arrays
207− -- get chunks without copying
208− , getSliceUnsafe
209− , getSlice
210239 -- , getSlicesFromLenN
211− , splitAt -- XXX should be able to express using getSlice
212− , breakOn
213−
214− -- ** Cloning arrays
215− , clone
216− , pinnedClone
217−
218− -- ** Appending arrays
219− , spliceCopy
220− , spliceWith
221− , splice
222− , spliceExp
223− , spliceUnsafe
224− -- , putSlice
225− -- , appendSlice
226− -- , appendSliceFrom
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
227262
228263 -- ** Utilities
229264 , roundUpToPower2
230265 , memcpy
231266 , memcmp
232267 , 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
233301 )
234302where
235303
@@ -240,6 +308,7 @@ where
240308
241309import Control.Monad (when, void)
242310import Control.Monad.IO.Class (MonadIO(..))
311+import Data.Bifunctor (first)
243312import Data.Bits (shiftR, (.|.), (.&.))
244313import Data.Functor.Identity (Identity(..))
245314import Data.Proxy (Proxy(..))
@@ -248,7 +317,6 @@ import Foreign.C.Types (CSize(..), CInt(..))
248317import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
249318import Streamly.Internal.Data.MutByteArray.Type
250319 ( MutByteArray(..)
251− , MutableByteArray
252320 , PinnedState(..)
253321 , getMutableByteArray#
254322 , putSliceUnsafe
@@ -267,13 +335,17 @@ import GHC.Ptr (Ptr(..))
267335import Streamly.Internal.Data.Fold.Type (Fold(..))
268336import Streamly.Internal.Data.Producer.Type (Producer (..))
269337import Streamly.Internal.Data.Stream.Type (Stream)
338+import Streamly.Internal.Data.Parser.Type (Parser (..))
270339import Streamly.Internal.Data.StreamK.Type (StreamK)
271340import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341+import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
272342import Streamly.Internal.Data.Unfold.Type (Unfold(..))
273343import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
274344
275345import qualified Streamly.Internal.Data.Fold.Type as FL
276346import 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
277349import qualified Streamly.Internal.Data.Producer as Producer
278350import qualified Streamly.Internal.Data.Stream.Type as D
279351import qualified Streamly.Internal.Data.Stream.Lift as D
@@ -281,7 +353,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
281353import qualified Prelude
282354
283355import Prelude hiding
284− (Foldable(..), read, unlines, splitAt, reverse, truncate)
356+ (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
285357
286358#include "DocTestDataMutArray.hs"
287359
@@ -407,6 +479,8 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
407479-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
408480-- allocatePinned in GHC source.
409481
482+-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
483+
410484-- | @newArrayWith allocator alignment count@ allocates a new array of zero
411485-- length and with a capacity to hold @count@ elements, using @allocator
412486-- size alignment@ as the memory allocator function.
@@ -430,12 +504,25 @@ newArrayWith alloc alignSize count = do
430504 , arrBound = size
431505 }
432506
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." #-}
433520nil ::
434521#ifdef DEVBUILD
435522 Unbox a =>
436523#endif
437524 MutArray a
438−nil = MutArray Unboxed.nil 0 0 0
525+nil = empty
439526
440527{-# INLINE newBytesAs #-}
441528newBytesAs :: MonadIO m =>
@@ -452,12 +539,13 @@ newBytesAs ps bytes = do
452539 , arrBound = bytes
453540 }
454541
455−-- | Allocates a pinned empty array that can hold 'count' items. The memory of
456−-- the array is uninitialized and the allocation is aligned as per the
457−-- 'Unboxed' instance of the type.
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.
458545--
459546-- /Pre-release/
460547{-# INLINE pinnedNewBytes #-}
548+{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
461549pinnedNewBytes :: MonadIO m =>
462550#ifdef DEVBUILD
463551 Unbox a =>
@@ -482,21 +570,31 @@ newAs ps =
482570 (error "new: alignment is not used in unpinned arrays.")
483571
484572-- XXX can unaligned allocation be more efficient when alignment is not needed?
485−--
486−-- | Allocates an empty pinned array that can hold 'count' items. The memory of
487−-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
488−-- instance of the type.
489−--
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." #-}
490582{-# INLINE pinnedNew #-}
491583pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
492−pinnedNew = newAs Pinned
584+pinnedNew = pinnedEmptyOf
493585
494−-- | Allocates an empty unpinned array that can hold 'count' items. The memory
495−-- of the array is uninitialized.
586+-- | Allocates an unpinned array of zero length but growable to the specified
587+-- capacity without reallocation.
496588--
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." #-}
497595{-# INLINE new #-}
498596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
499−new = newAs Unpinned
597+new = emptyOf
500598
501599-------------------------------------------------------------------------------
502600-- Random writes
@@ -544,7 +642,7 @@ putIndices arr = FL.foldlM' step (return ())
544642
545643 where
546644
547− step () (i, x) = liftIO (putIndex i arr x)
645+ step () (i, x) = putIndex i arr x
548646
549647-- | Modify a given index of an array using a modifier function.
550648--
@@ -740,22 +838,19 @@ arrayChunkBytes = 1024
740838roundDownTo :: Int -> Int -> Int
741839roundDownTo elemSize size = size - (size `mod` elemSize)
742840
743−-- XXX See if resizing can be implemented by reading the old array as a stream
744−-- and then using writeN to the new array.
745−--
746841-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
747842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
748843-- which complicates some inspection tests.
749844--
750−{-# NOINLINE reallocExplicit #-}
751−reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
752−reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
845+{-# NOINLINE reallocExplicitAs #-}
846+reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
847+reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
753848 assertM(arrEnd <= arrBound)
754849
755850 -- Allocate new array
756851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
757852 contents <-
758− if Unboxed.isPinned arrContents
853+ if ps == Pinned
759854 then Unboxed.pinnedNew newCapMaxInBytes
760855 else Unboxed.new newCapMaxInBytes
761856 let !(MutByteArray mbarrFrom#) = arrContents
@@ -780,6 +875,10 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
780875 , arrBound = newCapInBytes
781876 }
782877
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+
783882-- | @realloc newCapacity array@ reallocates the array to the specified
784883-- capacity in bytes.
785884--
@@ -791,7 +890,12 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
791890-- If the original array is pinned, the newly allocated array is also pinned.
792891{-# INLINABLE realloc #-}
793892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
794−realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
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
795899
796900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
797901-- in error messages and the capSizer is used to determine the capacity of the
@@ -814,14 +918,14 @@ reallocWith label capSizer minIncrBytes arr = do
814918 where
815919
816920 badSize newSize =
817− concat
921+ Prelude.concat
818922 [ label
819923 , ": new array size (in bytes) is less than required size "
820924 , show newSize
821925 , ". Please check the sizing function passed."
822926 ]
823927
824−-- | @resize newCapacity array@ changes the total capacity of the array so that
928+-- | @grow newCapacity array@ changes the total capacity of the array so that
825929-- it is enough to hold the specified number of elements. Nothing is done if
826930-- the specified capacity is less than the length of the array.
827931--
@@ -829,34 +933,46 @@ reallocWith label capSizer minIncrBytes arr = do
829933-- the block size (4K).
830934--
831935-- /Pre-release/
832−{-# INLINE resize #-}
833−resize :: forall m a. (MonadIO m, Unbox a) =>
936+{-# INLINE grow #-}
937+grow :: forall m a. (MonadIO m, Unbox a) =>
834938 Int -> MutArray a -> m (MutArray a)
835−resize nElems arr@MutArray{..} = do
939+grow nElems arr@MutArray{..} = do
836940 let req = SIZE_OF(a) * nElems
837− len = arrEnd - arrStart
838− if req < len
941+ cap = arrBound - arrStart
942+ if req < cap
839943 then return arr
840944 else realloc req arr
841945
842−-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
843−-- then it is rounded up to the closest power of 2.
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.
844954--
845955-- /Pre-release/
846−{-# INLINE resizeExp #-}
847−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
956+{-# INLINE growExp #-}
957+growExp :: forall m a. (MonadIO m, Unbox a) =>
848958 Int -> MutArray a -> m (MutArray a)
849−resizeExp nElems arr@MutArray{..} = do
959+growExp nElems arr@MutArray{..} = do
850960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
851961 req1 =
852962 if req > largeObjectThreshold
853963 then roundUpToPower2 req
854964 else req
855− len = arrEnd - arrStart
856− if req1 < len
965+ cap = arrBound - arrStart
966+ if req1 < cap
857967 then return arr
858968 else realloc req1 arr
859969
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+
860976-- | Resize the allocated memory to drop any reserved free space at the end of
861977-- the array and reallocate it to reduce wastage.
862978--
@@ -921,7 +1037,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
9211037{-# INLINE snocMay #-}
9221038snocMay :: forall m a. (MonadIO m, Unbox a) =>
9231039 MutArray a -> a -> m (Maybe (MutArray a))
924−snocMay arr@MutArray{..} x = liftIO $ do
1040+snocMay arr@MutArray{..} x = do
9251041 let newEnd = INDEX_NEXT(arrEnd,a)
9261042 if newEnd <= arrBound
9271043 then Just <$> snocNewEnd newEnd arr x
@@ -935,7 +1051,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
9351051 -> a
9361052 -> m (MutArray a)
9371053snocWithRealloc sizer arr x = do
938− arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1054+ arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
9391055 snocUnsafe arr1 x
9401056
9411057-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -957,7 +1073,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
9571073 -> MutArray a
9581074 -> a
9591075 -> m (MutArray a)
960−snocWith allocSize arr x = liftIO $ do
1076+snocWith allocSize arr x = do
9611077 let newEnd = INDEX_NEXT(arrEnd arr,a)
9621078 if newEnd <= arrBound arr
9631079 then snocNewEnd newEnd arr x
@@ -1001,6 +1117,126 @@ snoc = snocWith f
10011117 then oldSize * 2
10021118 else roundUpToPower2 oldSize * 2
10031119
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+
10041240-------------------------------------------------------------------------------
10051241-- Random reads
10061242-------------------------------------------------------------------------------
@@ -1043,15 +1279,10 @@ getIndexRev i MutArray{..} = do
10431279data GetIndicesState contents start end st =
10441280 GetIndicesState contents start end st
10451281
1046−-- | Given an unfold that generates array indices, read the elements on those
1047−-- indices from the supplied MutArray. An error is thrown if an index is out of
1048−-- bounds.
1049−--
1050−-- /Pre-release/
1051−{-# INLINE getIndicesD #-}
1052−getIndicesD :: (Monad m, Unbox a) =>
1282+{-# INLINE indexReaderWith #-}
1283+indexReaderWith :: (Monad m, Unbox a) =>
10531284 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1054−getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
1285+indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
10551286
10561287 where
10571288
@@ -1070,9 +1301,26 @@ getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
10701301 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
10711302 D.Stop -> return D.Stop
10721303
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." #-}
10731321{-# INLINE getIndices #-}
10741322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1075−getIndices = getIndicesD liftIO
1323+getIndices = indexReader
10761324
10771325-------------------------------------------------------------------------------
10781326-- Subarrays
@@ -1367,7 +1615,7 @@ chunksOfAs ps n (D.Stream step state) =
13671615--
13681616-- Same as the following but may be more efficient:
13691617--
1370−-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
1618+-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
13711619--
13721620-- /Pre-release/
13731621{-# INLINE_NORMAL chunksOf #-}
@@ -1376,14 +1624,14 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
13761624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
13771625-- benchmark. It seems it has difficulty producing optimized code when
13781626-- converting to StreamK. Investigate GHC optimizations.
1379−-- chunksOf n = D.foldMany (writeN n)
1627+-- chunksOf n = D.foldMany (createOf n)
13801628chunksOf = chunksOfAs Unpinned
13811629
13821630-- | Like 'chunksOf' but creates pinned arrays.
13831631{-# INLINE_NORMAL pinnedChunksOf #-}
13841632pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
13851633 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1386−-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
1634+-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
13871635pinnedChunksOf = chunksOfAs Pinned
13881636
13891637-- | When we are buffering a stream of unknown size into an array we do not
@@ -1416,16 +1664,10 @@ data FlattenState s contents a =
14161664 OuterLoop s
14171665 | InnerLoop s contents !Int !Int
14181666
1419−-- | Use the "reader" unfold instead.
1420−--
1421−-- @flattenArrays = unfoldMany reader@
1422−--
1423−-- We can try this if there are any fusion issues in the unfold.
1424−--
1425−{-# INLINE_NORMAL flattenArrays #-}
1426−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1427− => D.Stream m (MutArray a) -> D.Stream m a
1428−flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
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)
14291671
14301672 where
14311673
@@ -1442,19 +1684,30 @@ flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
14421684 return $ D.Skip $ OuterLoop st
14431685
14441686 step' _ (InnerLoop st contents p end) = do
1445− x <- liftIO $ peekAt p contents
1687+ x <- liftio $ peekAt p contents
14461688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
14471689
1448−-- | Use the "readerRev" unfold instead.
1690+-- | Use the "reader" unfold instead.
14491691--
1450−-- @flattenArrays = unfoldMany readerRev@
1692+-- @concat = unfoldMany reader@
14511693--
14521694-- We can try this if there are any fusion issues in the unfold.
14531695--
1454−{-# INLINE_NORMAL flattenArraysRev #-}
1455−flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1696+{-# INLINE_NORMAL concat #-}
1697+concat :: forall m a. (MonadIO m, Unbox a)
14561698 => D.Stream m (MutArray a) -> D.Stream m a
1457−flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
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)
14581711
14591712 where
14601713
@@ -1472,10 +1725,27 @@ flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
14721725 return $ D.Skip $ OuterLoop st
14731726
14741727 step' _ (InnerLoop st contents p start) = do
1475− x <- liftIO $ peekAt p contents
1728+ x <- liftio $ peekAt p contents
14761729 let cur = INDEX_PREV(p,a)
14771730 return $ D.Yield x (InnerLoop st contents cur start)
14781731
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+
14791749-------------------------------------------------------------------------------
14801750-- Unfolds
14811751-------------------------------------------------------------------------------
@@ -1593,11 +1863,11 @@ toList MutArray{..} = liftIO $ go arrStart
15931863 x <- peekAt p arrContents
15941864 (:) x <$> go (INDEX_NEXT(p,a))
15951865
1596−{-# INLINE_NORMAL toStreamDWith #-}
1597−toStreamDWith ::
1866+{-# INLINE_NORMAL toStreamWith #-}
1867+toStreamWith ::
15981868 forall m a. (Monad m, Unbox a)
15991869 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1600−toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1870+toStreamWith liftio MutArray{..} = D.Stream step arrStart
16011871
16021872 where
16031873
@@ -1613,7 +1883,7 @@ toStreamDWith liftio MutArray{..} = D.Stream step arrStart
16131883--
16141884{-# INLINE_NORMAL read #-}
16151885read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1616−read = toStreamDWith liftIO
1886+read = toStreamWith liftIO
16171887
16181888{-# INLINE toStreamKWith #-}
16191889toStreamKWith ::
@@ -1632,11 +1902,11 @@ toStreamKWith liftio MutArray{..} = go arrStart
16321902toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
16331903toStreamK = toStreamKWith liftIO
16341904
1635−{-# INLINE_NORMAL toStreamDRevWith #-}
1636−toStreamDRevWith ::
1905+{-# INLINE_NORMAL toStreamRevWith #-}
1906+toStreamRevWith ::
16371907 forall m a. (Monad m, Unbox a)
16381908 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1639−toStreamDRevWith liftio MutArray{..} =
1909+toStreamRevWith liftio MutArray{..} =
16401910 let p = INDEX_PREV(arrEnd,a)
16411911 in D.Stream step p
16421912
@@ -1654,7 +1924,7 @@ toStreamDRevWith liftio MutArray{..} =
16541924--
16551925{-# INLINE_NORMAL readRev #-}
16561926readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1657−readRev = toStreamDRevWith liftIO
1927+readRev = toStreamRevWith liftIO
16581928
16591929{-# INLINE toStreamKRevWith #-}
16601930toStreamKRevWith ::
@@ -1703,7 +1973,7 @@ foldr f z arr = D.foldr f z $ read arr
17031973
17041974-- XXX Keep the bound intact to not lose any free space? Perf impact?
17051975
1706−-- | @writeAppendNUnsafe n arr@ appends up to @n@ input items to the supplied
1976+-- | @unsafeAppendN n arr@ appends up to @n@ input items to the supplied
17071977-- array.
17081978--
17091979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1712,13 +1982,12 @@ foldr f z arr = D.foldr f z $ read arr
17121982-- Any free space left in the array after appending @n@ elements is lost.
17131983--
17141984-- /Internal/
1715−{-# INLINE_NORMAL writeAppendNUnsafe #-}
1716−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1985+{-# INLINE_NORMAL unsafeAppendN #-}
1986+unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
17171987 Int
17181988 -> m (MutArray a)
17191989 -> Fold m a (MutArray a)
1720−writeAppendNUnsafe n action =
1721− fmap fromArrayUnsafe $ FL.foldlM' step initial
1990+unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
17221991
17231992 where
17241993
@@ -1731,7 +2000,7 @@ writeAppendNUnsafe n action =
17312000 -- otherwise we lose that space.
17322001 arr1 <-
17332002 if free < needed
1734− then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2003+ then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
17352004 else return arr
17362005 return $ toArrayUnsafe arr1
17372006
@@ -1739,30 +2008,51 @@ writeAppendNUnsafe n action =
17392008 liftIO $ pokeAt end contents x
17402009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
17412010
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+
17422019-- | Append @n@ elements to an existing array. Any free space left in the array
17432020-- after appending @n@ elements is lost.
17442021--
1745−-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2022+-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
17462023--
1747−{-# INLINE_NORMAL writeAppendN #-}
2024+{-# INLINE_NORMAL appendN #-}
2025+appendN :: forall m a. (MonadIO m, Unbox a) =>
2026+ Int -> m (MutArray a) -> Fold m a (MutArray a)
2027+appendN n initial = FL.take n (unsafeAppendN n initial)
2028+
2029+-- XXX Deprecate in major
2030+-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031+{-# INLINE writeAppendN #-}
17482032writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
17492033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1750−writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2034+writeAppendN = appendN
17512035
1752−-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2036+-- | @appendWith realloc action@ mutates the array generated by @action@ to
17532037-- append the input stream. If there is no reserved space available in the
17542038-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
17552039-- where @oldSize@ is the current size of the array in bytes.
17562040--
17572041-- Note that the returned array may be a mutated version of original array.
17582042--
1759−-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2043+-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
17602044--
17612045-- /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." #-}
17622052{-# INLINE writeAppendWith #-}
17632053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
17642054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1765−writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2055+writeAppendWith = appendWith
17662056
17672057-- | @append action@ mutates the array generated by @action@ to append the
17682058-- input stream. If there is no reserved space available in the array it is
@@ -1770,26 +2060,33 @@ writeAppendWith sizer = FL.foldlM' (snocWith sizer)
17702060--
17712061-- Note that the returned array may be a mutated version of original array.
17722062--
1773−-- >>> writeAppend = MutArray.writeAppendWith (* 2)
2063+-- >>> append = MutArray.appendWith (* 2)
17742064--
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." #-}
17752072{-# INLINE writeAppend #-}
17762073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
17772074 m (MutArray a) -> Fold m a (MutArray a)
1778−writeAppend = writeAppendWith (* 2)
2075+writeAppend = append
17792076
17802077-- XXX We can carry bound as well in the state to make sure we do not lose the
17812078-- remaining capacity. Need to check perf impact.
17822079--
1783−-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
1784−-- as argument.
2080+-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
2081+-- function as argument.
17852082--
1786−-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2083+-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
17872084--
17882085-- /Pre-release/
1789−{-# INLINE_NORMAL writeNWithUnsafe #-}
1790−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2086+{-# INLINE_NORMAL unsafeCreateOfWith #-}
2087+unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
17912088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1792−writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2089+unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
17932090
17942091 where
17952092
@@ -1800,40 +2097,64 @@ writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
18002097 return
18012098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
18022099
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+
18032106{-# INLINE_NORMAL writeNUnsafeAs #-}
18042107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
18052108 => PinnedState -> Int -> Fold m a (MutArray a)
1806−writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
2109+writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
18072110
1808−-- | Like 'writeN' but does not check the array bounds when writing. The fold
2111+-- | Like 'createOf' but does not check the array bounds when writing. The fold
18092112-- driver must not call the step function more than 'n' times otherwise it will
18102113-- corrupt the memory and crash. This function exists mainly because any
18112114-- conditional in the step function blocks fusion causing 10x performance
18122115-- slowdown.
18132116--
1814−-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
2117+-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
18152118--
1816−{-# INLINE_NORMAL writeNUnsafe #-}
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 #-}
18172126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
18182127 => Int -> Fold m a (MutArray a)
1819−writeNUnsafe = writeNUnsafeAs Unpinned
2128+writeNUnsafe = unsafeCreateOf
2129+
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
18202135
1821−-- | Like 'writeNUnsafe' but creates a pinned array.
1822−{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
2136+{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
2137+{-# INLINE pinnedWriteNUnsafe #-}
18232138pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
18242139 => Int -> Fold m a (MutArray a)
1825−pinnedWriteNUnsafe = writeNUnsafeAs Pinned
2140+pinnedWriteNUnsafe = unsafePinnedCreateOf
18262141
1827−-- | @writeNWith alloc n@ folds a maximum of @n@ elements into an array
2142+-- | @createOfWith alloc n@ folds a maximum of @n@ elements into an array
18282143-- allocated using the @alloc@ function.
18292144--
1830−-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
1831−-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2145+-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
2146+-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
18322147--
1833−{-# INLINE_NORMAL writeNWith #-}
2148+{-# INLINE_NORMAL createOfWith #-}
2149+createOfWith :: forall m a. (MonadIO m, Unbox a)
2150+ => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151+createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2152+
2153+-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154+{-# INLINE writeNWith #-}
18342155writeNWith :: forall m a. (MonadIO m, Unbox a)
18352156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1836−writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2157+writeNWith = createOfWith
18372158
18382159{-# INLINE_NORMAL writeNAs #-}
18392160writeNAs ::
@@ -1841,28 +2162,42 @@ writeNAs ::
18412162 => PinnedState
18422163 -> Int
18432164 -> Fold m a (MutArray a)
1844−writeNAs ps = writeNWith (newAs ps)
2165+writeNAs ps = createOfWith (newAs ps)
18452166
1846−-- | @writeN n@ folds a maximum of @n@ elements from the input stream to an
2167+-- | @createOf n@ folds a maximum of @n@ elements from the input stream to an
18472168-- 'MutArray'.
18482169--
1849−-- >>> writeN = MutArray.writeNWith MutArray.new
1850−-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
1851−-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2170+-- >>> createOf = MutArray.createOfWith MutArray.new
2171+-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
2172+-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
18522173--
1853−{-# INLINE_NORMAL writeN #-}
2174+{-# INLINE_NORMAL createOf #-}
2175+createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176+createOf = writeNAs Unpinned
2177+
2178+-- XXX Deprecate in major
2179+-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180+{-# INLINE writeN #-}
18542181writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1855−writeN = writeNAs Unpinned
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
18562191
1857−-- | Like 'writeN' but creates a pinned array.
1858−{-# INLINE_NORMAL pinnedWriteN #-}
2192+{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
2193+{-# INLINE pinnedWriteN #-}
18592194pinnedWriteN ::
18602195 forall m a. (MonadIO m, Unbox a)
18612196 => Int
18622197 -> Fold m a (MutArray a)
1863−pinnedWriteN = writeNAs Pinned
2198+pinnedWriteN = pinnedCreateOf
18642199
1865−-- | Like writeNWithUnsafe but writes the array in reverse order.
2200+-- | Like unsafeCreateOfWith but writes the array in reverse order.
18662201--
18672202-- /Internal/
18682203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -1883,7 +2218,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
18832218 return
18842219 $ ArrayUnsafe contents ptr end
18852220
1886−-- | Like writeNWith but writes the array in reverse order.
2221+-- | Like createOfWith but writes the array in reverse order.
18872222--
18882223-- /Internal/
18892224{-# INLINE_NORMAL writeRevNWith #-}
@@ -1891,31 +2226,36 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
18912226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
18922227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
18932228
1894−-- | Like writeN but writes the array in reverse order.
2229+-- | Like 'createOf' but writes the array in reverse order.
18952230--
18962231-- /Pre-release/
1897−{-# INLINE_NORMAL writeRevN #-}
2232+{-# INLINE_NORMAL revCreateOf #-}
2233+revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234+revCreateOf = writeRevNWith new
2235+
2236+{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237+{-# INLINE writeRevN #-}
18982238writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1899−writeRevN = writeRevNWith new
2239+writeRevN = revCreateOf
19002240
19012241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
19022242-- input stream to a 'MutArray' aligned to the given size.
19032243--
1904−-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
1905−-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
2244+-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
2245+-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
19062246--
19072247-- /Pre-release/
19082248--
19092249{-# INLINE_NORMAL pinnedWriteNAligned #-}
19102250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
19112251 => Int -> Int -> Fold m a (MutArray a)
1912−pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
2252+pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
19132253
19142254-- XXX Buffer to a list instead?
19152255
19162256-- | Buffer a stream into a stream of arrays.
19172257--
1918−-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2258+-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
19192259--
19202260-- Breaking an array into an array stream can be useful to consume a large
19212261-- array sequentially such that memory of the array is released incrementatlly.
@@ -1924,37 +2264,43 @@ pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
19242264--
19252265-- /Unimplemented/
19262266--
1927−{-# INLINE_NORMAL writeChunks #-}
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 #-}
19282274writeChunks :: (MonadIO m, Unbox a) =>
19292275 Int -> Fold m a (StreamK n (MutArray a))
1930−writeChunks n = FL.many (writeN n) FL.toStreamK
2276+writeChunks = buildChunks
19312277
19322278{-# INLINE_NORMAL writeWithAs #-}
19332279writeWithAs :: forall m a. (MonadIO m, Unbox a)
19342280 => PinnedState -> Int -> Fold m a (MutArray a)
1935−-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
2281+-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
19362282writeWithAs ps elemCount =
19372283 FL.rmapM extract $ FL.foldlM' step initial
19382284
19392285 where
19402286
19412287 initial = do
1942− when (elemCount < 0) $ error "writeWith: elemCount is negative"
1943− liftIO $ newAs ps elemCount
2288+ when (elemCount < 0) $ error "createWith: elemCount is negative"
2289+ newAs ps elemCount
19442290
19452291 step arr@(MutArray _ start end bound) x
19462292 | INDEX_NEXT(end,a) > bound = do
19472293 let oldSize = end - start
19482294 newSize = max (oldSize * 2) 1
1949− arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
2295+ arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
19502296 snocUnsafe arr1 x
19512297 step arr x = snocUnsafe arr x
19522298
19532299 extract = liftIO . rightSize
19542300
1955−-- XXX Compare writeWith with fromStreamD which uses an array of streams
1956−-- implementation. We can write this using writeChunks above if that is faster.
1957−-- If writeWith is faster then we should use that to implement
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
19582304-- fromStreamD.
19592305--
19602306-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -1969,39 +2315,56 @@ writeWithAs ps elemCount =
19692315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
19702316-- malloc to compare against.
19712317
1972−-- | @writeWith minCount@ folds the whole input to a single array. The array
2318+-- | @createWith minCount@ folds the whole input to a single array. The array
19732319-- starts at a size big enough to hold minCount elements, the size is doubled
19742320-- every time the array needs to be grown.
19752321--
19762322-- /Caution! Do not use this on infinite streams./
19772323--
1978−-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
1979−-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
1980−-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
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)
19812327--
19822328-- /Pre-release/
1983−{-# INLINE_NORMAL writeWith #-}
2329+{-# INLINE_NORMAL createWith #-}
2330+createWith :: forall m a. (MonadIO m, Unbox a)
2331+ => Int -> Fold m a (MutArray a)
2332+-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333+createWith = writeWithAs Unpinned
2334+
2335+{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336+{-# INLINE writeWith #-}
19842337writeWith :: forall m a. (MonadIO m, Unbox a)
19852338 => Int -> Fold m a (MutArray a)
1986−-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
1987−writeWith = writeWithAs Unpinned
2339+writeWith = createWith
19882340
19892341-- | Fold the whole input to a single array.
19902342--
1991−-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2343+-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
19922344-- rounded up to the element size.
19932345--
19942346-- /Caution! Do not use this on infinite streams./
19952347--
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." #-}
19962354{-# INLINE write #-}
19972355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1998−write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2356+write = create
19992357
2000−-- | Like 'write' but creates a pinned array.
2358+-- | Like 'create' but creates a pinned array.
2359+{-# INLINE pinnedCreate #-}
2360+pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2361+pinnedCreate =
2362+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2363+
2364+{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
20012365{-# INLINE pinnedWrite #-}
20022366pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2003−pinnedWrite =
2004− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2367+pinnedWrite = pinnedCreate
20052368
20062369-------------------------------------------------------------------------------
20072370-- construct from streams, known size
@@ -2011,7 +2374,7 @@ pinnedWrite =
20112374fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
20122375 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
20132376fromStreamDNAs ps limit str = do
2014− (arr :: MutArray a) <- liftIO $ newAs ps limit
2377+ (arr :: MutArray a) <- newAs ps limit
20152378 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
20162379 return $ arr {arrEnd = end}
20172380
@@ -2021,15 +2384,21 @@ fromStreamDNAs ps limit str = do
20212384 liftIO $ pokeAt ptr arrContents x
20222385 return $ INDEX_NEXT(ptr,a)
20232386
2024−-- | Use the 'writeN' fold instead.
2387+-- | Use the 'createOf' fold instead.
20252388--
2026−-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
2389+-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
20272390--
2028−{-# INLINE_NORMAL fromStreamDN #-}
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 #-}
20292399fromStreamDN :: forall m a. (MonadIO m, Unbox a)
20302400 => Int -> D.Stream m a -> m (MutArray a)
2031−-- fromStreamDN n = D.fold (writeN n)
2032−fromStreamDN = fromStreamDNAs Unpinned
2401+fromStreamDN = fromStreamN
20332402
20342403-- | Create a 'MutArray' from the first N elements of a list. The array is
20352404-- allocated to size N, if the list terminates before N elements then the
@@ -2049,20 +2418,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
20492418-- /Pre-release/
20502419{-# INLINE fromListRevN #-}
20512420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2052−fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
2421+fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
20532422
20542423-- | Convert a pure stream in Identity monad to a mutable array.
20552424{-# INLINABLE fromPureStreamN #-}
20562425fromPureStreamN :: (MonadIO m, Unbox a) =>
20572426 Int -> Stream Identity a -> m (MutArray a)
20582427fromPureStreamN n xs =
2059− liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
2428+ D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
20602429
20612430-- | Convert a pure stream in Identity monad to a mutable array.
20622431{-# INLINABLE fromPureStream #-}
20632432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
20642433fromPureStream xs =
2065− liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
2434+ D.fold create $ D.morphInner (return . runIdentity) xs
20662435
20672436{-# INLINABLE fromPtrN #-}
20682437fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2071,7 +2440,7 @@ fromPtrN len addr = do
20712440 -- XXX We can implement a stream copy in a similar way by streaming Word64
20722441 -- first and then remaining Word8.
20732442 arr <- new len
2074− _ <- asUnpinnedPtrUnsafe arr
2443+ _ <- unsafeAsPtr arr
20752444 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
20762445 return (arr {arrEnd = len})
20772446
@@ -2087,7 +2456,7 @@ fromByteStr# addr = do
20872456 len <- liftIO $ c_strlen (Ptr addr)
20882457 let lenInt = fromIntegral len
20892458 arr <- new lenInt
2090− _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2459+ _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
20912460 return (arr {arrEnd = lenInt})
20922461
20932462-------------------------------------------------------------------------------
@@ -2097,17 +2466,18 @@ fromByteStr# addr = do
20972466-- XXX Both of these implementations of splicing seem to perform equally well.
20982467-- We need to perform benchmarks over a range of sizes though.
20992468
2100−{-# INLINE fromArrayStreamRealloced #-}
2101−fromArrayStreamRealloced :: forall m a. (MonadIO m, Unbox a)
2469+-- | Also see 'fromChunksK'.
2470+{-# INLINE fromChunksRealloced #-}
2471+fromChunksRealloced :: forall m a. (MonadIO m, Unbox a)
21022472 => Stream m (MutArray a) -> m (MutArray a)
2103−fromArrayStreamRealloced s = do
2473+fromChunksRealloced s = do
21042474 res <- D.uncons s
21052475 case res of
21062476 Just (a, strm) -> do
21072477 arr <- D.foldlM' spliceExp (pure a) strm
21082478 -- Reallocation is exponential so there may be 50% empty space in
21092479 -- worst case. One more reallocation to reclaim the space.
2110− liftIO $ rightSize arr
2480+ rightSize arr
21112481 Nothing -> pure nil
21122482
21132483-------------------------------------------------------------------------------
@@ -2121,46 +2491,72 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
21212491-- | Convert an array stream to an array. Note that this requires peak memory
21222492-- that is double the size of the array stream.
21232493--
2124−{-# INLINE fromArrayStreamKAs #-}
2125−fromArrayStreamKAs :: (Unbox a, MonadIO m) =>
2494+{-# INLINE fromChunkskAs #-}
2495+fromChunkskAs :: (Unbox a, MonadIO m) =>
21262496 PinnedState -> StreamK m (MutArray a) -> m (MutArray a)
2127−fromArrayStreamKAs ps as = do
2497+fromChunkskAs ps as = do
21282498 len <- arrayStreamKLength as
21292499 arr <- newAs ps len
21302500 -- XXX is StreamK fold faster or StreamD fold?
21312501 K.foldlM' spliceUnsafe (pure arr) as
21322502 -- fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
21332503
2504+-- XXX Need to compare this with fromChunks and fromChunkList and keep the
2505+-- fastest or simplest one if all are equally fast.
2506+
21342507-- | Convert an array stream to an array. Note that this requires peak memory
21352508-- that is double the size of the array stream.
21362509--
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." #-}
21372518{-# INLINE fromArrayStreamK #-}
21382519fromArrayStreamK :: (Unbox a, MonadIO m) =>
21392520 StreamK m (MutArray a) -> m (MutArray a)
2140−fromArrayStreamK = fromArrayStreamKAs Unpinned
2521+fromArrayStreamK = fromChunksK
21412522
21422523{-# INLINE fromStreamDAs #-}
21432524fromStreamDAs ::
21442525 (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
21452526fromStreamDAs ps m =
2146− arrayStreamKFromStreamDAs Unpinned m >>= fromArrayStreamKAs ps
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
21472541
2542+-- fromStream (Stream m) = P.fold create m
21482543-- CAUTION: a very large number (millions) of arrays can degrade performance
21492544-- due to GC overhead because we need to buffer the arrays before we flatten
21502545-- all the arrays.
21512546--
2152−-- XXX Compare if this is faster or "fold write".
2547+-- XXX Compare if this is faster or "fold create".
21532548--
21542549-- | We could take the approach of doubling the memory allocation on each
21552550-- overflow. This would result in more or less the same amount of copying as in
21562551-- the chunking approach. However, if we have to shrink in the end then it may
21572552-- result in an extra copy of the entire data.
21582553--
2159−-- >>> fromStreamD = StreamD.fold MutArray.write
2554+-- >>> fromStreamD = StreamD.fold MutArray.create
21602555--
21612556{-# INLINE fromStreamD #-}
2557+{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
21622558fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2163−fromStreamD = fromStreamDAs Unpinned
2559+fromStreamD = fromStream
21642560
21652561-- | Create a 'MutArray' from a list. The list must be of finite size.
21662562--
@@ -2185,6 +2581,10 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
21852581-- Cloning
21862582-------------------------------------------------------------------------------
21872583
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+
21882588{-# INLINE cloneAs #-}
21892589cloneAs ::
21902590 ( MonadIO m
@@ -2194,7 +2594,7 @@ cloneAs ::
21942594 )
21952595 => PinnedState -> MutArray a -> m (MutArray a)
21962596cloneAs ps src =
2197− liftIO $ do
2597+ do
21982598 let startSrc = arrStart src
21992599 srcLen = arrEnd src - startSrc
22002600 newArrContents <-
@@ -2233,17 +2633,16 @@ spliceCopy :: forall m a. MonadIO m =>
22332633 Unbox a =>
22342634#endif
22352635 MutArray a -> MutArray a -> m (MutArray a)
2236−spliceCopy arr1 arr2 = liftIO $ do
2636+spliceCopy arr1 arr2 = do
22372637 let start1 = arrStart arr1
22382638 start2 = arrStart arr2
22392639 len1 = arrEnd arr1 - start1
22402640 len2 = arrEnd arr2 - start2
2241− let newLen = len1 + len2
2641+ let len = len1 + len2
22422642 newArrContents <-
22432643 if Unboxed.isPinned (arrContents arr1)
2244− then Unboxed.pinnedNew newLen
2245− else Unboxed.new newLen
2246− let len = len1 + len2
2644+ then liftIO $ Unboxed.pinnedNew len
2645+ else liftIO $ Unboxed.new len
22472646 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
22482647 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
22492648 return $ MutArray newArrContents 0 len len
@@ -2255,7 +2654,7 @@ spliceCopy arr1 arr2 = liftIO $ do
22552654spliceUnsafe :: MonadIO m =>
22562655 MutArray a -> MutArray a -> m (MutArray a)
22572656spliceUnsafe dst src =
2258− liftIO $ do
2657+ do
22592658 let startSrc = arrStart src
22602659 srcLen = arrEnd src - startSrc
22612660 endDst = arrEnd dst
@@ -2277,7 +2676,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
22772676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
22782677spliceWith sizer dst@(MutArray _ start end bound) src = do
22792678{-
2280− let f = writeAppendWith (`sizer` byteLength src) (return dst)
2679+ let f = appendWith (`sizer` byteLength src) (return dst)
22812680 in D.fold f (toStreamD src)
22822681-}
22832682 assert (end <= bound) (return ())
@@ -2293,7 +2692,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
22932692 $ "splice: newSize is less than the total size "
22942693 ++ "of arrays being appended. Please check the "
22952694 ++ "sizer function passed."
2296− liftIO $ realloc newSizeInBytes dst
2695+ realloc newSizeInBytes dst
22972696 else return dst
22982697 spliceUnsafe dst1 src
22992698
@@ -2330,11 +2729,22 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
23302729-- Splitting
23312730-------------------------------------------------------------------------------
23322731
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+
23332743-- | Drops the separator byte
23342744{-# INLINE breakOn #-}
23352745breakOn :: MonadIO m
23362746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2337−breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
2747+breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
23382748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
23392749 -- Need efficient stream based primitives that work on Word64.
23402750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
@@ -2357,32 +2767,41 @@ breakOn sep arr@MutArray{..} = asUnpinnedPtrUnsafe arr $ \p -> liftIO $ do
23572767 }
23582768 )
23592769
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+
23602792-- | Create two slices of an array without copying the original array. The
23612793-- specified index @i@ is the first index of the second slice.
23622794--
2795+{-# INLINE splitAt #-}
23632796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2364−splitAt i arr@MutArray{..} =
2797+splitAt i arr =
23652798 let maxIndex = length arr - 1
23662799 in if i < 0
23672800 then error "sliceAt: negative array index"
23682801 else if i > maxIndex
23692802 then error $ "sliceAt: specified array index " ++ show i
23702803 ++ " is beyond the maximum index " ++ show maxIndex
2371− else let off = i * SIZE_OF(a)
2372− p = arrStart + off
2373− in ( MutArray
2374− { arrContents = arrContents
2375− , arrStart = arrStart
2376− , arrEnd = p
2377− , arrBound = p
2378− }
2379− , MutArray
2380− { arrContents = arrContents
2381− , arrStart = p
2382− , arrEnd = arrEnd
2383− , arrBound = arrBound
2384− }
2385− )
2804+ else unsafeSplitAt i arr
23862805
23872806-------------------------------------------------------------------------------
23882807-- Casting
@@ -2432,9 +2851,13 @@ cast arr =
24322851-- guarantees that unsafe calls will be performed in the calling thread. Making
24332852-- it safe to pass heap-allocated objects to unsafe functions.
24342853
2435−-- Should we just name it asPtr, the unsafety is implicit for any pointer
2854+-- XXX Should we just name it asPtr, the unsafety is implicit for any pointer
24362855-- operations. And we are safe from Haskell perspective because we will be
24372856-- 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.
24382861
24392862-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
24402863-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2452,16 +2875,21 @@ cast arr =
24522875--
24532876-- /Pre-release/
24542877--
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." #-}
24552885{-# INLINE asPtrUnsafe #-}
24562886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2457−asPtrUnsafe arr f =
2458− Unboxed.asPtrUnsafe
2459− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2887+asPtrUnsafe = unsafePinnedAsPtr
24602888
2461−{-# INLINE asUnpinnedPtrUnsafe #-}
2462−asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2463−asUnpinnedPtrUnsafe arr f =
2464− Unboxed.asUnpinnedPtrUnsafe
2889+{-# INLINE unsafeAsPtr #-}
2890+unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2891+unsafeAsPtr arr f =
2892+ Unboxed.unsafeAsPtr
24652893 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
24662894
24672895-------------------------------------------------------------------------------
@@ -2479,28 +2907,26 @@ asUnpinnedPtrUnsafe arr f =
24792907-- /Pre-release/
24802908{-# INLINE byteCmp #-}
24812909byteCmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2482−byteCmp arr1 arr2 =
2483− liftIO
2484− $ do
2485− let marr1 = getMutableByteArray# (arrContents arr1)
2486− marr2 = getMutableByteArray# (arrContents arr2)
2487− !(I# st1#) = arrStart arr1
2488− !(I# st2#) = arrStart arr2
2489− !(I# len#) = byteLength arr1
2490− case compare (byteLength arr1) (byteLength arr2) of
2491− EQ -> do
2492− r <- liftIO $ IO $ \s# ->
2493− let res =
2494− I#
2495− (compareByteArrays#
2496− (unsafeCoerce# marr1)
2497− st1#
2498− (unsafeCoerce# marr2)
2499− st2#
2500− len#)
2501− in (# s#, res #)
2502− return $ compare r 0
2503− x -> return x
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
25042930
25052931{-# INLINE cmp #-}
25062932{-# DEPRECATED cmp "Please use byteCmp instead." #-}
@@ -2517,7 +2943,309 @@ byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
25172943byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
25182944
25192945-------------------------------------------------------------------------------
2520−-- NFData
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
25213249-------------------------------------------------------------------------------
25223250
25233251-- | Strip elements which match with predicate from both ends.