Data.SmallArray

Packed, unboxed, heap-resident arrays. Suitable for performance critical use, both in terms of large data quantities and high speed.

This module is intended to be imported qualified, to avoid name clashes with Prelude functions, e.g.

 import qualified Data.SmallArray as A

The names in this module resemble those in the Data.Array family of modules, but are shorter due to the assumption of qualifid naming.

Array types

data Array a

A simple array. Indexing starts from zero.

Instances

(Eq a, Elt a) => Eq (Array a)

(Ord a, Elt a) => Ord (Array a)

(Show e, Elt e) => Show (Array e)

NFData (Array a)

Hashable (Array a)

Elt a => IArray (Array a)

data MArray s a

A simple mutable array. Indexing starts from zero.

Instances

NFData (MArray s a)

Elt a => IArray (MArray s a)

class IArray a where

Methods

length :: a -> Int

Return the length of an array.

Instances

Elt a => IArray (Array a)

Elt a => IArray (MArray s a)

class Elt e where

Methods

index :: Array e -> Int -> e

Retrieve an element in an array at the specified location. Array indices start at zero.

read :: MArray s e -> Int -> ST s e

Retrieve an element from a mutable array at the specified location. Array indices start at zero.

write :: MArray s e -> Int -> e -> ST s ()

Write an element to a mutable array at the specified location. Array indices start at zero.

Instances

Elt Char

Elt Double

Elt Float

Elt Int

Elt Int8

Elt Int16

Elt Int32

Elt Int64

Elt Word

Elt Word8

Elt Word16

Elt Word32

Elt Word64

Creation

empty :: Elt e => Array e

The empty array

new :: Elt e => Int -> e -> ST s (MArray s e)

Create a new array with the specified default value.

run :: (forall s. ST s (MArray s e)) -> Array e

Execute an action creating a mutable array, and return the resulting equivalent pure array. No copy is performed.

run' :: (forall s. ST s (MArray s e, a)) -> (Array e, a)

fromList :: Elt e => [e] -> Array e

Create an array from a list.

copy

Arguments

:: Elt e

=> MArray s e

source array

-> MArray s e

destination array

-> ST s ()

Copy an array in its entirety. The destination array must be at least as big as the source.

Unpacking

toList :: Elt e => Array e -> [e]

Output the array to a list.