diff options
author | simonmar <unknown> | 2002-05-28 15:04:54 +0000 |
---|---|---|
committer | simonmar <unknown> | 2002-05-28 15:04:54 +0000 |
commit | d9e75d6a49df30c8e5b92efa119d36fcc8b80349 (patch) | |
tree | 34238f057e81bad41eb0ddede0c4ba61017655ca /libraries | |
parent | 47351d79057fe8535960f6c008ae2c5bd17e72d7 (diff) | |
download | haskell-d9e75d6a49df30c8e5b92efa119d36fcc8b80349.tar.gz |
[project @ 2002-05-28 15:04:54 by simonmar]
Documentation
Diffstat (limited to 'libraries')
-rw-r--r-- | libraries/base/Data/Array/IArray.hs | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/libraries/base/Data/Array/IArray.hs b/libraries/base/Data/Array/IArray.hs index 3f1706ce10..ec42d7d994 100644 --- a/libraries/base/Data/Array/IArray.hs +++ b/libraries/base/Data/Array/IArray.hs @@ -8,31 +8,44 @@ -- Stability : experimental -- Portability : non-portable -- --- Overloaded immutable array class. +-- Immutable arrays, with an overloaded interface. For array types +-- which can be used with this interface, see "Data.Array", +-- "Data.Array.Unboxed", and "Data.Array.Diff". -- ----------------------------------------------------------------------------- module Data.Array.IArray ( - module Data.Ix, - - -- Class of immutable array types + -- * Class of immutable array types IArray, -- :: (* -> * -> *) -> * -> class - -- Class of array types with immutable bounds + + -- * Class of array types with immutable bounds HasBounds, -- :: (* -> * -> *) -> class + -- * The @Ix@ class and operations + module Data.Ix, + + -- * Array construction array, -- :: (IArray a e, Ix i) => (i,i) -> [(i, e)] -> a i e listArray, -- :: (IArray a e, Ix i) => (i,i) -> [e] -> a i e + accumArray, -- :: (IArray a e, Ix i) => (e -> e' -> e) -> e -> (i,i) -> [(i, e')] -> a i e + + -- * Indexing arrays (!), -- :: (IArray a e, Ix i) => a i e -> i -> e + + -- * Incremental updates + (//), -- :: (IArray a e, Ix i) => a i e -> [(i, e)] -> a i e + accum, -- :: (IArray a e, Ix i) => (e -> e' -> e) -> a i e -> [(i, e')] -> a i e + + -- * Derived Arrays + amap, -- :: (IArray a e', IArray a e, Ix i) => (e' -> e) -> a i e' -> a i e + ixmap, -- :: (IArray a e, Ix i, Ix j) => (i,i) -> (i -> j) -> a j e -> a i e + + -- * Deconstructing arrays bounds, -- :: (HasBounds a, Ix i) => a i e -> (i,i) indices, -- :: (HasBounds a, Ix i) => a i e -> [i] elems, -- :: (IArray a e, Ix i) => a i e -> [e] assocs, -- :: (IArray a e, Ix i) => a i e -> [(i, e)] - accumArray, -- :: (IArray a e, Ix i) => (e -> e' -> e) -> e -> (i,i) -> [(i, e')] -> a i e - (//), -- :: (IArray a e, Ix i) => a i e -> [(i, e)] -> a i e - accum, -- :: (IArray a e, Ix i) => (e -> e' -> e) -> a i e -> [(i, e')] -> a i e - amap, -- :: (IArray a e', IArray a e, Ix i) => (e' -> e) -> a i e' -> a i e - ixmap) -- :: (IArray a e, Ix i, Ix j) => (i,i) -> (i -> j) -> a j e -> a i e - where + ) where import Prelude |