Data/Array/IArray.hs

{-# LANGUAGE Trustworthy #-}
-----------------------------------------------------------------------------
-- |
-- Module : Data.Array.IArray
-- Copyright : (c) The University of Glasgow 2001
-- License : BSD-style (see the file libraries/base/LICENSE)
--
-- Maintainer : libraries@haskell.org
-- Stability : experimental
-- Portability : non-portable (uses Data.Array.Base)
--
-- 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" module. Other packages, such as
-- diffarray, also provide arrays using this interface.
--
-----------------------------------------------------------------------------

module Data.Array.IArray (
 -- * Array classes
 IArray, -- :: (* -> * -> *) -> * -> class

 module Data.Ix,

 -- * 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)]

 -- * 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

import Data.Ix
import Data.Array (Array)
import Data.Array.Base