Specify how an array can be loaded/computed through creation of a DL array. Unlike makeLoadArrayS or makeLoadArray this function is unsafe, since there is no guarantee that all elements will be initialized and the supplied element writing function does not perform any bounds checking.

Since: 0.3.1

Same as unsafeMakeLoadArray, except will ensure that starting index is correctly adjusted. Which means the writing function gets one less argument.

Since: 0.5.2

Sz provides type safety guarantees preventing mixup with index, which is used for looking into array cells, from the size, that describes total number of elements along each dimension in the array. Moreover the Sz constructor will prevent creation of invalid sizes with negative numbers.

Since: 0.3.0

Stride provides a way to ignore elements of an array if an index is divisible by a corresponding value in a stride. So, for a Stride (i :. j) only elements with indices will be kept around:

( 0 :. 0) ( 0 :. j) ( 0 :. 2j) ( 0 :. 3j) ...
( i :. 0) ( i :. j) ( i :. 2j) ( i :. 3j) ...
(2i :. 0) (2i :. j) (2i :. 2j) (2i :. 3j) ...
...

Only positive strides make sense, so Stride pattern synonym constructor will prevent a user from creating a stride with negative or zero values, thus promoting safety of the library.

Examples:

Since: 0.2.1

Lookup element in the array. No bounds check is performed and access of arbitrary memory is possible when invalid index is supplied.

Since: 0.1.0

Lookup element in the array using flat index in a row-major fashion. No bounds check is performed

Since: 0.1.0

O(1) - Change the size of an array. Total number of elements should be the same, but it is not validated.

O(1) - Extract a portion of an array. Staring index and new size are not validated.

Same transform', except no bounds checking is performed, thus making it faster, but unsafe.

Since: 0.3.0

Same transform2', except no bounds checking is performed, thus making it faster, but unsafe.

Since: 0.3.0

O(1) - Take a slice out of an array from the outside

O(1) - Source arrays also give us ability to look at their linear slices in constant time

Since: 0.5.0

Convert immutable array into a mutable array without copy.

Since: 0.1.0

Convert mutable array into an immutable array without copy.

Since: 0.1.0

Create new mutable array, leaving it's elements uninitialized. Size isn't validated either.

Since: 0.1.0

Same as createArray, but memory will not be initialized and for unboxed types might contain garbage.

Since: 0.5.0

Same as createArray_, but memory will not be initialized and for unboxed types might contain garbage.

Since: 0.5.0

Same as createArrayS, but memory will not be initialized and for unboxed types might contain garbage.

Since: 0.5.0

Read an array element

Since: 0.1.0

Read an element at linear row-major index

Since: 0.1.0

Write an element into array

Since: 0.1.0

Write an element into mutable array with linear row-major index

Since: 0.1.0

Modify an element in the array with a monadic action. Returns the previous value.

Since: 0.4.0

Modify an element in the array with a monadic action. Returns the previous value.

Since: 0.4.0

Swap two elements in a mutable array under the supplied indices. Returns the previous values.

Since: 0.4.0

Swap two elements in a mutable array under the supplied linear indices. Returns the previous values.

Since: 0.4.0

Set all cells in the mutable array within the range to a specified value.

Since: 0.3.0

Copy part of one mutable array into another

Since: 0.3.6

Copy a part of a pure array into a mutable array

Since: 0.3.6

Linearly reduce the size of an array. Total number of elements should be smaller or equal. There is no guarantee that the original array is left unchanged, so it should no longer be used.

Since: 0.3.6

Linearly increase the size of an array. Total number of elements should be larger or equal. There is no guarantee that the original array is left unchanged, so it should no longer be used.

Since: 0.3.6

A pointer to the beginning of the storable array. It is unsafe since, if mutated, it can break referential transparency.

Since: 0.1.3

O(1) - Yield the underlying ForeignPtr together with its length.

Since: 0.3.0

O(1) - Yield the underlying ForeignPtr together with its length.

Since: 0.3.0

O(1) - Wrap a ForeignPtr, an offset and it's size into a pure storable array.

Since: 0.3.0

O(1) - Wrap a ForeignPtr and it's size into a pure storable array.

Since: 0.3.0

O(1) - Wrap a ForeignPtr, an offset and it's size into a mutable storable array. It is still safe to modify the pointer, unless the array gets frozen prior to modification.

Since: 0.3.0

O(1) - Wrap a ForeignPtr and it's size into a mutable storable array. It is still safe to modify the pointer, unless the array gets frozen prior to modification.

Since: 0.3.0

Atomically read an Int element from the array

Since: 0.3.0

Atomically write an Int element int the array

Since: 0.3.0

Atomically modify an Int element of the array. Returns the old value.

Since: 0.3.0

Atomically add to an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically subtract from an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically AND an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically NAND an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically OR an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically XOR an Int element in the array. Returns the old value.

Since: 0.3.0

Atomically CAS an Int in the array. Returns the old value.

Since: 0.3.0

O(n) - Cast a boxed array. It is unsafe because it violates the invariant that all elements of N array are in NF.

Since: 0.5.0

O(n) - Cast a boxed array. It is unsafe because it violates the invariant that all elements of N array are in NF.

Since: 0.5.0

O(n) - Cast a boxed vector without touching any elements. It is unsafe because it violates the invariant that all elements of B array are in WHNF.

Since: 0.5.0

Partition a segment of a vector. Starting and ending indices are unchecked.

Since: 0.3.2

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

Since: 0.5.0

O(n) - Right unfolding function with at most n number of elements.

Unsafe - This function is unsafe because it will allocate enough space in memory for n elements ahead of time, regardless of when unfolding function returns a Nothing. Supplying n that is too big will result in an asynchronous HeapOverflow exception.

Since: 0.5.1

O(n) - Same as unsafeUnfoldrN, but with monadic generating function.

Unsafe - This function is unsafe because it will allocate enough space in memory for n elements ahead of time, regardless of when unfolding function returns a Nothing. Supplying n that is too big will result in an asynchronous HeapOverflow exception.

Since: 0.5.1

O(n) - Convert a list of a known length to a delayed stream vector.

Unsafe - This function is unsafe because it will allocate enough space in memory for n elements ahead of time, regardless of the actual size of the list. Supplying n that is too big will result in an asynchronous HeapOverflow exception.

Since: 0.5.1

Similar to makeStencil, but there are no guarantees that the stencil will not read out of bounds memory. This stencil is also a bit more powerful in sense it gets an extra peice of information, namely the exact index for the element it is constructing.

Since: 0.3.0

This is an unsafe version of mapStencil, that does no take Stencil as argument, as such it does no stencil validation. There is no performance difference between the two, but the unsafe version has an advantage of not requiring to deal with Value wrapper and has access to the actual index with the array.

Since: 0.5.0

Just as mapStencilUnsafe this is an unsafe version of the stencil mapping. Arguments are in slightly different order and the indexing function returns Nothing for elements outside the border.

Since: 0.1.7