Data.Text.Array

Contents

Description

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.Text.Array as A

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

Synopsis

Types

Immutable array type.

Constructors

Array
Fields aBA :: ByteArray#

data MArray s

Mutable array type, for use in the ST monad.

Constructors

MArray
Fields maBA :: MutableByteArray# s

Functions

Arguments

Copy some elements of a mutable array.

Arguments

:: MArray s	Destination
-> Int	Destination offset
-> Array	Source
-> Int	Source offset
-> Int	First offset in destination not to copy (i.e. not length)
-> ST s ()

Copy some elements of an immutable array.

An empty immutable array.

Arguments

Compare portions of two arrays for equality. No bounds checking is performed.

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

Run an action in the ST monad and return an immutable array of its result.

run2 :: (forall s. ST s (MArray s, a)) -> (Array, a)

Run an action in the ST monad and return an immutable array of its result paired with whatever else the action returns.

Convert an immutable array to a list.

Freeze a mutable array. Do not mutate the MArray afterwards!

Unchecked read of an immutable array. May return garbage or crash on an out-of-bounds access.

new :: forall s. Int -> ST s (MArray s)

Create an uninitialized mutable array.

Unchecked write of a mutable array. May return garbage or crash on an out-of-bounds access.