A static array is an array with a fixed length.

singleElement : StaticArray One Int
singleElement =
    singleton 42






twoElements : StaticArray Two Int
twoElements =
    singleElement
        |> push 7

Constructs an array with a single item.

Constructs an array from a list

import Array
import StaticArray.Length as Length


fromList Length.five 0 []
    |> toArray
    |> Array.toList
    --> [0,0,0,0,0]

Adds a element to the end of the array.

Gets an element of the array. Note that it only possible if the index is in bound. Therefore eliminating Off-by-one errors.

Sets an element of the array.

Returns the length of an array.

Changes the size of the array. If the array gets bigger, then the first element of the array gets used as default value.

import StaticArray.Length as Length
import Array


singleton 42
    |> push 7
    |> resize (Length.one |> Length.plus4)
    |> toArray
    |> Array.toList --> [42,7,42,42,42]

Transforms the static array into a dynamic array.

Updates all elements of an array.

Same as map but with an index.

Exposes the underlying record of the array

import StaticArray.Length as Length
import StaticArray.Index exposing (Five,OnePlus)


array : StaticArray (OnePlus Five) Int
array =
    fromList (Length.five |> Length.plus1 ) 0
        [1,2,3,4,5]


array |> toRecord |> fromRecord --> array

Constructs a static array from its components. If the Length is bigger then the number of elements provided, the additional element will be filled with duplicates of head.

import StaticArray.Length as Length
import Array


fromRecord
{ length = (Length.five |> Length.plus1 )
, head = 0
, tail = Array.fromList [1,2,3,4,5]
}
--> fromList (Length.five |> Length.plus1 ) 0 [1,2,3,4,5]