[project @ 2005-01-19 22:33:32 by ralf]

[ghc-base.git] / Data / Array / IArray.hs

diff --git a/Data/Array/IArray.hs b/Data/Array/IArray.hs
index 3f1706c..60d8097 100644 (file)
--- a/Data/Array/IArray.hs
+++ b/Data/Array/IArray.hs
@@ -8,33 +8,45 @@
 -- 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 the 'Array' type exported by this
+-- module, and the "Data.Array.Unboxed" and "Data.Array.Diff" modules.
 --
 -----------------------------------------------------------------------------
 
 module Data.Array.IArray ( 
+    -- * Array classes
+    HasBounds,  -- :: (* -> * -> *) -> class
+    IArray,     -- :: (* -> * -> *) -> * -> class
+
     module Data.Ix,
 
-    -- Class of immutable array types
-    IArray,     -- :: (* -> * -> *) -> * -> class
-    -- Class of array types with immutable bounds
-    HasBounds,  -- :: (* -> * -> *) -> class
+    -- * Immutable non-strict (boxed) arrays
+    Array,    
 
+    -- * 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
+
+    -- * Accessing arrays
     (!),        -- :: (IArray a e, Ix i) => a i e -> i -> e
     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
+
+    -- * Incremental array 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
-    where
+    ixmap,      -- :: (IArray a e, Ix i, Ix j) => (i,i) -> (i -> j) -> a j e -> a i e
+ )  where
 
 import Prelude
 
 import Data.Ix
+import Data.Array (Array)
 import Data.Array.Base