Basement.UArray.Mutable

A Mutable array of types built on top of GHC primitive.

Element in this array can be modified in place.

return the numbers of elements in a mutable array

Create a new mutable array of size @n.

When memory for a new array is allocated, we decide if that memory region should be pinned (will not be copied around by GC) or unpinned (can be moved around by GC) depending on its size.

You can change the threshold value used by setting the environment variable HS_FOUNDATION_UARRAY_UNPINNED_MAX.

Create a new pinned mutable array of size @n.

all the cells are uninitialized and could contains invalid values.

All mutable arrays are allocated on a 64 bits aligned addresses

Same as newNative but expect no extra return value from f

Copy a number of elements from an array to another array with offsets

Copy from a pointer, count elements, into the mutable array

Copy all the block content to the memory starting at the destination address

write to a cell in a mutable array without bounds checking.

Writing with invalid bounds will corrupt memory and your program will become unreliable. use write if unsure.

read from a cell in a mutable array without bounds checking.

Reading from invalid memory can return unpredictable and invalid values. use read if unsure.

Write to a cell in a mutable array.

If the index is out of bounds, an error is raised.

read a cell in a mutable array.

If the index is out of bounds, an error is raised.

Create a pointer on the beginning of the mutable array and call a function f.

The mutable buffer can be mutated by the f function and the change will be reflected in the mutable array

If the mutable array is unpinned, a trampoline buffer is created and the data is only copied when f return.