Data.Array.Mutable.Linear

This module provides a pure linear interface for arrays with in-place mutation.

To use these mutable arrays, create a linear computation of type Array a %1-> Ur b and feed it to alloc or fromList.

A Tiny Example

>>> :set -XLinearTypes
>>> :set -XNoImplicitPrelude
>>> import Prelude.Linear
>>> import qualified Data.Array.Mutable.Linear as Array
>>> :{
 isFirstZero :: Array.Array Int %1-> Ur Bool
 isFirstZero arr =
   Array.get 0 arr
     & \(Ur val, arr') -> arr' `lseq` Ur (val == 0)
:}

>>> unur $ Array.fromList [0..10] isFirstZero
True
>>> unur $ Array.fromList [1,2,3] isFirstZero
False

Mutable Linear Arrays

data Array a

Instances

Functor Array

Defined in Data.Array.Mutable.Linear

Methods

fmap :: (a %1 -> b) -> Array a %1 -> Array b

Consumable (Array a)

Defined in Data.Array.Mutable.Linear

Methods

consume :: Array a %1 -> ()

Dupable (Array a)

Defined in Data.Array.Mutable.Linear

Methods

dupV :: forall (n :: Nat). KnownNat n => Array a %1 -> V n (Array a)

dup2 :: Array a %1 -> (Array a, Array a)

Performing Computations with Arrays

alloc :: HasCallStack => Int -> a -> (Array a %1 -> Ur b) %1 -> Ur b

Allocate a constant array given a size and an initial value The size must be non-negative, otherwise this errors.

allocBeside :: Int -> a -> Array b %1 -> (Array a, Array b)

Allocate a constant array given a size and an initial value, using another array as a uniqueness proof.

fromList :: HasCallStack => [a] -> (Array a %1 -> Ur b) %1 -> Ur b

Allocate an array from a list

Modifications

set :: HasCallStack => Int -> a -> Array a %1 -> Array a

Sets the value of an index. The index should be less than the arrays size, otherwise this errors.

unsafeSet :: Int -> a -> Array a %1 -> Array a

Same as 'set, but does not do bounds-checking. The behaviour is undefined if an out-of-bounds index is provided.

resize :: HasCallStack => Int -> a -> Array a %1 -> Array a

Resize an array. That is, given an array, a target size, and a seed value; resize the array to the given size using the seed value to fill in the new cells when necessary and copying over all the unchanged cells.

Target size should be non-negative.

let b = resize n x a,
  then size b = n,
  and b[i] = a[i] for i < size a,
  and b[i] = x for size a <= i < n.

map :: (a -> b) -> Array a %1 -> Array b

Accessors

get :: HasCallStack => Int -> Array a %1 -> (Ur a, Array a)

Get the value of an index. The index should be less than the arrays size, otherwise this errors.

unsafeGet :: Int -> Array a %1 -> (Ur a, Array a)

Same as get, but does not do bounds-checking. The behaviour is undefined if an out-of-bounds index is provided.

size :: Array a %1 -> (Ur Int, Array a)

slice

Arguments

:: HasCallStack

=> Int

Start offset

-> Int

Target size

-> Array a

-> (Array a, Array a)

Copy a slice of the array, starting from given offset and copying given number of elements. Returns the pair (oldArray, slice).

Start offset + target size should be within the input array, and both should be non-negative.

let b = slice i n a,
  then size b = n,
  and b[j] = a[i+j] for 0 <= j < n

toList :: Array a %1 -> Ur [a]

Return the array elements as a lazy list.

freeze :: Array a %1 -> Ur (Vector a)

O(1) Convert an Array to an immutable Vector (from vector package).

Mutable-style interface

read :: HasCallStack => Array a %1 -> Int -> (Ur a, Array a)

Same as get, but takes the Array as the first parameter.

unsafeRead :: Array a %1 -> Int -> (Ur a, Array a)

Same as unsafeGet, but takes the Array as the first parameter.

write :: HasCallStack => Array a %1 -> Int -> a -> Array a

Same as set, but takes the Array as the first parameter.

unsafeWrite :: Array a %1 -> Int -> a -> Array a

Same as unsafeSafe, but takes the Array as the first parameter.