@@ -31,39 +31,57 @@ module Streamly.Internal.Data.MutArray.Type
31 -- ** Type
31 -- ** Type
32 -- $arrayNotes
32 -- $arrayNotes
33 MutArray (..)
33 MutArray (..)
35− , MutableByteArray
35+ -- ** Conversion
36+ -- *** Pinned and Unpinned
38 , isPinned
39 , isPinned
40− -- -- * Constructing and Writing
41+ -- ** Casting
43+ , castUnsafe -- XXX unsafeCast
41 -- ** Construction
48 -- ** Construction
52+ -- | New arrays are always empty arrays with some reserve capacity to
53+ -- extend the length without reallocating.
55+ , newArrayWith -- emptyAlignedWith
57+ , pinnedNewAligned -- XXX not required
58+ -- , new -- uninitialized array of specified length
44− -- *** Uninitialized Arrays
64+ -- *** Slicing
45− , pinnedNew
65+ -- | Get a subarray without copying
46− , pinnedNewBytes
66+ , getSliceUnsafe -- XXX unsafeGetSlice
47− , pinnedNewAligned
67+ , getSlice
48− , new
68+ , splitAt -- XXX should be able to express using getSlice
49− , newArrayWith
69+ , breakOn
51− -- *** From streams
71+ -- *** Stream Folds
52 , ArrayUnsafe (..)
72 , ArrayUnsafe (..)
53− , writeNWithUnsafe
73+ , unsafeCreateOfWith
54− , writeNWith
74+ , unsafeCreateOf
55− , writeNUnsafe
75+ , unsafePinnedCreateOf
56− , pinnedWriteNUnsafe
76+ , pinnedCreateOf
57− , writeN
77+ , createOfWith
58− , pinnedWriteN
78+ , createOf
59− , pinnedWriteNAligned
79+ , revCreateOf
61− , writeWith
81+ , pinnedCreate
62− , write
82+ , createWith
63− , pinnedWrite
83+ , create
68 -- *** From containers
86 -- *** From containers
69 , fromListN
87 , fromListN
@@ -72,16 +90,18 @@ module Streamly.Internal.Data.MutArray.Type
72 , pinnedFromList
90 , pinnedFromList
73 , fromListRevN
91 , fromListRevN
74 , fromListRev
92 , fromListRev
75− , fromStreamDN
93+ , fromStreamN
76− , fromStreamD
94+ , fromStream
77 , fromPureStreamN
95 , fromPureStreamN
78 , fromPureStream
96 , fromPureStream
79 , fromByteStr#
97 , fromByteStr#
80 , fromPtrN
98 , fromPtrN
100+ , fromChunksRealloced -- fromSmallChunks
82 -- ** Random writes
102 -- ** Random writes
83 , putIndex
103 , putIndex
84− , putIndexUnsafe
104+ , putIndexUnsafe -- XXX unsafePutIndex
85 , putIndices
105 , putIndices
86 -- , putFromThenTo
106 -- , putFromThenTo
87 -- , putFrom -- start writing at the given position
107 -- , putFrom -- start writing at the given position
@@ -89,77 +109,70 @@ module Streamly.Internal.Data.MutArray.Type
89 -- , putFromTo
109 -- , putFromTo
90 -- , putFromRev
110 -- , putFromRev
91 -- , putUptoRev
111 -- , putUptoRev
92− , modifyIndexUnsafe
112+ , modifyIndexUnsafe -- XXX unsafeModifyIndex
93 , modifyIndex
113 , modifyIndex
94 , modifyIndices
114 , modifyIndices
96 , swapIndices
116 , swapIndices
97 , unsafeSwapIndices
117 , unsafeSwapIndices
99− -- ** Growing and Shrinking
119+ -- ** Reading
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.
104− -- *** Appending elements
121+ -- *** Indexing
105− , snocWith
122+ , getIndex
106− , snoc
123+ , getIndexUnsafe -- XXX unsafeGetIndex
107− , snocLinear
124+ -- , getFromThenTo
108− , snocMay
125+ , getIndexRev -- getRevIndex?
109− , snocUnsafe
126+ , indexReader
110−
127+ , indexReaderWith
111− -- *** Appending streams
112− , writeAppendNUnsafe
117− -- ** Eliminating and Reading
124− -- *** To containers
129+ -- *** To Streams
130 , readRev
131 , readRev
131 , toStreamK
134 , toStreamK
132 , toStreamKRev
136 , toStreamKRev
139+ -- *** To Containers
135 -- experimental
143 -- experimental
136 , producerWith
144 , producerWith
137 , producer
145 , producer
139− -- *** Random reads
147+ , reader
140− , getIndex
148+ , readerRevWith
141− , getIndexUnsafe
149+ , readerRev
147− -- ** Memory Management
150− , allocBytesToElemCount
156− -- ** Size
151+ -- ** Size and Capacity
158 , byteLength
154 , byteLength
159 -- , capacity
157 -- , capacity
160 , byteCapacity
158 , byteCapacity
161 , bytesFree
159 , bytesFree
161+ -- *** Capacity Management
164+ , allocBytesToElemCount
165+ , realloc -- this is "resize"
163 -- ** In-place Mutation Algorithms
176 -- ** In-place Mutation Algorithms
165 , reverse
178 , reverse
@@ -170,63 +183,121 @@ module Streamly.Internal.Data.MutArray.Type
170 , mergeBy
183 , mergeBy
173− -- ** Casting
186+ -- ** Growing and Shrinking
174− , cast
187+ -- | Arrays grow only at the end, though it is possible to grow on both
175− , castUnsafe
188+ -- sides and therefore have a cons as well as snoc. But that will require
176− , asBytes
189+ -- both lower and upper bound in the array representation.
178− , asUnpinnedPtrUnsafe
180− -- ** Folding
191+ -- *** Appending elements
181− , foldl'
192+ , snocWith
183− , cmp
194+ , snocLinear
196+ , snocUnsafe -- XXX unsafeSnoc
198+ -- *** Appending streams
204+ -- *** Appending arrays
209+ , spliceUnsafe -- XXX unsafeSplice
212+ -- , appendSliceFrom
214+ -- ** Serialization using Unbox
217+ , pokeSkipUnsafe -- unsafePokeSkip
219+ -- ** Deserialization using Unbox
221+ , peekUnconsUnsafe -- unsafePeekUncons
222+ , peekSkipUnsafe -- unsafePeekSkip
185− -- ** Arrays of arrays
224+ -- Arrays of arrays
186 -- We can add dimensionality parameter to the array type to get
225 -- We can add dimensionality parameter to the array type to get
187 -- multidimensional arrays. Multidimensional arrays would just be a
226 -- multidimensional arrays. Multidimensional arrays would just be a
188 -- convenience wrapper on top of single dimensional arrays.
227 -- convenience wrapper on top of single dimensional arrays.
190− -- | Operations dealing with multiple arrays, streams of arrays or
229+ -- ** Streams of Arrays
191− -- multidimensional array representations.
230+ -- *** Chunk
192−
231+ -- | Group a stream into arrays.
193− -- *** Construct from streams
194 , chunksOf
232 , chunksOf
195 , pinnedChunksOf
233 , pinnedChunksOf
196− , writeChunks
234+ , buildChunks
198− -- *** Eliminate to streams
236+ -- *** Split
199− , flattenArrays
237+ -- | Split an array into slices.
203− -- *** Construct from arrays
204− -- get chunks without copying
207 -- , getSlicesFromLenN
239 -- , getSlicesFromLenN
208− , splitAt -- XXX should be able to express using getSlice
240+ , splitOn
209− , breakOn
241+ -- , slicesOf
211− -- ** Cloning arrays
243+ -- *** Concat
212− , clone
244+ -- | Append the arrays in a stream to form a stream of elements.
213− , pinnedClone
245+ , concatWith
215− -- ** Appending arrays
247+ , concat
216− , spliceCopy
248+ , concatRev
218− , splice
250+ -- *** Compact
219− , spliceExp
251+ -- | Append the arrays in a stream to form a stream of larger arrays.
220− , spliceUnsafe
252+ , SpliceState (..)
221− -- , putSlice
253+ , pCompactLE
222− -- , appendSlice
254+ , pPinnedCompactLE
223− -- , appendSliceFrom
255+ , compactLeAs
225 -- ** Utilities
263 -- ** Utilities
226 , roundUpToPower2
264 , roundUpToPower2
229 , c_memchr
267 , c_memchr
286+ , writeAppendNUnsafe
293+ , pinnedWriteNUnsafe
296+ , pinnedWriteNAligned -- XXX not required
@@ -237,6 +308,7 @@ where
238import Control.Monad (when, void)
309import Control.Monad (when, void)
239import Control.Monad.IO.Class (MonadIO(..))
310import Control.Monad.IO.Class (MonadIO(..))
311+import Data.Bifunctor (first)
240import Data.Bits (shiftR, (.|.), (.&.))
312import Data.Bits (shiftR, (.|.), (.&.))
241import Data.Functor.Identity (Identity(..))
313import Data.Functor.Identity (Identity(..))
242import Data.Proxy (Proxy(..))
314import Data.Proxy (Proxy(..))
@@ -245,7 +317,6 @@ import Foreign.C.Types (CSize(..), CInt(..))
245import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
317import Foreign.Ptr (plusPtr, minusPtr, nullPtr)
246import Streamly.Internal.Data.MutByteArray.Type
318import Streamly.Internal.Data.MutByteArray.Type
247 ( MutByteArray(..)
319 ( MutByteArray(..)
249 , PinnedState(..)
320 , PinnedState(..)
250 , getMutableByteArray#
321 , getMutableByteArray#
251 , putSliceUnsafe
322 , putSliceUnsafe
@@ -264,13 +335,17 @@ import GHC.Ptr (Ptr(..))
264import Streamly.Internal.Data.Fold.Type (Fold(..))
335import Streamly.Internal.Data.Fold.Type (Fold(..))
265import Streamly.Internal.Data.Producer.Type (Producer (..))
336import Streamly.Internal.Data.Producer.Type (Producer (..))
266import Streamly.Internal.Data.Stream.Type (Stream)
337import Streamly.Internal.Data.Stream.Type (Stream)
338+import Streamly.Internal.Data.Parser.Type (Parser (..))
267import Streamly.Internal.Data.StreamK.Type (StreamK)
339import Streamly.Internal.Data.StreamK.Type (StreamK)
268import Streamly.Internal.Data.SVar.Type (adaptState, defState)
340import Streamly.Internal.Data.SVar.Type (adaptState, defState)
341+import Streamly.Internal.Data.Tuple.Strict (Tuple'(..))
269import Streamly.Internal.Data.Unfold.Type (Unfold(..))
342import Streamly.Internal.Data.Unfold.Type (Unfold(..))
270import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
343import Streamly.Internal.System.IO (arrayPayloadSize, defaultChunkSize)
272import qualified Streamly.Internal.Data.Fold.Type as FL
345import qualified Streamly.Internal.Data.Fold.Type as FL
273import qualified Streamly.Internal.Data.MutByteArray.Type as Unboxed
346import 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
274import qualified Streamly.Internal.Data.Producer as Producer
349import qualified Streamly.Internal.Data.Producer as Producer
275import qualified Streamly.Internal.Data.Stream.Type as D
350import qualified Streamly.Internal.Data.Stream.Type as D
276import qualified Streamly.Internal.Data.Stream.Lift as D
351import qualified Streamly.Internal.Data.Stream.Lift as D
@@ -278,7 +353,7 @@ import qualified Streamly.Internal.Data.StreamK.Type as K
278import qualified Prelude
353import qualified Prelude
280import Prelude hiding
355import Prelude hiding
281− (Foldable(..), read, unlines, splitAt, reverse, truncate)
356+ (Foldable(..), concat, read, unlines, splitAt, reverse, truncate)
283#include "DocTestDataMutArray.hs"
358#include "DocTestDataMutArray.hs"
@@ -404,6 +479,8 @@ isPinned MutArray{..} = Unboxed.isPinned arrContents
404-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
479-- we need more than that. See stg_pinnedNewAlignedByteArrayzh and
405-- allocatePinned in GHC source.
480-- allocatePinned in GHC source.
482+-- XXX Rename to emptyAlignedWith, alignSize should be first arg.
407-- | @newArrayWith allocator alignment count@ allocates a new array of zero
484-- | @newArrayWith allocator alignment count@ allocates a new array of zero
408-- length and with a capacity to hold @count@ elements, using @allocator
485-- length and with a capacity to hold @count@ elements, using @allocator
409-- size alignment@ as the memory allocator function.
486-- size alignment@ as the memory allocator function.
@@ -427,12 +504,25 @@ newArrayWith alloc alignSize count = do
427 , arrBound = size
504 , arrBound = size
507+-- For arrays "nil" sounds a bit odd. empty is better. The only problem with
508+-- empty is that it is also used by the Alternative type class. But assuming we
509+-- will mostly import the Array module qualified this should be fine.
511+-- | Create an empty array.
517+empty = MutArray Unboxed.empty 0 0 0
519+{-# DEPRECATED nil "Please use empty instead." #-}
431#ifdef DEVBUILD
521#ifdef DEVBUILD
432 Unbox a =>
522 Unbox a =>
434 MutArray a
524 MutArray a
435−nil = MutArray Unboxed.nil 0 0 0
525+nil = empty
437{-# INLINE newBytesAs #-}
527{-# INLINE newBytesAs #-}
438newBytesAs :: MonadIO m =>
528newBytesAs :: MonadIO m =>
@@ -449,12 +539,13 @@ newBytesAs ps bytes = do
449 , arrBound = bytes
539 , arrBound = bytes
452−-- | Allocates a pinned empty array that can hold 'count' items. The memory of
542+-- | Allocates a pinned empty array that with a reserved capacity of bytes.
453−-- the array is uninitialized and the allocation is aligned as per the
543+-- The memory of the array is uninitialized and the allocation is aligned as
454−-- 'Unboxed' instance of the type.
544+-- per the 'Unboxed' instance of the type.
456-- /Pre-release/
546-- /Pre-release/
457{-# INLINE pinnedNewBytes #-}
547{-# INLINE pinnedNewBytes #-}
548+{-# DEPRECATED pinnedNewBytes "Please use pinnedEmptyOf with appropriate calculation" #-}
458pinnedNewBytes :: MonadIO m =>
549pinnedNewBytes :: MonadIO m =>
459#ifdef DEVBUILD
550#ifdef DEVBUILD
460 Unbox a =>
551 Unbox a =>
@@ -479,21 +570,31 @@ newAs ps =
479 (error "new: alignment is not used in unpinned arrays.")
570 (error "new: alignment is not used in unpinned arrays.")
481-- XXX can unaligned allocation be more efficient when alignment is not needed?
572-- XXX can unaligned allocation be more efficient when alignment is not needed?
483−-- | Allocates an empty pinned array that can hold 'count' items. The memory of
574+-- | Allocates a pinned array of zero length but growable to the specified
484−-- the array is uninitialized and the allocation is aligned as per the 'Unboxed'
575+-- capacity without reallocation.
485−-- instance of the type.
576+{-# INLINE pinnedEmptyOf #-}
486−--
577+pinnedEmptyOf :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
578+pinnedEmptyOf = newAs Pinned
580+-- XXX Deprecate in major
581+-- {-# DEPRECATED pinnedNew "Please use pinnedEmptyOf instead." #-}
487{-# INLINE pinnedNew #-}
582{-# INLINE pinnedNew #-}
488pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
583pinnedNew :: forall m a. (MonadIO m, Unbox a) => Int -> m (MutArray a)
489−pinnedNew = newAs Pinned
584+pinnedNew = pinnedEmptyOf
491−-- | Allocates an empty unpinned array that can hold 'count' items. The memory
586+-- | Allocates an unpinned array of zero length but growable to the specified
492−-- of the array is uninitialized.
587+-- capacity without reallocation.
589+{-# INLINE emptyOf #-}
590+emptyOf :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
591+emptyOf = newAs Unpinned
593+-- XXX Deprecate in major
594+-- {-# DEPRECATED new "Please use emptyOf instead." #-}
494{-# INLINE new #-}
595{-# INLINE new #-}
495new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
596new :: (MonadIO m, Unbox a) => Int -> m (MutArray a)
496−new = newAs Unpinned
597+new = emptyOf
498-------------------------------------------------------------------------------
599-------------------------------------------------------------------------------
499-- Random writes
600-- Random writes
@@ -541,7 +642,7 @@ putIndices arr = FL.foldlM' step (return ())
544− step () (i, x) = liftIO (putIndex i arr x)
645+ step () (i, x) = putIndex i arr x
546-- | Modify a given index of an array using a modifier function.
647-- | Modify a given index of an array using a modifier function.
@@ -737,22 +838,19 @@ arrayChunkBytes = 1024
737roundDownTo :: Int -> Int -> Int
838roundDownTo :: Int -> Int -> Int
738roundDownTo elemSize size = size - (size `mod` elemSize)
839roundDownTo elemSize size = size - (size `mod` elemSize)
740−-- XXX See if resizing can be implemented by reading the old array as a stream
741−-- and then using writeN to the new array.
743-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
841-- NOTE: we are passing elemSize explicitly to avoid an Unboxed constraint.
744-- Since this is not inlined Unboxed consrraint leads to dictionary passing
842-- Since this is not inlined Unboxed consrraint leads to dictionary passing
745-- which complicates some inspection tests.
843-- which complicates some inspection tests.
747−{-# NOINLINE reallocExplicit #-}
845+{-# NOINLINE reallocExplicitAs #-}
748−reallocExplicit :: Int -> Int -> MutArray a -> IO (MutArray a)
846+reallocExplicitAs :: PinnedState -> Int -> Int -> MutArray a -> IO (MutArray a)
749−reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
847+reallocExplicitAs ps elemSize newCapacityInBytes MutArray{..} = do
750 assertM(arrEnd <= arrBound)
848 assertM(arrEnd <= arrBound)
752 -- Allocate new array
850 -- Allocate new array
753 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
851 let newCapMaxInBytes = roundUpLargeArray newCapacityInBytes
754 contents <-
852 contents <-
755− if Unboxed.isPinned arrContents
853+ if ps == Pinned
756 then Unboxed.pinnedNew newCapMaxInBytes
854 then Unboxed.pinnedNew newCapMaxInBytes
757 else Unboxed.new newCapMaxInBytes
855 else Unboxed.new newCapMaxInBytes
758 let !(MutByteArray mbarrFrom#) = arrContents
856 let !(MutByteArray mbarrFrom#) = arrContents
@@ -777,6 +875,10 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
777 , arrBound = newCapInBytes
875 , arrBound = newCapInBytes
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.
780-- | @realloc newCapacity array@ reallocates the array to the specified
882-- | @realloc newCapacity array@ reallocates the array to the specified
781-- capacity in bytes.
883-- capacity in bytes.
@@ -788,7 +890,12 @@ reallocExplicit elemSize newCapacityInBytes MutArray{..} = do
788-- If the original array is pinned, the newly allocated array is also pinned.
890-- If the original array is pinned, the newly allocated array is also pinned.
789{-# INLINABLE realloc #-}
891{-# INLINABLE realloc #-}
790realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
892realloc :: forall m a. (MonadIO m, Unbox a) => Int -> MutArray a -> m (MutArray a)
791−realloc bytes arr = liftIO $ reallocExplicit (SIZE_OF(a)) bytes arr
898+ in liftIO $ reallocExplicitAs ps (SIZE_OF(a)) bytes arr
793-- | @reallocWith label capSizer minIncrBytes array@. The label is used
900-- | @reallocWith label capSizer minIncrBytes array@. The label is used
794-- in error messages and the capSizer is used to determine the capacity of the
901-- in error messages and the capSizer is used to determine the capacity of the
@@ -811,14 +918,14 @@ reallocWith label capSizer minIncrBytes arr = do
813 badSize newSize =
920 badSize newSize =
814− concat
921+ Prelude.concat
816 , ": new array size (in bytes) is less than required size "
923 , ": new array size (in bytes) is less than required size "
817 , show newSize
924 , show newSize
818 , ". Please check the sizing function passed."
925 , ". Please check the sizing function passed."
821−-- | @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
822-- it is enough to hold the specified number of elements. Nothing is done if
929-- it is enough to hold the specified number of elements. Nothing is done if
823-- the specified capacity is less than the length of the array.
930-- the specified capacity is less than the length of the array.
@@ -826,34 +933,46 @@ reallocWith label capSizer minIncrBytes arr = do
826-- the block size (4K).
933-- the block size (4K).
828-- /Pre-release/
935-- /Pre-release/
829−{-# INLINE resize #-}
936+{-# INLINE grow #-}
830−resize :: forall m a. (MonadIO m, Unbox a) =>
937+grow :: forall m a. (MonadIO m, Unbox a) =>
831 Int -> MutArray a -> m (MutArray a)
938 Int -> MutArray a -> m (MutArray a)
832−resize nElems arr@MutArray{..} = do
939+grow nElems arr@MutArray{..} = do
833 let req = SIZE_OF(a) * nElems
940 let req = SIZE_OF(a) * nElems
834− len = arrEnd - arrStart
941+ cap = arrBound - arrStart
835− if req < len
942+ if req < cap
836 then return arr
943 then return arr
837 else realloc req arr
944 else realloc req arr
946+{-# DEPRECATED resize "Please use grow instead." #-}
947+{-# INLINE resize #-}
948+resize :: forall m a. (MonadIO m, Unbox a) =>
949+ Int -> MutArray a -> m (MutArray a)
839−-- | Like 'resize' but if the byte capacity is more than 'largeObjectThreshold'
952+-- | Like 'grow' but if the requested byte capacity is more than
840−-- then it is rounded up to the closest power of 2.
953+-- 'largeObjectThreshold' then it is rounded up to the closest power of 2.
842-- /Pre-release/
955-- /Pre-release/
843−{-# INLINE resizeExp #-}
956+{-# INLINE growExp #-}
844−resizeExp :: forall m a. (MonadIO m, Unbox a) =>
957+growExp :: forall m a. (MonadIO m, Unbox a) =>
845 Int -> MutArray a -> m (MutArray a)
958 Int -> MutArray a -> m (MutArray a)
846−resizeExp nElems arr@MutArray{..} = do
959+growExp nElems arr@MutArray{..} = do
847 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
960 let req = roundUpLargeArray (SIZE_OF(a) * nElems)
849 if req > largeObjectThreshold
962 if req > largeObjectThreshold
850 then roundUpToPower2 req
963 then roundUpToPower2 req
852− len = arrEnd - arrStart
965+ cap = arrBound - arrStart
853− if req1 < len
966+ if req1 < cap
854 then return arr
967 then return arr
855 else realloc req1 arr
968 else realloc req1 arr
970+{-# DEPRECATED resizeExp "Please use growExp instead." #-}
971+{-# INLINE resizeExp #-}
972+resizeExp :: forall m a. (MonadIO m, Unbox a) =>
973+ Int -> MutArray a -> m (MutArray a)
857-- | Resize the allocated memory to drop any reserved free space at the end of
976-- | Resize the allocated memory to drop any reserved free space at the end of
858-- the array and reallocate it to reduce wastage.
977-- the array and reallocate it to reduce wastage.
@@ -918,7 +1037,7 @@ snocUnsafe arr@MutArray{..} = snocNewEnd (INDEX_NEXT(arrEnd,a)) arr
918{-# INLINE snocMay #-}
1037{-# INLINE snocMay #-}
919snocMay :: forall m a. (MonadIO m, Unbox a) =>
1038snocMay :: forall m a. (MonadIO m, Unbox a) =>
920 MutArray a -> a -> m (Maybe (MutArray a))
1039 MutArray a -> a -> m (Maybe (MutArray a))
921−snocMay arr@MutArray{..} x = liftIO $ do
1040+snocMay arr@MutArray{..} x = do
922 let newEnd = INDEX_NEXT(arrEnd,a)
1041 let newEnd = INDEX_NEXT(arrEnd,a)
923 if newEnd <= arrBound
1042 if newEnd <= arrBound
924 then Just <$> snocNewEnd newEnd arr x
1043 then Just <$> snocNewEnd newEnd arr x
@@ -932,7 +1051,7 @@ snocWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
933 -> m (MutArray a)
1052 -> m (MutArray a)
934snocWithRealloc sizer arr x = do
1053snocWithRealloc sizer arr x = do
935− arr1 <- liftIO $ reallocWith "snocWith" sizer (SIZE_OF(a)) arr
1054+ arr1 <- reallocWith "snocWith" sizer (SIZE_OF(a)) arr
936 snocUnsafe arr1 x
1055 snocUnsafe arr1 x
938-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
1057-- | @snocWith sizer arr elem@ mutates @arr@ to append @elem@. The length of
@@ -954,7 +1073,7 @@ snocWith :: forall m a. (MonadIO m, Unbox a) =>
954 -> MutArray a
1073 -> MutArray a
956 -> m (MutArray a)
1075 -> m (MutArray a)
957−snocWith allocSize arr x = liftIO $ do
1076+snocWith allocSize arr x = do
958 let newEnd = INDEX_NEXT(arrEnd arr,a)
1077 let newEnd = INDEX_NEXT(arrEnd arr,a)
959 if newEnd <= arrBound arr
1078 if newEnd <= arrBound arr
960 then snocNewEnd newEnd arr x
1079 then snocNewEnd newEnd arr x
@@ -998,6 +1117,126 @@ snoc = snocWith f
998 then oldSize * 2
1117 then oldSize * 2
999 else roundUpToPower2 oldSize * 2
1118 else roundUpToPower2 oldSize * 2
1120+-------------------------------------------------------------------------------
1121+-- Serialization/Deserialization
1122+-------------------------------------------------------------------------------
1124+{-# INLINE pokeNewEnd #-}
1125+pokeNewEnd :: (MonadIO m, Unbox a) =>
1126+ Int -> MutArray Word8 -> a -> m (MutArray Word8)
1127+pokeNewEnd newEnd arr@MutArray{..} x = liftIO $ do
1128+ assert (newEnd <= arrBound) (return ())
1129+ liftIO $ pokeAt arrEnd arrContents x
1130+ return $ arr {arrEnd = newEnd}
1132+-- | Really really unsafe, unboxes a Haskell type and appends the resulting
1133+-- bytes to the byte array, may cause silent data corruption or if you are
1134+-- lucky a segfault if the array does not have enough space to append the
1138+{-# INLINE pokeAppendUnsafe #-}
1139+pokeAppendUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1140+ MutArray Word8 -> a -> m (MutArray Word8)
1141+pokeAppendUnsafe arr@MutArray{..} = pokeNewEnd (arrEnd + SIZE_OF(a)) arr
1143+-- | Skip the specified number of bytes in the array. The data in the skipped
1144+-- region remains uninitialzed.
1145+{-# INLINE pokeSkipUnsafe #-}
1146+pokeSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1147+pokeSkipUnsafe n arr@MutArray{..} = do
1148+ let newEnd = arrEnd + n
1149+ in assert (newEnd <= arrBound) (arr {arrEnd = newEnd})
1151+-- | Like 'pokeAppend' but does not grow the array when pre-allocated array
1152+-- capacity becomes full.
1155+{-# INLINE pokeAppendMay #-}
1156+pokeAppendMay :: forall m a. (MonadIO m, Unbox a) =>
1157+ MutArray Word8 -> a -> m (Maybe (MutArray Word8))
1158+pokeAppendMay arr@MutArray{..} x = liftIO $ do
1159+ let newEnd = arrEnd + SIZE_OF(a)
1160+ if newEnd <= arrBound
1161+ then Just <$> pokeNewEnd newEnd arr x
1162+ else return Nothing
1164+{-# NOINLINE pokeWithRealloc #-}
1165+pokeWithRealloc :: forall m a. (MonadIO m, Unbox a) =>
1169+ -> m (MutArray Word8)
1170+pokeWithRealloc sizer arr x = do
1171+ arr1 <- liftIO $ reallocWith "pokeWithRealloc" sizer (SIZE_OF(a)) arr
1172+ pokeAppendUnsafe arr1 x
1174+{-# INLINE pokeAppendWith #-}
1175+pokeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1179+ -> m (MutArray Word8)
1180+pokeAppendWith allocSize arr x = liftIO $ do
1181+ let newEnd = arrEnd arr + SIZE_OF(a)
1182+ if newEnd <= arrBound arr
1183+ then pokeNewEnd newEnd arr x
1184+ else pokeWithRealloc allocSize arr x
1186+-- | Unbox a Haskell type and append the resulting bytes to a mutable byte
1187+-- array. The array is grown exponentially when more space is needed.
1191+-- >>> pokeAppend arr x = MutArray.castUnsafe <$> MutArray.snoc (MutArray.castUnsafe arr) x
1193+{-# INLINE pokeAppend #-}
1194+pokeAppend :: forall m a. (MonadIO m, Unbox a) =>
1195+ MutArray Word8 -> a -> m (MutArray Word8)
1196+pokeAppend = pokeAppendWith f
1201+ if isPower2 oldSize
1203+ else roundUpToPower2 oldSize * 2
1205+-- | Really really unsafe, create a Haskell value from an unboxed byte array,
1206+-- does not check if the array is big enough, may return garbage or if you are
1207+-- lucky may cause a segfault.
1210+{-# INLINE peekUnconsUnsafe #-}
1211+peekUnconsUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1212+ MutArray Word8 -> m (a, MutArray Word8)
1213+peekUnconsUnsafe MutArray{..} = do
1214+ let start1 = arrStart + SIZE_OF(a)
1215+ assert (start1 <= arrEnd) (return ())
1217+ r <- peekAt arrStart arrContents
1218+ return (r, MutArray arrContents start1 arrEnd arrBound)
1220+-- | Discard the specified number of bytes in the array.
1221+{-# INLINE peekSkipUnsafe #-}
1222+peekSkipUnsafe :: Int -> MutArray Word8 -> MutArray Word8
1223+peekSkipUnsafe n MutArray{..} =
1224+ let start1 = arrStart + n
1225+ in assert (start1 <= arrEnd) (MutArray arrContents start1 arrEnd arrBound)
1227+-- | Create a Haskell value from its unboxed representation from the head of a
1228+-- byte array, return the value and the remaining array.
1229+{-# INLINE peekUncons #-}
1230+peekUncons :: forall m a. (MonadIO m, Unbox a) =>
1231+ MutArray Word8 -> m (Maybe a, MutArray Word8)
1232+peekUncons arr@MutArray{..} = do
1233+ let start1 = arrStart + SIZE_OF(a)
1235+ then return (Nothing, arr)
1237+ r <- peekAt arrStart arrContents
1238+ return (Just r, MutArray arrContents start1 arrEnd arrBound)
1001-------------------------------------------------------------------------------
1240-------------------------------------------------------------------------------
1002-- Random reads
1241-- Random reads
1003-------------------------------------------------------------------------------
1242-------------------------------------------------------------------------------
@@ -1040,15 +1279,10 @@ getIndexRev i MutArray{..} = do
1040data GetIndicesState contents start end st =
1279data GetIndicesState contents start end st =
1041 GetIndicesState contents start end st
1280 GetIndicesState contents start end st
1043−-- | Given an unfold that generates array indices, read the elements on those
1282+{-# INLINE indexReaderWith #-}
1044−-- indices from the supplied MutArray. An error is thrown if an index is out of
1048−{-# INLINE getIndicesD #-}
1049−getIndicesD :: (Monad m, Unbox a) =>
1283+indexReaderWith :: (Monad m, Unbox a) =>
1050 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1284 (forall b. IO b -> m b) -> D.Stream m Int -> Unfold m (MutArray a) a
1051−getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
1285+indexReaderWith liftio (D.Stream stepi sti) = Unfold step inject
@@ -1067,9 +1301,26 @@ getIndicesD liftio (D.Stream stepi sti) = Unfold step inject
1067 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1301 D.Skip s -> return $ D.Skip (GetIndicesState contents start end s)
1068 D.Stop -> return D.Stop
1302 D.Stop -> return D.Stop
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
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
1315+{-# INLINE indexReader #-}
1316+indexReader :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1317+indexReader = indexReaderWith liftIO
1319+-- XXX DO NOT REMOVE, change the signature to use Stream instead of unfold
1320+{-# DEPRECATED getIndices "Please use indexReader instead." #-}
1070{-# INLINE getIndices #-}
1321{-# INLINE getIndices #-}
1071getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1322getIndices :: (MonadIO m, Unbox a) => Stream m Int -> Unfold m (MutArray a) a
1072−getIndices = getIndicesD liftIO
1323+getIndices = indexReader
1074-------------------------------------------------------------------------------
1325-------------------------------------------------------------------------------
1075-- Subarrays
1326-- Subarrays
@@ -1364,7 +1615,7 @@ chunksOfAs ps n (D.Stream step state) =
1365-- Same as the following but may be more efficient:
1616-- Same as the following but may be more efficient:
1367−-- >>> chunksOf n = Stream.foldMany (MutArray.writeN n)
1618+-- >>> chunksOf n = Stream.foldMany (MutArray.createOf n)
1369-- /Pre-release/
1620-- /Pre-release/
1370{-# INLINE_NORMAL chunksOf #-}
1621{-# INLINE_NORMAL chunksOf #-}
@@ -1373,17 +1624,29 @@ chunksOf :: forall m a. (MonadIO m, Unbox a)
1373-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1624-- XXX the idiomatic implementation leads to large regression in the D.reverse'
1374-- benchmark. It seems it has difficulty producing optimized code when
1625-- benchmark. It seems it has difficulty producing optimized code when
1375-- converting to StreamK. Investigate GHC optimizations.
1626-- converting to StreamK. Investigate GHC optimizations.
1376−-- chunksOf n = D.foldMany (writeN n)
1627+-- chunksOf n = D.foldMany (createOf n)
1377chunksOf = chunksOfAs Unpinned
1628chunksOf = chunksOfAs Unpinned
1379-- | Like 'chunksOf' but creates pinned arrays.
1630-- | Like 'chunksOf' but creates pinned arrays.
1380{-# INLINE_NORMAL pinnedChunksOf #-}
1631{-# INLINE_NORMAL pinnedChunksOf #-}
1381pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1632pinnedChunksOf :: forall m a. (MonadIO m, Unbox a)
1382 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1633 => Int -> D.Stream m a -> D.Stream m (MutArray a)
1383−-- pinnedChunksOf n = D.foldMany (pinnedWriteN n)
1634+-- pinnedChunksOf n = D.foldMany (pinnedCreateOf n)
1384pinnedChunksOf = chunksOfAs Pinned
1635pinnedChunksOf = chunksOfAs Pinned
1386−-- XXX This should take a PinnedState
1637+-- | When we are buffering a stream of unknown size into an array we do not
1638+-- know how much space to pre-allocate. So we start with the min size and emit
1639+-- the array then keep on doubling the size every time. Thus we do not need to
1640+-- guess the optimum chunk size.
1642+-- We can incorporate this in chunksOfAs if the additional size parameter does
1645+{-# INLINE _chunksOfRange #-}
1646+_chunksOfRange :: -- (MonadIO m, Unbox a) =>
1647+ PinnedState -> Int -> Int -> D.Stream m a -> D.Stream m (MutArray a)
1648+_chunksOfRange _ps _low _hi = undefined
1387-- XXX buffer to a list instead?
1650-- XXX buffer to a list instead?
1388-- | Buffer the stream into arrays in memory.
1651-- | Buffer the stream into arrays in memory.
1389{-# INLINE arrayStreamKFromStreamDAs #-}
1652{-# INLINE arrayStreamKFromStreamDAs #-}
@@ -1401,16 +1664,10 @@ data FlattenState s contents a =
1401 OuterLoop s
1664 OuterLoop s
1402 | InnerLoop s contents !Int !Int
1665 | InnerLoop s contents !Int !Int
1404−-- | Use the "reader" unfold instead.
1406−-- @flattenArrays = unfoldMany reader@
1408−-- We can try this if there are any fusion issues in the unfold.
1410−{-# INLINE_NORMAL flattenArrays #-}
1667+{-# INLINE_NORMAL concatWith #-}
1411−flattenArrays :: forall m a. (MonadIO m, Unbox a)
1668+concatWith :: forall m a. (Monad m, Unbox a)
1412− => D.Stream m (MutArray a) -> D.Stream m a
1669+ => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1413−flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
1670+concatWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1427,19 +1684,30 @@ flattenArrays (D.Stream step state) = D.Stream step' (OuterLoop state)
1427 return $ D.Skip $ OuterLoop st
1684 return $ D.Skip $ OuterLoop st
1429 step' _ (InnerLoop st contents p end) = do
1686 step' _ (InnerLoop st contents p end) = do
1430− x <- liftIO $ peekAt p contents
1687+ x <- liftio $ peekAt p contents
1431 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1688 return $ D.Yield x (InnerLoop st contents (INDEX_NEXT(p,a)) end)
1433−-- | Use the "readerRev" unfold instead.
1690+-- | Use the "reader" unfold instead.
1435−-- @flattenArrays = unfoldMany readerRev@
1692+-- @concat = unfoldMany reader@
1437-- We can try this if there are any fusion issues in the unfold.
1694-- We can try this if there are any fusion issues in the unfold.
1439−{-# INLINE_NORMAL flattenArraysRev #-}
1696+{-# INLINE_NORMAL concat #-}
1697+concat :: forall m a. (MonadIO m, Unbox a)
1698+ => D.Stream m (MutArray a) -> D.Stream m a
1699+concat = concatWith liftIO
1701+{-# DEPRECATED flattenArrays "Please use \"unfoldMany reader\" instead." #-}
1702+{-# INLINE flattenArrays #-}
1440−flattenArraysRev :: forall m a. (MonadIO m, Unbox a)
1703+flattenArrays :: forall m a. (MonadIO m, Unbox a)
1441 => D.Stream m (MutArray a) -> D.Stream m a
1704 => D.Stream m (MutArray a) -> D.Stream m a
1705+flattenArrays = concat
1707+{-# INLINE_NORMAL concatRevWith #-}
1708+concatRevWith :: forall m a. (Monad m, Unbox a)
1709+ => (forall b. IO b -> m b) -> D.Stream m (MutArray a) -> D.Stream m a
1442−flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
1710+concatRevWith liftio (D.Stream step state) = D.Stream step' (OuterLoop state)
@@ -1457,10 +1725,27 @@ flattenArraysRev (D.Stream step state) = D.Stream step' (OuterLoop state)
1457 return $ D.Skip $ OuterLoop st
1725 return $ D.Skip $ OuterLoop st
1459 step' _ (InnerLoop st contents p start) = do
1727 step' _ (InnerLoop st contents p start) = do
1460− x <- liftIO $ peekAt p contents
1728+ x <- liftio $ peekAt p contents
1461 let cur = INDEX_PREV(p,a)
1729 let cur = INDEX_PREV(p,a)
1462 return $ D.Yield x (InnerLoop st contents cur start)
1730 return $ D.Yield x (InnerLoop st contents cur start)
1732+-- | Use the "readerRev" unfold instead.
1734+-- @concat = unfoldMany readerRev@
1736+-- We can try this if there are any fusion issues in the unfold.
1738+{-# INLINE_NORMAL concatRev #-}
1739+concatRev :: forall m a. (MonadIO m, Unbox a)
1740+ => D.Stream m (MutArray a) -> D.Stream m a
1741+concatRev = concatRevWith liftIO
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
1464-------------------------------------------------------------------------------
1749-------------------------------------------------------------------------------
1465-- Unfolds
1750-- Unfolds
1466-------------------------------------------------------------------------------
1751-------------------------------------------------------------------------------
@@ -1578,11 +1863,11 @@ toList MutArray{..} = liftIO $ go arrStart
1578 x <- peekAt p arrContents
1863 x <- peekAt p arrContents
1579 (:) x <$> go (INDEX_NEXT(p,a))
1864 (:) x <$> go (INDEX_NEXT(p,a))
1581−{-# INLINE_NORMAL toStreamDWith #-}
1866+{-# INLINE_NORMAL toStreamWith #-}
1582−toStreamDWith ::
1867+toStreamWith ::
1583 forall m a. (Monad m, Unbox a)
1868 forall m a. (Monad m, Unbox a)
1584 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1869 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1585−toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1870+toStreamWith liftio MutArray{..} = D.Stream step arrStart
@@ -1598,7 +1883,7 @@ toStreamDWith liftio MutArray{..} = D.Stream step arrStart
1599{-# INLINE_NORMAL read #-}
1884{-# INLINE_NORMAL read #-}
1600read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1885read :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1601−read = toStreamDWith liftIO
1886+read = toStreamWith liftIO
1603{-# INLINE toStreamKWith #-}
1888{-# INLINE toStreamKWith #-}
1604toStreamKWith ::
1889toStreamKWith ::
@@ -1617,11 +1902,11 @@ toStreamKWith liftio MutArray{..} = go arrStart
1617toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1902toStreamK :: forall m a. (MonadIO m, Unbox a) => MutArray a -> StreamK m a
1618toStreamK = toStreamKWith liftIO
1903toStreamK = toStreamKWith liftIO
1620−{-# INLINE_NORMAL toStreamDRevWith #-}
1905+{-# INLINE_NORMAL toStreamRevWith #-}
1621−toStreamDRevWith ::
1906+toStreamRevWith ::
1622 forall m a. (Monad m, Unbox a)
1907 forall m a. (Monad m, Unbox a)
1623 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1908 => (forall b. IO b -> m b) -> MutArray a -> D.Stream m a
1624−toStreamDRevWith liftio MutArray{..} =
1909+toStreamRevWith liftio MutArray{..} =
1625 let p = INDEX_PREV(arrEnd,a)
1910 let p = INDEX_PREV(arrEnd,a)
1626 in D.Stream step p
1911 in D.Stream step p
@@ -1639,7 +1924,7 @@ toStreamDRevWith liftio MutArray{..} =
1640{-# INLINE_NORMAL readRev #-}
1925{-# INLINE_NORMAL readRev #-}
1641readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1926readRev :: forall m a. (MonadIO m, Unbox a) => MutArray a -> D.Stream m a
1642−readRev = toStreamDRevWith liftIO
1927+readRev = toStreamRevWith liftIO
1644{-# INLINE toStreamKRevWith #-}
1929{-# INLINE toStreamKRevWith #-}
1645toStreamKRevWith ::
1930toStreamKRevWith ::
@@ -1688,7 +1973,7 @@ foldr f z arr = D.foldr f z $ read arr
1689-- XXX Keep the bound intact to not lose any free space? Perf impact?
1974-- XXX Keep the bound intact to not lose any free space? Perf impact?
1691−-- | @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
1692-- array.
1977-- array.
1694-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
1979-- Unsafe: Do not drive the fold beyond @n@ elements, it will lead to memory
@@ -1697,13 +1982,12 @@ foldr f z arr = D.foldr f z $ read arr
1697-- Any free space left in the array after appending @n@ elements is lost.
1982-- Any free space left in the array after appending @n@ elements is lost.
1699-- /Internal/
1984-- /Internal/
1700−{-# INLINE_NORMAL writeAppendNUnsafe #-}
1985+{-# INLINE_NORMAL unsafeAppendN #-}
1701−writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
1986+unsafeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1703 -> m (MutArray a)
1988 -> m (MutArray a)
1704 -> Fold m a (MutArray a)
1989 -> Fold m a (MutArray a)
1705−writeAppendNUnsafe n action =
1706− fmap fromArrayUnsafe $ FL.foldlM' step initial
1990+unsafeAppendN n action = fmap fromArrayUnsafe $ FL.foldlM' step initial
@@ -1716,7 +2000,7 @@ writeAppendNUnsafe n action =
1716 -- otherwise we lose that space.
2000 -- otherwise we lose that space.
1718 if free < needed
2002 if free < needed
1719− then noinline reallocWith "writeAppendNUnsafeWith" (+ needed) needed arr
2003+ then noinline reallocWith "unsafeAppendN" (+ needed) needed arr
1720 else return arr
2004 else return arr
1721 return $ toArrayUnsafe arr1
2005 return $ toArrayUnsafe arr1
@@ -1724,30 +2008,51 @@ writeAppendNUnsafe n action =
1724 liftIO $ pokeAt end contents x
2008 liftIO $ pokeAt end contents x
1725 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2009 return $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2011+{-# DEPRECATED writeAppendNUnsafe "Please use unsafeAppendN instead." #-}
2012+{-# INLINE writeAppendNUnsafe #-}
2013+writeAppendNUnsafe :: forall m a. (MonadIO m, Unbox a) =>
2016+ -> Fold m a (MutArray a)
2017+writeAppendNUnsafe = unsafeAppendN
1727-- | Append @n@ elements to an existing array. Any free space left in the array
2019-- | Append @n@ elements to an existing array. Any free space left in the array
1728-- after appending @n@ elements is lost.
2020-- after appending @n@ elements is lost.
1730−-- >>> writeAppendN n initial = Fold.take n (MutArray.writeAppendNUnsafe n initial)
2022+-- >>> appendN n initial = Fold.take n (MutArray.unsafeAppendN n initial)
1732−{-# INLINE_NORMAL writeAppendN #-}
2024+{-# INLINE_NORMAL appendN #-}
2025+appendN :: forall m a. (MonadIO m, Unbox a) =>
2026+ Int -> m (MutArray a) -> Fold m a (MutArray a)
2027+appendN n initial = FL.take n (unsafeAppendN n initial)
2029+-- XXX Deprecate in major
2030+-- {-# DEPRECATED writeAppendN "Please use appendN instead." #-}
2031+{-# INLINE writeAppendN #-}
1733writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
2032writeAppendN :: forall m a. (MonadIO m, Unbox a) =>
1734 Int -> m (MutArray a) -> Fold m a (MutArray a)
2033 Int -> m (MutArray a) -> Fold m a (MutArray a)
1735−writeAppendN n initial = FL.take n (writeAppendNUnsafe n initial)
2034+writeAppendN = appendN
1737−-- | @writeAppendWith realloc action@ mutates the array generated by @action@ to
2036+-- | @appendWith realloc action@ mutates the array generated by @action@ to
1738-- append the input stream. If there is no reserved space available in the
2037-- append the input stream. If there is no reserved space available in the
1739-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
2038-- array it is reallocated to a size in bytes determined by @realloc oldSize@,
1740-- where @oldSize@ is the current size of the array in bytes.
2039-- where @oldSize@ is the current size of the array in bytes.
1742-- Note that the returned array may be a mutated version of original array.
2041-- Note that the returned array may be a mutated version of original array.
1744−-- >>> writeAppendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
2043+-- >>> appendWith sizer = Fold.foldlM' (MutArray.snocWith sizer)
1746-- /Pre-release/
2045-- /Pre-release/
2046+{-# INLINE appendWith #-}
2047+appendWith :: forall m a. (MonadIO m, Unbox a) =>
2048+ (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2049+appendWith sizer = FL.foldlM' (snocWith sizer)
2051+{-# DEPRECATED writeAppendWith "Please use appendWith instead." #-}
1747{-# INLINE writeAppendWith #-}
2052{-# INLINE writeAppendWith #-}
1748writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
2053writeAppendWith :: forall m a. (MonadIO m, Unbox a) =>
1749 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
2054 (Int -> Int) -> m (MutArray a) -> Fold m a (MutArray a)
1750−writeAppendWith sizer = FL.foldlM' (snocWith sizer)
2055+writeAppendWith = appendWith
1752-- | @append action@ mutates the array generated by @action@ to append the
2057-- | @append action@ mutates the array generated by @action@ to append the
1753-- input stream. If there is no reserved space available in the array it is
2058-- input stream. If there is no reserved space available in the array it is
@@ -1755,26 +2060,33 @@ writeAppendWith sizer = FL.foldlM' (snocWith sizer)
1756-- Note that the returned array may be a mutated version of original array.
2061-- Note that the returned array may be a mutated version of original array.
1758−-- >>> writeAppend = MutArray.writeAppendWith (* 2)
2063+-- >>> append = MutArray.appendWith (* 2)
2065+{-# INLINE append #-}
2066+append :: forall m a. (MonadIO m, Unbox a) =>
2067+ m (MutArray a) -> Fold m a (MutArray a)
2068+append = appendWith (* 2)
2070+-- XXX Deprecate in major
2071+-- {-# DEPRECATED writeAppend "Please use append instead." #-}
1760{-# INLINE writeAppend #-}
2072{-# INLINE writeAppend #-}
1761writeAppend :: forall m a. (MonadIO m, Unbox a) =>
2073writeAppend :: forall m a. (MonadIO m, Unbox a) =>
1762 m (MutArray a) -> Fold m a (MutArray a)
2074 m (MutArray a) -> Fold m a (MutArray a)
1763−writeAppend = writeAppendWith (* 2)
2075+writeAppend = append
1765-- XXX We can carry bound as well in the state to make sure we do not lose the
2077-- XXX We can carry bound as well in the state to make sure we do not lose the
1766-- remaining capacity. Need to check perf impact.
2078-- remaining capacity. Need to check perf impact.
1768−-- | Like 'writeNUnsafe' but takes a new array allocator @alloc size@ function
2080+-- | Like 'unsafeCreateOf' but takes a new array allocator @alloc size@
1769−-- as argument.
2081+-- function as argument.
1771−-- >>> writeNWithUnsafe alloc n = MutArray.writeAppendNUnsafe (alloc n) n
2083+-- >>> unsafeCreateOfWith alloc n = MutArray.unsafeAppendN (alloc n) n
1773-- /Pre-release/
2085-- /Pre-release/
1774−{-# INLINE_NORMAL writeNWithUnsafe #-}
2086+{-# INLINE_NORMAL unsafeCreateOfWith #-}
1775−writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2087+unsafeCreateOfWith :: forall m a. (MonadIO m, Unbox a)
1776 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2088 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1777−writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
2089+unsafeCreateOfWith alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
@@ -1785,40 +2097,64 @@ writeNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1786 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2098 $ ArrayUnsafe contents start (INDEX_NEXT(end,a))
2100+{-# DEPRECATED writeNWithUnsafe "Please use unsafeCreateOfWith instead." #-}
2101+{-# INLINE writeNWithUnsafe #-}
2102+writeNWithUnsafe :: forall m a. (MonadIO m, Unbox a)
2103+ => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2104+writeNWithUnsafe = unsafeCreateOfWith
1788{-# INLINE_NORMAL writeNUnsafeAs #-}
2106{-# INLINE_NORMAL writeNUnsafeAs #-}
1789writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
2107writeNUnsafeAs :: forall m a. (MonadIO m, Unbox a)
1790 => PinnedState -> Int -> Fold m a (MutArray a)
2108 => PinnedState -> Int -> Fold m a (MutArray a)
1791−writeNUnsafeAs ps = writeNWithUnsafe (newAs ps)
2109+writeNUnsafeAs ps = unsafeCreateOfWith (newAs ps)
1793−-- | 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
1794-- driver must not call the step function more than 'n' times otherwise it will
2112-- driver must not call the step function more than 'n' times otherwise it will
1795-- corrupt the memory and crash. This function exists mainly because any
2113-- corrupt the memory and crash. This function exists mainly because any
1796-- conditional in the step function blocks fusion causing 10x performance
2114-- conditional in the step function blocks fusion causing 10x performance
1797-- slowdown.
2115-- slowdown.
1799−-- >>> writeNUnsafe = MutArray.writeNWithUnsafe MutArray.new
2117+-- >>> unsafeCreateOf = MutArray.unsafeCreateOfWith MutArray.emptyOf
2119+{-# INLINE_NORMAL unsafeCreateOf #-}
2120+unsafeCreateOf :: forall m a. (MonadIO m, Unbox a)
2121+ => Int -> Fold m a (MutArray a)
2122+unsafeCreateOf = writeNUnsafeAs Unpinned
2124+{-# DEPRECATED writeNUnsafe "Please use unsafeCreateOf instead." #-}
1801−{-# INLINE_NORMAL writeNUnsafe #-}
2125+{-# INLINE writeNUnsafe #-}
1802writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
2126writeNUnsafe :: forall m a. (MonadIO m, Unbox a)
1803 => Int -> Fold m a (MutArray a)
2127 => Int -> Fold m a (MutArray a)
1804−writeNUnsafe = writeNUnsafeAs Unpinned
2128+writeNUnsafe = unsafeCreateOf
1806−-- | Like 'writeNUnsafe' but creates a pinned array.
2130+-- | Like 'unsafeCreateOf' but creates a pinned array.
2131+{-# INLINE_NORMAL unsafePinnedCreateOf #-}
2132+unsafePinnedCreateOf :: forall m a. (MonadIO m, Unbox a)
2133+ => Int -> Fold m a (MutArray a)
2134+unsafePinnedCreateOf = writeNUnsafeAs Pinned
2136+{-# DEPRECATED pinnedWriteNUnsafe "Please use unsafePinnedCreateOf instead." #-}
1807−{-# INLINE_NORMAL pinnedWriteNUnsafe #-}
2137+{-# INLINE pinnedWriteNUnsafe #-}
1808pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
2138pinnedWriteNUnsafe :: forall m a. (MonadIO m, Unbox a)
1809 => Int -> Fold m a (MutArray a)
2139 => Int -> Fold m a (MutArray a)
1810−pinnedWriteNUnsafe = writeNUnsafeAs Pinned
2140+pinnedWriteNUnsafe = unsafePinnedCreateOf
1812−-- | @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
1813-- allocated using the @alloc@ function.
2143-- allocated using the @alloc@ function.
1815−-- >>> writeNWith alloc n = Fold.take n (MutArray.writeNWithUnsafe alloc n)
2145+-- >>> createOfWith alloc n = Fold.take n (MutArray.unsafeCreateOfWith alloc n)
1816−-- >>> writeNWith alloc n = MutArray.writeAppendN (alloc n) n
2146+-- >>> createOfWith alloc n = MutArray.appendN (alloc n) n
1818−{-# INLINE_NORMAL writeNWith #-}
2148+{-# INLINE_NORMAL createOfWith #-}
2149+createOfWith :: forall m a. (MonadIO m, Unbox a)
2150+ => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2151+createOfWith alloc n = FL.take n (unsafeCreateOfWith alloc n)
2153+-- {-# DEPRECATED writeNWith "Please use createOfWith instead." #-}
2154+{-# INLINE writeNWith #-}
1819writeNWith :: forall m a. (MonadIO m, Unbox a)
2155writeNWith :: forall m a. (MonadIO m, Unbox a)
1820 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2156 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1821−writeNWith alloc n = FL.take n (writeNWithUnsafe alloc n)
2157+writeNWith = createOfWith
1823{-# INLINE_NORMAL writeNAs #-}
2159{-# INLINE_NORMAL writeNAs #-}
1824writeNAs ::
2160writeNAs ::
@@ -1826,28 +2162,42 @@ writeNAs ::
1826 => PinnedState
2162 => PinnedState
1828 -> Fold m a (MutArray a)
2164 -> Fold m a (MutArray a)
1829−writeNAs ps = writeNWith (newAs ps)
2165+writeNAs ps = createOfWith (newAs ps)
1831−-- | @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
1832-- 'MutArray'.
2168-- 'MutArray'.
1834−-- >>> writeN = MutArray.writeNWith MutArray.new
2170+-- >>> createOf = MutArray.createOfWith MutArray.new
1835−-- >>> writeN n = Fold.take n (MutArray.writeNUnsafe n)
2171+-- >>> createOf n = Fold.take n (MutArray.unsafeCreateOf n)
1836−-- >>> writeN n = MutArray.writeAppendN n (MutArray.new n)
2172+-- >>> createOf n = MutArray.appendN n (MutArray.emptyOf n)
1838−{-# INLINE_NORMAL writeN #-}
2174+{-# INLINE_NORMAL createOf #-}
2175+createOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2176+createOf = writeNAs Unpinned
2178+-- XXX Deprecate in major
2179+-- {-# DEPRECATED writeN "Please use createOf instead." #-}
2180+{-# INLINE writeN #-}
1839writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2181writeN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1840−writeN = writeNAs Unpinned
2182+writeN = createOf
2184+-- | Like 'createOf' but creates a pinned array.
2185+{-# INLINE_NORMAL pinnedCreateOf #-}
2187+ forall m a. (MonadIO m, Unbox a)
2189+ -> Fold m a (MutArray a)
2190+pinnedCreateOf = writeNAs Pinned
1842−-- | Like 'writeN' but creates a pinned array.
2192+{-# DEPRECATED pinnedWriteN "Please use pinnedCreateOf instead." #-}
1843−{-# INLINE_NORMAL pinnedWriteN #-}
2193+{-# INLINE pinnedWriteN #-}
1844pinnedWriteN ::
2194pinnedWriteN ::
1845 forall m a. (MonadIO m, Unbox a)
2195 forall m a. (MonadIO m, Unbox a)
1847 -> Fold m a (MutArray a)
2197 -> Fold m a (MutArray a)
1848−pinnedWriteN = writeNAs Pinned
2198+pinnedWriteN = pinnedCreateOf
1850−-- | Like writeNWithUnsafe but writes the array in reverse order.
2200+-- | Like unsafeCreateOfWith but writes the array in reverse order.
1852-- /Internal/
2202-- /Internal/
1853{-# INLINE_NORMAL writeRevNWithUnsafe #-}
2203{-# INLINE_NORMAL writeRevNWithUnsafe #-}
@@ -1868,7 +2218,7 @@ writeRevNWithUnsafe alloc n = fromArrayUnsafe <$> FL.foldlM' step initial
1869 $ ArrayUnsafe contents ptr end
2219 $ ArrayUnsafe contents ptr end
1871−-- | Like writeNWith but writes the array in reverse order.
2221+-- | Like createOfWith but writes the array in reverse order.
1873-- /Internal/
2223-- /Internal/
1874{-# INLINE_NORMAL writeRevNWith #-}
2224{-# INLINE_NORMAL writeRevNWith #-}
@@ -1876,31 +2226,36 @@ writeRevNWith :: forall m a. (MonadIO m, Unbox a)
1876 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
2226 => (Int -> m (MutArray a)) -> Int -> Fold m a (MutArray a)
1877writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
2227writeRevNWith alloc n = FL.take n (writeRevNWithUnsafe alloc n)
1879−-- | Like writeN but writes the array in reverse order.
2229+-- | Like 'createOf' but writes the array in reverse order.
1881-- /Pre-release/
2231-- /Pre-release/
1882−{-# INLINE_NORMAL writeRevN #-}
2232+{-# INLINE_NORMAL revCreateOf #-}
2233+revCreateOf :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2234+revCreateOf = writeRevNWith new
2236+{-# DEPRECATED writeRevN "Please use revCreateOf instead." #-}
2237+{-# INLINE writeRevN #-}
1883writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
2238writeRevN :: forall m a. (MonadIO m, Unbox a) => Int -> Fold m a (MutArray a)
1884−writeRevN = writeRevNWith new
2239+writeRevN = revCreateOf
1886-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
2241-- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
1887-- input stream to a 'MutArray' aligned to the given size.
2242-- input stream to a 'MutArray' aligned to the given size.
1889−-- >>> pinnedWriteNAligned align = MutArray.writeNWith (MutArray.pinnedNewAligned align)
2244+-- >>> pinnedWriteNAligned align = MutArray.createOfWith (MutArray.pinnedNewAligned align)
1890−-- >>> pinnedWriteNAligned align n = MutArray.writeAppendN n (MutArray.pinnedNewAligned align n)
2245+-- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
1892-- /Pre-release/
2247-- /Pre-release/
1894{-# INLINE_NORMAL pinnedWriteNAligned #-}
2249{-# INLINE_NORMAL pinnedWriteNAligned #-}
1895pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
2250pinnedWriteNAligned :: forall m a. (MonadIO m, Unbox a)
1896 => Int -> Int -> Fold m a (MutArray a)
2251 => Int -> Int -> Fold m a (MutArray a)
1897−pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
2252+pinnedWriteNAligned align = createOfWith (pinnedNewAligned align)
1899-- XXX Buffer to a list instead?
2254-- XXX Buffer to a list instead?
1901-- | Buffer a stream into a stream of arrays.
2256-- | Buffer a stream into a stream of arrays.
1903−-- >>> writeChunks n = Fold.many (MutArray.writeN n) Fold.toStreamK
2258+-- >>> buildChunks n = Fold.many (MutArray.createOf n) Fold.toStreamK
1905-- Breaking an array into an array stream can be useful to consume a large
2260-- Breaking an array into an array stream can be useful to consume a large
1906-- array sequentially such that memory of the array is released incrementatlly.
2261-- array sequentially such that memory of the array is released incrementatlly.
@@ -1909,37 +2264,43 @@ pinnedWriteNAligned align = writeNWith (pinnedNewAligned align)
1910-- /Unimplemented/
2265-- /Unimplemented/
1912−{-# 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
2272+{-# DEPRECATED writeChunks "Please use buildChunks instead." #-}
2273+{-# INLINE writeChunks #-}
1913writeChunks :: (MonadIO m, Unbox a) =>
2274writeChunks :: (MonadIO m, Unbox a) =>
1914 Int -> Fold m a (StreamK n (MutArray a))
2275 Int -> Fold m a (StreamK n (MutArray a))
1915−writeChunks n = FL.many (writeN n) FL.toStreamK
2276+writeChunks = buildChunks
1917{-# INLINE_NORMAL writeWithAs #-}
2278{-# INLINE_NORMAL writeWithAs #-}
1918writeWithAs :: forall m a. (MonadIO m, Unbox a)
2279writeWithAs :: forall m a. (MonadIO m, Unbox a)
1919 => PinnedState -> Int -> Fold m a (MutArray a)
2280 => PinnedState -> Int -> Fold m a (MutArray a)
1920−-- writeWithAs ps n = FL.rmapM rightSize $ writeAppendWith (* 2) (newAs ps n)
2281+-- writeWithAs ps n = FL.rmapM rightSize $ appendWith (* 2) (newAs ps n)
1921writeWithAs ps elemCount =
2282writeWithAs ps elemCount =
1922 FL.rmapM extract $ FL.foldlM' step initial
2283 FL.rmapM extract $ FL.foldlM' step initial
1926 initial = do
2287 initial = do
1927− when (elemCount < 0) $ error "writeWith: elemCount is negative"
2288+ when (elemCount < 0) $ error "createWith: elemCount is negative"
1928− liftIO $ newAs ps elemCount
2289+ newAs ps elemCount
1930 step arr@(MutArray _ start end bound) x
2291 step arr@(MutArray _ start end bound) x
1931 | INDEX_NEXT(end,a) > bound = do
2292 | INDEX_NEXT(end,a) > bound = do
1932 let oldSize = end - start
2293 let oldSize = end - start
1933 newSize = max (oldSize * 2) 1
2294 newSize = max (oldSize * 2) 1
1934− arr1 <- liftIO $ reallocExplicit (SIZE_OF(a)) newSize arr
2295+ arr1 <- liftIO $ reallocExplicitAs ps (SIZE_OF(a)) newSize arr
1935 snocUnsafe arr1 x
2296 snocUnsafe arr1 x
1936 step arr x = snocUnsafe arr x
2297 step arr x = snocUnsafe arr x
1938 extract = liftIO . rightSize
2299 extract = liftIO . rightSize
1940−-- XXX Compare writeWith with fromStreamD which uses an array of streams
2301+-- XXX Compare createWith with fromStreamD which uses an array of streams
1941−-- implementation. We can write this using writeChunks above if that is faster.
2302+-- implementation. We can write this using buildChunks above if that is faster.
1942−-- If writeWith is faster then we should use that to implement
2303+-- If createWith is faster then we should use that to implement
1943-- fromStreamD.
2304-- fromStreamD.
1945-- XXX The realloc based implementation needs to make one extra copy if we use
2306-- XXX The realloc based implementation needs to make one extra copy if we use
@@ -1954,39 +2315,56 @@ writeWithAs ps elemCount =
1954-- XXX check if GHC's memory allocator is efficient enough. We can try the C
2315-- XXX check if GHC's memory allocator is efficient enough. We can try the C
1955-- malloc to compare against.
2316-- malloc to compare against.
1957−-- | @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
1958-- starts at a size big enough to hold minCount elements, the size is doubled
2319-- starts at a size big enough to hold minCount elements, the size is doubled
1959-- every time the array needs to be grown.
2320-- every time the array needs to be grown.
1961-- /Caution! Do not use this on infinite streams./
2322-- /Caution! Do not use this on infinite streams./
1963−-- >>> f n = MutArray.writeAppendWith (* 2) (MutArray.new n)
2324+-- >>> f n = MutArray.appendWith (* 2) (MutArray.emptyOf n)
1964−-- >>> writeWith n = Fold.rmapM MutArray.rightSize (f n)
2325+-- >>> createWith n = Fold.rmapM MutArray.rightSize (f n)
1965−-- >>> writeWith n = Fold.rmapM MutArray.fromArrayStreamK (MutArray.writeChunks n)
2326+-- >>> createWith n = Fold.rmapM MutArray.fromChunksK (MutArray.buildChunks n)
1967-- /Pre-release/
2328-- /Pre-release/
1968−{-# INLINE_NORMAL writeWith #-}
2329+{-# INLINE_NORMAL createWith #-}
2330+createWith :: forall m a. (MonadIO m, Unbox a)
2331+ => Int -> Fold m a (MutArray a)
2332+-- createWith n = FL.rmapM rightSize $ appendWith (* 2) (emptyOf n)
2333+createWith = writeWithAs Unpinned
2335+{-# DEPRECATED writeWith "Please use createWith instead." #-}
2336+{-# INLINE writeWith #-}
1969writeWith :: forall m a. (MonadIO m, Unbox a)
2337writeWith :: forall m a. (MonadIO m, Unbox a)
1970 => Int -> Fold m a (MutArray a)
2338 => Int -> Fold m a (MutArray a)
1971−-- writeWith n = FL.rmapM rightSize $ writeAppendWith (* 2) (new n)
2339+writeWith = createWith
1972−writeWith = writeWithAs Unpinned
1974-- | Fold the whole input to a single array.
2341-- | Fold the whole input to a single array.
1976−-- Same as 'writeWith' using an initial array size of 'arrayChunkBytes' bytes
2343+-- Same as 'createWith' using an initial array size of 'arrayChunkBytes' bytes
1977-- rounded up to the element size.
2344-- rounded up to the element size.
1979-- /Caution! Do not use this on infinite streams./
2346-- /Caution! Do not use this on infinite streams./
2348+{-# INLINE create #-}
2349+create :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2350+create = createWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2352+-- XXX Deprecate in major
2353+-- {-# DEPRECATED write "Please use create instead." #-}
1981{-# INLINE write #-}
2354{-# INLINE write #-}
1982write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2355write :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1983−write = writeWith (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2356+write = create
1985−-- | Like 'write' but creates a pinned array.
2358+-- | Like 'create' but creates a pinned array.
2359+{-# INLINE pinnedCreate #-}
2360+pinnedCreate :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2362+ writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
2364+{-# DEPRECATED pinnedWrite "Please use pinnedCreate instead." #-}
1986{-# INLINE pinnedWrite #-}
2365{-# INLINE pinnedWrite #-}
1987pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
2366pinnedWrite :: forall m a. (MonadIO m, Unbox a) => Fold m a (MutArray a)
1988−pinnedWrite =
2367+pinnedWrite = pinnedCreate
1989− writeWithAs Pinned (allocBytesToElemCount (undefined :: a) arrayChunkBytes)
1991-------------------------------------------------------------------------------
2369-------------------------------------------------------------------------------
1992-- construct from streams, known size
2370-- construct from streams, known size
@@ -1996,7 +2374,7 @@ pinnedWrite =
1996fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
2374fromStreamDNAs :: forall m a. (MonadIO m, Unbox a)
1997 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
2375 => PinnedState -> Int -> D.Stream m a -> m (MutArray a)
1998fromStreamDNAs ps limit str = do
2376fromStreamDNAs ps limit str = do
1999− (arr :: MutArray a) <- liftIO $ newAs ps limit
2377+ (arr :: MutArray a) <- newAs ps limit
2000 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
2378 end <- D.foldlM' (fwrite (arrContents arr)) (return $ arrEnd arr) $ D.take limit str
2001 return $ arr {arrEnd = end}
2379 return $ arr {arrEnd = end}
@@ -2006,15 +2384,21 @@ fromStreamDNAs ps limit str = do
2006 liftIO $ pokeAt ptr arrContents x
2384 liftIO $ pokeAt ptr arrContents x
2007 return $ INDEX_NEXT(ptr,a)
2385 return $ INDEX_NEXT(ptr,a)
2009−-- | Use the 'writeN' fold instead.
2387+-- | Use the 'createOf' fold instead.
2011−-- >>> fromStreamDN n = Stream.fold (MutArray.writeN n)
2389+-- >>> fromStreamN n = Stream.fold (MutArray.createOf n)
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
2397+{-# DEPRECATED fromStreamDN "Please use fromStreamN instead." #-}
2013−{-# INLINE_NORMAL fromStreamDN #-}
2398+{-# INLINE fromStreamDN #-}
2014fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2399fromStreamDN :: forall m a. (MonadIO m, Unbox a)
2015 => Int -> D.Stream m a -> m (MutArray a)
2400 => Int -> D.Stream m a -> m (MutArray a)
2016−-- fromStreamDN n = D.fold (writeN n)
2401+fromStreamDN = fromStreamN
2017−fromStreamDN = fromStreamDNAs Unpinned
2019-- | Create a 'MutArray' from the first N elements of a list. The array is
2403-- | Create a 'MutArray' from the first N elements of a list. The array is
2020-- allocated to size N, if the list terminates before N elements then the
2404-- allocated to size N, if the list terminates before N elements then the
@@ -2034,20 +2418,20 @@ pinnedFromListN n xs = fromStreamDNAs Pinned n $ D.fromList xs
2034-- /Pre-release/
2418-- /Pre-release/
2035{-# INLINE fromListRevN #-}
2419{-# INLINE fromListRevN #-}
2036fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2420fromListRevN :: (MonadIO m, Unbox a) => Int -> [a] -> m (MutArray a)
2037−fromListRevN n xs = D.fold (writeRevN n) $ D.fromList xs
2421+fromListRevN n xs = D.fold (revCreateOf n) $ D.fromList xs
2039-- | Convert a pure stream in Identity monad to a mutable array.
2423-- | Convert a pure stream in Identity monad to a mutable array.
2040{-# INLINABLE fromPureStreamN #-}
2424{-# INLINABLE fromPureStreamN #-}
2041fromPureStreamN :: (MonadIO m, Unbox a) =>
2425fromPureStreamN :: (MonadIO m, Unbox a) =>
2042 Int -> Stream Identity a -> m (MutArray a)
2426 Int -> Stream Identity a -> m (MutArray a)
2043fromPureStreamN n xs =
2427fromPureStreamN n xs =
2044− liftIO $ D.fold (writeN n) $ D.morphInner (return . runIdentity) xs
2428+ D.fold (createOf n) $ D.morphInner (return . runIdentity) xs
2046-- | Convert a pure stream in Identity monad to a mutable array.
2430-- | Convert a pure stream in Identity monad to a mutable array.
2047{-# INLINABLE fromPureStream #-}
2431{-# INLINABLE fromPureStream #-}
2048fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2432fromPureStream :: (MonadIO m, Unbox a) => Stream Identity a -> m (MutArray a)
2049fromPureStream xs =
2433fromPureStream xs =
2050− liftIO $ D.fold write $ D.morphInner (return . runIdentity) xs
2434+ D.fold create $ D.morphInner (return . runIdentity) xs
2052{-# INLINABLE fromPtrN #-}
2436{-# INLINABLE fromPtrN #-}
2053fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
2437fromPtrN :: MonadIO m => Int -> Ptr Word8 -> m (MutArray Word8)
@@ -2056,7 +2440,7 @@ fromPtrN len addr = do
2056 -- XXX We can implement a stream copy in a similar way by streaming Word64
2440 -- XXX We can implement a stream copy in a similar way by streaming Word64
2057 -- first and then remaining Word8.
2441 -- first and then remaining Word8.
2058 arr <- new len
2442 arr <- new len
2059− _ <- asUnpinnedPtrUnsafe arr
2443+ _ <- unsafeAsPtr arr
2060 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2444 (\ptr -> liftIO $ c_memcpy ptr addr (fromIntegral len))
2061 return (arr {arrEnd = len})
2445 return (arr {arrEnd = len})
@@ -2072,11 +2456,32 @@ fromByteStr# addr = do
2072 len <- liftIO $ c_strlen (Ptr addr)
2456 len <- liftIO $ c_strlen (Ptr addr)
2073 let lenInt = fromIntegral len
2457 let lenInt = fromIntegral len
2074 arr <- new lenInt
2458 arr <- new lenInt
2075− _ <- asUnpinnedPtrUnsafe arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2459+ _ <- unsafeAsPtr arr (\ptr -> liftIO $ c_memcpy ptr (Ptr addr) len)
2076 return (arr {arrEnd = lenInt})
2460 return (arr {arrEnd = lenInt})
2078-------------------------------------------------------------------------------
2462-------------------------------------------------------------------------------
2463+-- convert a stream of arrays to a single array by reallocating and copying
2464+-------------------------------------------------------------------------------
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.
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
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.
2481+ Nothing -> pure nil
2483+-------------------------------------------------------------------------------
2079−-- convert stream to a single array
2484+-- convert a stream of arrays to a single array by buffering arrays first
2080-------------------------------------------------------------------------------
2485-------------------------------------------------------------------------------
2082{-# INLINE arrayStreamKLength #-}
2487{-# INLINE arrayStreamKLength #-}
@@ -2086,34 +2491,72 @@ arrayStreamKLength as = K.foldl' (+) 0 (K.map length as)
2086-- | Convert an array stream to an array. Note that this requires peak memory
2491-- | Convert an array stream to an array. Note that this requires peak memory
2087-- that is double the size of the array stream.
2492-- that is double the size of the array stream.
2494+{-# INLINE fromChunkskAs #-}
2495+fromChunkskAs :: (Unbox a, MonadIO m) =>
2496+ PinnedState -> StreamK m (MutArray a) -> m (MutArray a)
2497+fromChunkskAs ps as = do
2498+ len <- arrayStreamKLength as
2499+ arr <- newAs ps len
2500+ -- XXX is StreamK fold faster or StreamD fold?
2501+ K.foldlM' spliceUnsafe (pure arr) as
2502+ -- fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
2504+-- XXX Need to compare this with fromChunks and fromChunkList and keep the
2505+-- fastest or simplest one if all are equally fast.
2507+-- | Convert an array stream to an array. Note that this requires peak memory
2508+-- that is double the size of the array stream.
2510+-- Also see 'fromChunksRealloced'.
2512+{-# INLINE fromChunksK #-}
2513+fromChunksK :: (Unbox a, MonadIO m) =>
2514+ StreamK m (MutArray a) -> m (MutArray a)
2515+fromChunksK = fromChunkskAs Unpinned
2517+{-# DEPRECATED fromArrayStreamK "Please use fromChunksK instead." #-}
2089{-# INLINE fromArrayStreamK #-}
2518{-# INLINE fromArrayStreamK #-}
2090fromArrayStreamK :: (Unbox a, MonadIO m) =>
2519fromArrayStreamK :: (Unbox a, MonadIO m) =>
2091 StreamK m (MutArray a) -> m (MutArray a)
2520 StreamK m (MutArray a) -> m (MutArray a)
2092−fromArrayStreamK as = do
2521+fromArrayStreamK = fromChunksK
2093− len <- arrayStreamKLength as
2094− fromStreamDN len $ D.unfoldMany reader $ D.fromStreamK as
2096{-# INLINE fromStreamDAs #-}
2523{-# INLINE fromStreamDAs #-}
2097fromStreamDAs ::
2524fromStreamDAs ::
2098 (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
2525 (MonadIO m, Unbox a) => PinnedState -> D.Stream m a -> m (MutArray a)
2526+fromStreamDAs ps m =
2099−fromStreamDAs ps m = arrayStreamKFromStreamDAs ps m >>= fromArrayStreamK
2527+ arrayStreamKFromStreamDAs Unpinned m >>= fromChunkskAs ps
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.
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.
2538+{-# INLINE fromStream #-}
2539+fromStream :: (MonadIO m, Unbox a) => Stream m a -> m (MutArray a)
2540+fromStream = fromStreamDAs Unpinned
2542+-- fromStream (Stream m) = P.fold create m
2101-- CAUTION: a very large number (millions) of arrays can degrade performance
2543-- CAUTION: a very large number (millions) of arrays can degrade performance
2102-- due to GC overhead because we need to buffer the arrays before we flatten
2544-- due to GC overhead because we need to buffer the arrays before we flatten
2103-- all the arrays.
2545-- all the arrays.
2105−-- XXX Compare if this is faster or "fold write".
2547+-- XXX Compare if this is faster or "fold create".
2107-- | We could take the approach of doubling the memory allocation on each
2549-- | We could take the approach of doubling the memory allocation on each
2108-- overflow. This would result in more or less the same amount of copying as in
2550-- overflow. This would result in more or less the same amount of copying as in
2109-- the chunking approach. However, if we have to shrink in the end then it may
2551-- the chunking approach. However, if we have to shrink in the end then it may
2110-- result in an extra copy of the entire data.
2552-- result in an extra copy of the entire data.
2112−-- >>> fromStreamD = StreamD.fold MutArray.write
2554+-- >>> fromStreamD = StreamD.fold MutArray.create
2114{-# INLINE fromStreamD #-}
2556{-# INLINE fromStreamD #-}
2557+{-# DEPRECATED fromStreamD "Please use fromStream instead." #-}
2115fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2558fromStreamD :: (MonadIO m, Unbox a) => D.Stream m a -> m (MutArray a)
2116−fromStreamD = fromStreamDAs Unpinned
2559+fromStreamD = fromStream
2118-- | Create a 'MutArray' from a list. The list must be of finite size.
2561-- | Create a 'MutArray' from a list. The list must be of finite size.
@@ -2138,6 +2581,10 @@ fromListRev xs = fromListRevN (Prelude.length xs) xs
2138-- Cloning
2581-- Cloning
2139-------------------------------------------------------------------------------
2582-------------------------------------------------------------------------------
2584+-- Arrays are aligned on 64-bit boundaries. The fastest way to copy an array is
2585+-- to unsafeCast it to Word64, read it, write it to Word64 array and unsafeCast
2586+-- it again. We can use SIMD read/write as well.
2141{-# INLINE cloneAs #-}
2588{-# INLINE cloneAs #-}
2142cloneAs ::
2589cloneAs ::
2143 ( MonadIO m
2590 ( MonadIO m
@@ -2147,7 +2594,7 @@ cloneAs ::
2148 => PinnedState -> MutArray a -> m (MutArray a)
2595 => PinnedState -> MutArray a -> m (MutArray a)
2149cloneAs ps src =
2596cloneAs ps src =
2150− liftIO $ do
2597+ do
2151 let startSrc = arrStart src
2598 let startSrc = arrStart src
2152 srcLen = arrEnd src - startSrc
2599 srcLen = arrEnd src - startSrc
2153 newArrContents <-
2600 newArrContents <-
@@ -2186,17 +2633,16 @@ spliceCopy :: forall m a. MonadIO m =>
2186 Unbox a =>
2633 Unbox a =>
2188 MutArray a -> MutArray a -> m (MutArray a)
2635 MutArray a -> MutArray a -> m (MutArray a)
2189−spliceCopy arr1 arr2 = liftIO $ do
2636+spliceCopy arr1 arr2 = do
2190 let start1 = arrStart arr1
2637 let start1 = arrStart arr1
2191 start2 = arrStart arr2
2638 start2 = arrStart arr2
2192 len1 = arrEnd arr1 - start1
2639 len1 = arrEnd arr1 - start1
2193 len2 = arrEnd arr2 - start2
2640 len2 = arrEnd arr2 - start2
2194− let newLen = len1 + len2
2641+ let len = len1 + len2
2195 newArrContents <-
2642 newArrContents <-
2196 if Unboxed.isPinned (arrContents arr1)
2643 if Unboxed.isPinned (arrContents arr1)
2197− then Unboxed.pinnedNew newLen
2644+ then liftIO $ Unboxed.pinnedNew len
2198− else Unboxed.new newLen
2645+ else liftIO $ Unboxed.new len
2199− let len = len1 + len2
2200 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
2646 putSliceUnsafe (arrContents arr1) start1 newArrContents 0 len1
2201 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
2647 putSliceUnsafe (arrContents arr2) start2 newArrContents len1 len2
2202 return $ MutArray newArrContents 0 len len
2648 return $ MutArray newArrContents 0 len len
@@ -2208,7 +2654,7 @@ spliceCopy arr1 arr2 = liftIO $ do
2208spliceUnsafe :: MonadIO m =>
2654spliceUnsafe :: MonadIO m =>
2209 MutArray a -> MutArray a -> m (MutArray a)
2655 MutArray a -> MutArray a -> m (MutArray a)
2210spliceUnsafe dst src =
2656spliceUnsafe dst src =
2211− liftIO $ do
2657+ do
2212 let startSrc = arrStart src
2658 let startSrc = arrStart src
2213 srcLen = arrEnd src - startSrc
2659 srcLen = arrEnd src - startSrc
2214 endDst = arrEnd dst
2660 endDst = arrEnd dst
@@ -2230,7 +2676,7 @@ spliceWith :: forall m a. (MonadIO m, Unbox a) =>
2230 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2676 (Int -> Int -> Int) -> MutArray a -> MutArray a -> m (MutArray a)
2231spliceWith sizer dst@(MutArray _ start end bound) src = do
2677spliceWith sizer dst@(MutArray _ start end bound) src = do
2233− let f = writeAppendWith (`sizer` byteLength src) (return dst)
2679+ let f = appendWith (`sizer` byteLength src) (return dst)
2234 in D.fold f (toStreamD src)
2680 in D.fold f (toStreamD src)
2236 assert (end <= bound) (return ())
2682 assert (end <= bound) (return ())
@@ -2246,7 +2692,7 @@ spliceWith sizer dst@(MutArray _ start end bound) src = do
2246 $ "splice: newSize is less than the total size "
2692 $ "splice: newSize is less than the total size "
2247 ++ "of arrays being appended. Please check the "
2693 ++ "of arrays being appended. Please check the "
2248 ++ "sizer function passed."
2694 ++ "sizer function passed."
2249− liftIO $ realloc newSizeInBytes dst
2695+ realloc newSizeInBytes dst
2250 else return dst
2696 else return dst
2251 spliceUnsafe dst1 src
2697 spliceUnsafe dst1 src
@@ -2283,14 +2729,24 @@ spliceExp = spliceWith (\l1 l2 -> max (l1 * 2) (l1 + l2))
2283-- Splitting
2729-- Splitting
2284-------------------------------------------------------------------------------
2730-------------------------------------------------------------------------------
2732+-- | Generate a stream of array slices using a predicate. The array element
2733+-- matching the predicate is dropped.
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)
2286-- | Drops the separator byte
2743-- | Drops the separator byte
2287{-# INLINE breakOn #-}
2744{-# INLINE breakOn #-}
2288breakOn :: MonadIO m
2745breakOn :: MonadIO m
2289 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2746 => Word8 -> MutArray Word8 -> m (MutArray Word8, Maybe (MutArray Word8))
2290−breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2747+breakOn sep arr@MutArray{..} = unsafeAsPtr arr $ \p -> liftIO $ do
2291− -- XXX Instead of using asPtrUnsafe (pinning memory) we can pass unlifted
2292− -- Addr# to memchr and it should be safe (from ghc 8.4).
2293 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2748 -- XXX We do not need memchr here, we can use a Haskell equivalent.
2749+ -- Need efficient stream based primitives that work on Word64.
2294 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2750 loc <- c_memchr p sep (fromIntegral $ byteLength arr)
2295 let sepIndex = loc `minusPtr` p
2751 let sepIndex = loc `minusPtr` p
2296 return $
2752 return $
@@ -2311,32 +2767,41 @@ breakOn sep arr@MutArray{..} = asPtrUnsafe arr $ \p -> liftIO $ do
2770+-- | Like 'splitAt' but does not check whether the index is valid.
2772+{-# INLINE unsafeSplitAt #-}
2773+unsafeSplitAt :: forall a. Unbox a =>
2774+ Int -> MutArray a -> (MutArray a, MutArray a)
2775+unsafeSplitAt i MutArray{..} =
2776+ let off = i * SIZE_OF(a)
2779+ { arrContents = arrContents
2780+ , arrStart = arrStart
2785+ { arrContents = arrContents
2788+ , arrBound = arrBound
2314-- | Create two slices of an array without copying the original array. The
2792-- | Create two slices of an array without copying the original array. The
2315-- specified index @i@ is the first index of the second slice.
2793-- specified index @i@ is the first index of the second slice.
2795+{-# INLINE splitAt #-}
2317splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2796splitAt :: forall a. Unbox a => Int -> MutArray a -> (MutArray a, MutArray a)
2318−splitAt i arr@MutArray{..} =
2797+splitAt i arr =
2319 let maxIndex = length arr - 1
2798 let maxIndex = length arr - 1
2320 in if i < 0
2799 in if i < 0
2321 then error "sliceAt: negative array index"
2800 then error "sliceAt: negative array index"
2322 else if i > maxIndex
2801 else if i > maxIndex
2323 then error $ "sliceAt: specified array index " ++ show i
2802 then error $ "sliceAt: specified array index " ++ show i
2324 ++ " is beyond the maximum index " ++ show maxIndex
2803 ++ " is beyond the maximum index " ++ show maxIndex
2325− else let off = i * SIZE_OF(a)
2804+ else unsafeSplitAt i arr
2328− { arrContents = arrContents
2329− , arrStart = arrStart
2334− { arrContents = arrContents
2337− , arrBound = arrBound
2341-------------------------------------------------------------------------------
2806-------------------------------------------------------------------------------
2342-- Casting
2807-- Casting
@@ -2386,9 +2851,13 @@ cast arr =
2386-- guarantees that unsafe calls will be performed in the calling thread. Making
2851-- guarantees that unsafe calls will be performed in the calling thread. Making
2387-- it safe to pass heap-allocated objects to unsafe functions.
2852-- it safe to pass heap-allocated objects to unsafe functions.
2389−-- 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
2390-- operations. And we are safe from Haskell perspective because we will be
2855-- operations. And we are safe from Haskell perspective because we will be
2391-- pinning the memory.
2856-- pinning the memory.
2858+-- XXX we cannot pass the length of the ptr here as in some cases it may not be
2859+-- available e.g. a null terminated C string. However, we can create another
2860+-- flavor of the API e.g. asPtrN.
2393-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2862-- | Use a @MutArray a@ as @Ptr a@. This is useful when we want to pass an
2394-- array as a pointer to some operating system call or to a "safe" FFI call.
2863-- array as a pointer to some operating system call or to a "safe" FFI call.
@@ -2406,54 +2875,377 @@ cast arr =
2407-- /Pre-release/
2876-- /Pre-release/
2878+{-# INLINE unsafePinnedAsPtr #-}
2879+unsafePinnedAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2880+unsafePinnedAsPtr arr f =
2881+ Unboxed.unsafePinnedAsPtr
2882+ (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2884+{-# DEPRECATED asPtrUnsafe "Please use unsafePinnedAsPtr instead." #-}
2409{-# INLINE asPtrUnsafe #-}
2885{-# INLINE asPtrUnsafe #-}
2410asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2886asPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2411−asPtrUnsafe arr f =
2887+asPtrUnsafe = unsafePinnedAsPtr
2412− Unboxed.asPtrUnsafe
2413− (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2415−{-# INLINE asUnpinnedPtrUnsafe #-}
2889+{-# INLINE unsafeAsPtr #-}
2416−asUnpinnedPtrUnsafe :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2890+unsafeAsPtr :: MonadIO m => MutArray a -> (Ptr a -> m b) -> m b
2417−asUnpinnedPtrUnsafe arr f =
2891+unsafeAsPtr arr f =
2418− Unboxed.asUnpinnedPtrUnsafe
2892+ Unboxed.unsafeAsPtr
2419 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2893 (arrContents arr) (\ptr -> f (ptr `plusPtr` arrStart arr))
2421-------------------------------------------------------------------------------
2895-------------------------------------------------------------------------------
2422-- Equality
2896-- Equality
2423-------------------------------------------------------------------------------
2897-------------------------------------------------------------------------------
2425−-- | Compare the length of the arrays. If the length is equal, compare the
2899+-- | Byte compare two arrays. Compare the length of the arrays. If the length
2426−-- lexicographical ordering of two underlying byte arrays otherwise return the
2900+-- is equal, compare the lexicographical ordering of two underlying byte arrays
2427−-- result of length comparison.
2901+-- otherwise return the result of length comparison.
2903+-- /Unsafe/: Note that the 'Unbox' instance of sum types with constructors of
2904+-- different sizes may leave some memory uninitialized which can make byte
2905+-- comparison unreliable.
2429-- /Pre-release/
2907-- /Pre-release/
2908+{-# INLINE byteCmp #-}
2909+byteCmp :: 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
2918+ r <- liftIO $ IO $ \s# ->
2921+ (compareByteArrays#
2922+ (unsafeCoerce# marr1)
2924+ (unsafeCoerce# marr2)
2928+ return $ compare r 0
2430{-# INLINE cmp #-}
2931{-# INLINE cmp #-}
2932+{-# DEPRECATED cmp "Please use byteCmp instead." #-}
2431cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2933cmp :: MonadIO m => MutArray a -> MutArray a -> m Ordering
2432−cmp arr1 arr2 =
2934+cmp = byteCmp
2434− $ do
2936+-- | Byte equality of two arrays.
2435− let marr1 = getMutableByteArray# (arrContents arr1)
2937+--
2436− marr2 = getMutableByteArray# (arrContents arr2)
2938+-- >>> byteEq arr1 arr2 = (==) EQ $ MArray.byteCmp arr1 arr2
2437− !(I# st1#) = arrStart arr1
2939+--
2438− !(I# st2#) = arrStart arr2
2940+-- /Unsafe/: See 'byteCmp'.
2439− !(I# len#) = byteLength arr1
2941+{-# INLINE byteEq #-}
2440− case compare (byteLength arr1) (byteLength arr2) of
2942+byteEq :: MonadIO m => MutArray a -> MutArray a -> m Bool
2441− EQ -> do
2943+byteEq arr1 arr2 = fmap (EQ ==) $ byteCmp arr1 arr2
2442− r <- liftIO $ IO $ \s# ->
2944+
2443− let res =
2945+-------------------------------------------------------------------------------
2445− (compareByteArrays#
2947+-------------------------------------------------------------------------------
2446− (unsafeCoerce# marr1)
2948+
2447− st1#
2949+-- Note: LE versions avoid an extra copy compared to GE. LE parser trades
2448− (unsafeCoerce# marr2)
2950+-- backtracking one array in lieu of avoiding a copy. However, LE and GE both
2449− st2#
2951+-- can leave some memory unused. They can split the last array to fit it
2450− len#)
2952+-- exactly in the space.
2451− in (# s#, res #)
2953+
2452− return $ compare r 0
2954+{-# INLINE_NORMAL pCompactLeAs #-}
2453− x -> return x
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
2962+ maxBytes = maxElems * SIZE_OF(a)
2964+ functionName = "Streamly.Internal.Data.MutArray.pCompactLE"
2971+ ++ ": the size of arrays ["
2972+ ++ show maxElems ++ "] must be a natural number"
2973+ else Parser.IPartial Nothing
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
2988+ if byteCapacity buf < maxBytes
2989+ then liftIO $ reallocExplicitAs
2990+ ps (SIZE_OF(a)) maxBytes buf
2992+ buf2 <- spliceUnsafe buf1 arr
2993+ return $ Parser.Partial 0 (Just buf2)
2995+ extract Nothing = return $ Parser.Done 0 nil
2996+ extract (Just buf) = return $ Parser.Done 0 buf
2998+-- | Parser @pCompactLE maxElems@ coalesces adjacent arrays in the input stream
2999+-- only if the combined size would be less than or equal to @maxElems@
3000+-- elements. Note that it won't split an array if the original array is already
3001+-- larger than maxElems.
3003+-- @maxElems@ must be greater than 0.
3005+-- Generates unpinned arrays irrespective of the pinning status of input
3009+{-# INLINE pCompactLE #-}
3011+ forall m a. (MonadIO m, Unbox a)
3012+ => Int -> Parser (MutArray a) m (MutArray a)
3013+pCompactLE = pCompactLeAs Unpinned
3015+-- | Pinned version of 'pCompactLE'.
3016+{-# INLINE pPinnedCompactLE #-}
3018+ forall m a. (MonadIO m, Unbox a)
3019+ => Int -> Parser (MutArray a) m (MutArray a)
3020+pPinnedCompactLE = pCompactLeAs Pinned
3022+data SpliceState s arr
3024+ | SpliceBuffering s arr
3025+ | SpliceYielding arr (SpliceState s arr)
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.
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)
3041+ maxBytes = maxElems * SIZE_OF(a)
3043+ functionName = "Streamly.Internal.Data.MutArray.rCompactLE"
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"
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
3061+ -- XXX Split the last array to use the space more compactly.
3062+ step' gst (SpliceBuffering st buf) = do
3065+ D.Yield arr s -> do
3066+ let len = byteLength buf + byteLength arr
3069+ D.Skip (SpliceYielding buf (SpliceBuffering s arr))
3071+ buf1 <- if byteCapacity buf < maxBytes
3072+ then liftIO $ reallocExplicitAs
3073+ ps (SIZE_OF(a)) maxBytes 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)
3080+ step' _ SpliceFinish = return D.Stop
3082+ step' _ (SpliceYielding arr next) = return $ D.Yield arr next
3085+{-# INLINE_NORMAL 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
3093+ minBytes = minElems * SIZE_OF(a)
3095+ functionName = "Streamly.Internal.Data.MutArray.fCompactGE"
3102+ ++ ": the size of arrays ["
3103+ ++ show minElems ++ "] must be a natural number"
3104+ else FL.Partial Nothing
3108+ $ let len = byteLength arr
3109+ in if len >= minBytes
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
3116+ if byteCapacity buf < len
3117+ then liftIO $ reallocExplicitAs
3118+ ps (SIZE_OF(a)) (max minBytes len) buf
3120+ buf2 <- spliceUnsafe buf1 arr
3122+ then return $ FL.Done buf2
3123+ else return $ FL.Partial (Just buf2)
3125+ extract Nothing = return nil
3126+ extract (Just buf) = return buf
3128+-- | Fold @fCompactGE minElems@ coalesces adjacent arrays in the input stream
3129+-- until the size becomes greater than or equal to @minElems@.
3131+-- Generates unpinned arrays irrespective of the pinning status of input
3133+{-# INLINE fCompactGE #-}
3135+ forall m a. (MonadIO m, Unbox a)
3136+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3137+fCompactGE = fCompactGeAs Unpinned
3139+-- | Pinned version of 'fCompactGE'.
3140+{-# INLINE fPinnedCompactGE #-}
3142+ forall m a. (MonadIO m, Unbox a)
3143+ => Int -> FL.Fold m (MutArray a) (MutArray a)
3144+fPinnedCompactGE = fCompactGeAs Pinned
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
3156+ minBytes = minElems * SIZE_OF(a)
3158+ functionName = "Streamly.Internal.Data.MutArray.lCompactGE"
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"
3167+ return $ first (Tuple' Nothing) r
3169+ {-# INLINE runInner #-}
3170+ runInner len acc buf =
3175+ FL.Done _ -> return $ FL.Done ()
3179+ return $ first (Tuple' Nothing) res
3180+ else return $ FL.Partial $ Tuple' (Just buf) acc
3182+ step (Tuple' Nothing r1) arr =
3183+ runInner (byteLength arr) r1 arr
3185+ -- XXX Buffer arrays as a list to avoid copy and reallocations
3186+ step (Tuple' (Just buf) r1) arr = do
3187+ let len = byteLength buf + byteLength arr
3188+ buf1 <- if byteCapacity buf < len
3189+ then liftIO $ reallocExplicitAs
3190+ ps (SIZE_OF(a)) (max minBytes len) buf
3192+ buf2 <- spliceUnsafe buf1 arr
3193+ runInner len r1 buf2
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
3199+ -- extract forces the pending buffer to be sent to the fold which is not
3201+ extract _ = error "lCompactGE: not designed for scanning"
3203+ final (Tuple' Nothing r1) = final1 r1
3204+ final (Tuple' (Just buf) r1) = do
3207+ FL.Partial rr -> final1 rr
3208+ FL.Done _ -> return ()
3210+-- | Like 'compactGE' but for transforming folds instead of stream.
3212+-- >>> lCompactGE n = Fold.many (MutArray.fCompactGE n)
3214+-- Generates unpinned arrays irrespective of the pinning status of input
3216+{-# INLINE lCompactGE #-}
3217+lCompactGE :: forall m a. (MonadIO m, Unbox a)
3218+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3219+lCompactGE = lCompactGeAs Unpinned
3221+-- | Pinned version of 'lCompactGE'.
3222+{-# INLINE lPinnedCompactGE #-}
3223+lPinnedCompactGE :: forall m a. (MonadIO m, Unbox a)
3224+ => Int -> Fold m (MutArray a) () -> Fold m (MutArray a) ()
3225+lPinnedCompactGE = lCompactGeAs Pinned
3227+-- | @compactGE n stream@ coalesces adjacent arrays in the @stream@ until
3228+-- the size becomes greater than or equal to @n@.
3230+-- >>> compactGE n = Stream.foldMany (MutArray.fCompactGE n)
3232+{-# INLINE compactGE #-}
3234+ (MonadIO m, Unbox a)
3235+ => Int -> Stream m (MutArray a) -> Stream m (MutArray a)
3236+compactGE n = D.foldMany (fCompactGE n)
3238+-- | 'compactEQ n' coalesces adajacent arrays in the input stream to
3239+-- arrays of exact size @n@.
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)
2455-------------------------------------------------------------------------------
3247-------------------------------------------------------------------------------
2456−-- NFData
3248+-- In-place mutation algorithms
2457-------------------------------------------------------------------------------
3249-------------------------------------------------------------------------------
2459-- | Strip elements which match with predicate from both ends.
3251-- | Strip elements which match with predicate from both ends.