on master help sign in
Cleanup export section of streams of arrays in MutArray
0137a71Harendra Kumar
core/src/Streamly/Internal/Data/MutArray/Type.hs+27−26
@@ -46,6 +46,17 @@ module Streamly.Internal.Data.MutArray.Type
46 , new
46 , new
47 , newArrayWith
47 , newArrayWith
48
48
49+ -- ** Cloning arrays
50+ , clone
51+ , pinnedClone
52+
53+ -- ** Slicing
54+ -- | Get a subarray without copying
55+ , getSliceUnsafe
56+ , getSlice
57+ , splitAt -- XXX should be able to express using getSlice
58+ , breakOn
59+
49 -- *** From streams
60 -- *** From streams
50 , ArrayUnsafe (..)
61 , ArrayUnsafe (..)
51 , writeNWithUnsafe
62 , writeNWithUnsafe
@@ -114,6 +125,16 @@ module Streamly.Internal.Data.MutArray.Type
114 , writeAppendWith
125 , writeAppendWith
115 , writeAppend
126 , writeAppend
116
127
128+ -- *** Appending arrays
129+ , spliceCopy
130+ , spliceWith
131+ , splice
132+ , spliceExp
133+ , spliceUnsafe
134+ -- , putSlice
135+ -- , appendSlice
136+ -- , appendSliceFrom
137+
117 -- ** Eliminating and Reading
138 -- ** Eliminating and Reading
118
139
119 -- *** To streams
140 -- *** To streams
@@ -184,45 +205,25 @@ module Streamly.Internal.Data.MutArray.Type
184 , byteCmp
205 , byteCmp
185 , byteEq
206 , byteEq
186
207
187− -- ** Arrays of arrays
208+ -- Arrays of arrays
188 -- We can add dimensionality parameter to the array type to get
209 -- We can add dimensionality parameter to the array type to get
189 -- multidimensional arrays. Multidimensional arrays would just be a
210 -- multidimensional arrays. Multidimensional arrays would just be a
190 -- convenience wrapper on top of single dimensional arrays.
211 -- convenience wrapper on top of single dimensional arrays.
191
212
192− -- | Operations dealing with multiple arrays, streams of arrays or
213+ -- ** Streams of Arrays
193− -- multidimensional array representations.
214+ -- *** Group a stream into arrays
194−
195− -- *** Construct from streams
196 , chunksOf
215 , chunksOf
197 , pinnedChunksOf
216 , pinnedChunksOf
198 , buildChunks
217 , buildChunks
199
218
200− -- *** Eliminate to streams
219+ -- *** Flatten a stream of arrays
201 , concatChunks
220 , concatChunks
202 , concatChunksRev
221 , concatChunksRev
203
222
204− -- *** Construct from arrays
223+ -- *** Split an array into slices
205− -- get chunks without copying
206− , getSliceUnsafe
207− , getSlice
208 -- , getSlicesFromLenN
224 -- , getSlicesFromLenN
209− , splitAt -- XXX should be able to express using getSlice
210 , splitOn
225 , splitOn
211− , breakOn
226+ -- , slicesOf
212−
213− -- ** Cloning arrays
214− , clone
215− , pinnedClone
216−
217− -- ** Appending arrays
218− , spliceCopy
219− , spliceWith
220− , splice
221− , spliceExp
222− , spliceUnsafe
223− -- , putSlice
224− -- , appendSlice
225− -- , appendSliceFrom
226
227
227 -- ** Utilities
228 -- ** Utilities
228 , roundUpToPower2
229 , roundUpToPower2