Streamly.Internal.Data.Array.Generic.Mut.Type

Type

data MutArray a

Constructors

MutArray

Fields

• arrContents# :: MutableArray# RealWorld a

  The internal contents of the array representing the entire array.

• arrStart :: !Int

  The starting index of this slice.

• arrLen :: !Int

  The length of this slice.

• arrTrueLen :: !Int

  This is the true length of the array. Coincidentally, this also represents the first index beyond the maximum acceptable index of the array. This is specific to the array contents itself and not dependent on the slice. This value should not change and is shared across all the slices.

Constructing and Writing

Construction

nil :: MonadIO m => m (MutArray a)

Definition:

>>> nil = MutArray.new 0

Uninitialized Arrays

new :: MonadIO m => Int -> m (MutArray a)

new count allocates a zero length array that can be extended to hold up to count items without reallocating.

Pre-release

From streams

writeNUnsafe :: MonadIO m => Int -> Fold m a (MutArray a)

Like writeN but does not check the array bounds when writing. The fold driver must not call the step function more than n times otherwise it will corrupt the memory and crash. This function exists mainly because any conditional in the step function blocks fusion causing 10x performance slowdown.

Pre-release

writeN :: MonadIO m => Int -> Fold m a (MutArray a)

writeN n folds a maximum of n elements from the input stream to an Array.

>>> writeN n = Fold.take n (MutArray.writeNUnsafe n)

Pre-release

writeWith :: MonadIO m => Int -> Fold m a (MutArray a)

writeWith minCount folds the whole input to a single array. The array starts at a size big enough to hold minCount elements, the size is doubled every time the array needs to be grown.

Caution! Do not use this on infinite streams.

Pre-release

write :: MonadIO m => Fold m a (MutArray a)

Fold the whole input to a single array.

Same as writeWith using an initial array size of arrayChunkSize bytes rounded up to the element size.

Caution! Do not use this on infinite streams.

From containers

Random writes

putIndex :: MonadIO m => Int -> MutArray a -> a -> m ()

O(1) Write the given element at the given index in the array. Performs in-place mutation of the array.

>>> putIndex ix arr val = MutArray.modifyIndex ix arr (const (val, ()))

Pre-release

putIndexUnsafe :: forall m a. MonadIO m => Int -> MutArray a -> a -> m ()

Write the given element to the given index of the array. Does not check if the index is out of bounds of the array.

Pre-release

putIndices :: MonadIO m => MutArray a -> Fold m (Int, a) ()

Write an input stream of (index, value) pairs to an array. Throws an error if any index is out of bounds.

Pre-release

modifyIndexUnsafe :: MonadIO m => Int -> MutArray a -> (a -> (a, b)) -> m b

Modify a given index of an array using a modifier function without checking the bounds.

Unsafe because it does not check the bounds of the array.

Pre-release

modifyIndex :: MonadIO m => Int -> MutArray a -> (a -> (a, b)) -> m b

Modify a given index of an array using a modifier function.

Pre-release

Growing and Shrinking

Reallocation

realloc :: MonadIO m => Int -> MutArray a -> m (MutArray a)

Reallocates the array according to the new size. This is a safe function that always creates a new array and copies the old array into the new one. If the reallocated size is less than the original array it results in a truncated version of the original array.

uninit :: MonadIO m => MutArray a -> Int -> m (MutArray a)

Make the uninitialized memory in the array available for use extending it by the supplied length beyond the current length of the array. The array may be reallocated.

Appending elements

snocWith :: MonadIO m => (Int -> Int) -> MutArray a -> a -> m (MutArray a)

snocWith sizer arr elem mutates arr to append elem. The length of the array increases by 1.

If there is no reserved space available in arr it is reallocated to a size in bytes determined by the sizer oldSize function, where oldSize is the original size of the array.

Note that the returned array may be a mutated version of the original array.

Pre-release

snoc :: MonadIO m => MutArray a -> a -> m (MutArray a)

The array is mutated to append an additional element to it. If there is no reserved space available in the array then it is reallocated to double the original size.

This is useful to reduce allocations when appending unknown number of elements.

Note that the returned array may be a mutated version of the original array.

>>> snoc = MutArray.snocWith (* 2)

Performs O(n * log n) copies to grow, but is liberal with memory allocation.

Pre-release

snocUnsafe :: MonadIO m => MutArray a -> a -> m (MutArray a)

Really really unsafe, appends the element into the first array, may cause silent data corruption or if you are lucky a segfault if the index is out of bounds.

Internal

Appending streams

Truncation

Eliminating and Reading

Unfolds

reader :: MonadIO m => Unfold m (MutArray a) a

Unfold an array into a stream.

producerWith :: Monad m => (forall b. IO b -> m b) -> Producer m (MutArray a) a

Resumable unfold of an array.

producer :: MonadIO m => Producer m (MutArray a) a

Resumable unfold of an array.

To containers

toStreamD :: MonadIO m => MutArray a -> Stream m a

Use the read unfold instead.

toStreamD = D.unfold read

We can try this if the unfold has any performance issues.

readRev :: MonadIO m => MutArray a -> Stream m a

toStreamK :: MonadIO m => MutArray a -> StreamK m a

toList :: MonadIO m => MutArray a -> m [a]

Convert an Array into a list.

Pre-release

Random reads

getIndex :: MonadIO m => Int -> MutArray a -> m a

O(1) Lookup the element at the given index. Index starts from 0.

getIndexUnsafe :: MonadIO m => Int -> MutArray a -> m a

Return the element at the specified index without checking the bounds.

Unsafe because it does not check the bounds of the array.

Size

length :: MutArray a -> Int

In-place Mutation Algorithms

strip :: MonadIO m => (a -> Bool) -> MutArray a -> m (MutArray a)

Folding

cmp :: (MonadIO m, Ord a) => MutArray a -> MutArray a -> m Ordering

Compare the length of the arrays. If the length is equal, compare the lexicographical ordering of two underlying byte arrays otherwise return the result of length comparison.

Pre-release

eq :: (MonadIO m, Eq a) => MutArray a -> MutArray a -> m Bool

Arrays of arrays

Operations dealing with multiple arrays, streams of arrays or multidimensional array representations.

Construct from streams

Eliminate to streams

Construct from arrays

getSliceUnsafe

Arguments

:: Int

from index

-> Int

length of the slice

-> MutArray a

-> MutArray a

O(1) Slice an array in constant time.

Unsafe: The bounds of the slice are not checked.

Unsafe

Pre-release

getSlice

Arguments

:: Int

from index

-> Int

length of the slice

-> MutArray a

-> MutArray a

O(1) Slice an array in constant time. Throws an error if the slice extends out of the array bounds.

Pre-release

Appending arrays

putSliceUnsafe :: MonadIO m => MutArray a -> Int -> MutArray a -> Int -> Int -> m ()

Put a sub range of a source array into a subrange of a destination array. This is not safe as it does not check the bounds.

clone :: MonadIO m => MutArray a -> m (MutArray a)