| ||||||||||||||||||||||||||||||||||||||||

| ||||||||||||||||||||||||||||||||||||||||

| ||||||||||||||||||||||||||||||||||||||||

Description | ||||||||||||||||||||||||||||||||||||||||

An overloaded interface to mutable arrays. For array types which can be used with this interface, see Data.Array.IO, Data.Array.ST, and Data.Array.Storable. | ||||||||||||||||||||||||||||||||||||||||

Synopsis | ||||||||||||||||||||||||||||||||||||||||

| ||||||||||||||||||||||||||||||||||||||||

Class of mutable array types | ||||||||||||||||||||||||||||||||||||||||

class (HasBounds a, Monad m) => MArray a e m where | ||||||||||||||||||||||||||||||||||||||||

| ||||||||||||||||||||||||||||||||||||||||

Class of array types with bounds | ||||||||||||||||||||||||||||||||||||||||

class HasBounds a where | ||||||||||||||||||||||||||||||||||||||||

| ||||||||||||||||||||||||||||||||||||||||

The Ix class and operations
| ||||||||||||||||||||||||||||||||||||||||

module Data.Ix | ||||||||||||||||||||||||||||||||||||||||

Constructing mutable arrays | ||||||||||||||||||||||||||||||||||||||||

newArray :: (MArray a e m, Ix i) => (i, i) -> e -> m (a i e) | ||||||||||||||||||||||||||||||||||||||||

Builds a new array, with every element initialised to the supplied value. | ||||||||||||||||||||||||||||||||||||||||

newArray_ :: (MArray a e m, Ix i) => (i, i) -> m (a i e) | ||||||||||||||||||||||||||||||||||||||||

Builds a new array, with every element initialised to undefined. | ||||||||||||||||||||||||||||||||||||||||

newListArray :: (MArray a e m, Ix i) => (i, i) -> [e] -> m (a i e) | ||||||||||||||||||||||||||||||||||||||||

Constructs a mutable array from a list of initial elements. The list gives the elements of the array in ascending order beginning with the lowest index. | ||||||||||||||||||||||||||||||||||||||||

Reading and writing mutable arrays | ||||||||||||||||||||||||||||||||||||||||

readArray :: (MArray a e m, Ix i) => a i e -> i -> m e | ||||||||||||||||||||||||||||||||||||||||

Read an element from a mutable array | ||||||||||||||||||||||||||||||||||||||||

writeArray :: (MArray a e m, Ix i) => a i e -> i -> e -> m () | ||||||||||||||||||||||||||||||||||||||||

Write an element in a mutable array | ||||||||||||||||||||||||||||||||||||||||

Derived arrays | ||||||||||||||||||||||||||||||||||||||||

mapArray :: (MArray a e' m, MArray a e m, Ix i) => (e' -> e) -> a i e' -> m (a i e) | ||||||||||||||||||||||||||||||||||||||||

Constructs a new array derived from the original array by applying a function to each of the elements. | ||||||||||||||||||||||||||||||||||||||||

mapIndices :: (MArray a e m, Ix i, Ix j) => (i, i) -> (i -> j) -> a j e -> m (a i e) | ||||||||||||||||||||||||||||||||||||||||

Constructs a new array derived from the original array by applying a function to each of the indices. | ||||||||||||||||||||||||||||||||||||||||

Deconstructing mutable arrays | ||||||||||||||||||||||||||||||||||||||||

bounds :: (HasBounds a, Ix i) => a i e -> (i, i) | ||||||||||||||||||||||||||||||||||||||||

Extracts the bounds of an array | ||||||||||||||||||||||||||||||||||||||||

indices :: (HasBounds a, Ix i) => a i e -> [i] | ||||||||||||||||||||||||||||||||||||||||

Returns a list of all the valid indices in an array. | ||||||||||||||||||||||||||||||||||||||||

getElems :: (MArray a e m, Ix i) => a i e -> m [e] | ||||||||||||||||||||||||||||||||||||||||

Return a list of all the elements of a mutable array | ||||||||||||||||||||||||||||||||||||||||

getAssocs :: (MArray a e m, Ix i) => a i e -> m [(i, e)] | ||||||||||||||||||||||||||||||||||||||||

Return a list of all the associations of a mutable array, in index order. | ||||||||||||||||||||||||||||||||||||||||

Conversions between mutable and immutable arrays | ||||||||||||||||||||||||||||||||||||||||

freeze :: (Ix i, MArray a e m, IArray b e) => a i e -> m (b i e) | ||||||||||||||||||||||||||||||||||||||||

Converts a mutable array (any instance of MArray) to an
immutable array (any instance of IArray) by taking a complete
copy of it.
| ||||||||||||||||||||||||||||||||||||||||

unsafeFreeze :: (Ix i, MArray a e m, IArray b e) => a i e -> m (b i e) | ||||||||||||||||||||||||||||||||||||||||

Converts an mutable array into an immutable array. The implementation may either simply cast the array from one type to the other without copying the array, or it may take a full copy of the array. Note that because the array is possibly not copied, any subsequent modifications made to the mutable version of the array may be shared with the immutable version. It is safe to use, therefore, if the mutable version is never modified after the freeze operation. The non-copying implementation is supported between certain pairs
of array types only; one constraint is that the array types must
have identical representations. In GHC, The following pairs of
array types have a non-copying O(1) implementation of
| ||||||||||||||||||||||||||||||||||||||||

thaw :: (Ix i, IArray a e, MArray b e m) => a i e -> m (b i e) | ||||||||||||||||||||||||||||||||||||||||

Converts an immutable array (any instance of IArray) into a
mutable array (any instance of MArray) by taking a complete copy
of it.
| ||||||||||||||||||||||||||||||||||||||||

unsafeThaw :: (Ix i, IArray a e, MArray b e m) => a i e -> m (b i e) | ||||||||||||||||||||||||||||||||||||||||

Converts an immutable array into a mutable array. The implementation may either simply cast the array from one type to the other without copying the array, or it may take a full copy of the array. Note that because the array is possibly not copied, any subsequent modifications made to the mutable version of the array may be shared with the immutable version. It is safe to use, therefore, if the immutable version is never referenced again. The non-copying implementation is supported between certain pairs
of array types only; one constraint is that the array types must
have identical representations. In GHC, The following pairs of
array types have a non-copying O(1) implementation of
| ||||||||||||||||||||||||||||||||||||||||

Produced by Haddock version 0.7 |