--
-- Maintainer : libraries@haskell.org
-- Stability : experimental
--- Portability : non-portable
+-- Portability : non-portable (uses Data.Array.Base)
--
--- 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".
+-- 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 (
- -- * Class of immutable array types
+ -- * Array classes
IArray, -- :: (* -> * -> *) -> * -> class
- -- * Class of array types with immutable bounds
- HasBounds, -- :: (* -> * -> *) -> class
+ module Data.Ix,
- -- * Ordinary boxed/lazy arrays
+ -- * Immutable non-strict (boxed) arrays
Array,
- -- * 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
+ -- * 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)]
- -- * Incremental updates
+ -- * 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
+ -- * 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)]
) where
import Prelude
import Data.Ix
import Data.Array (Array)
-#ifdef __HUGS__
-import Hugs.Array.Base
-#else
import Data.Array.Base
-#endif