Data/Array/IArray.hs

   1 -----------------------------------------------------------------------------
   2 -- |
   3 -- Module      :  Data.Array.IArray
   4 -- Copyright   :  (c) The University of Glasgow 2001
   5 -- License     :  BSD-style (see the file libraries/base/LICENSE)
   6 --
   7 -- Maintainer  :  libraries@haskell.org
   8 -- Stability   :  experimental
   9 -- Portability :  non-portable
  10 --
  11 -- Immutable arrays, with an overloaded interface.  For array types
  12 -- which can be used with this interface, see "Data.Array",
  13 -- "Data.Array.Unboxed", and "Data.Array.Diff".
  14 --
  15 -----------------------------------------------------------------------------
  16
  17 module Data.Array.IArray (
  18     -- * Class of immutable array types
  19     IArray,     -- :: (* -> * -> *) -> * -> class
  20
  21     -- * Class of array types with immutable bounds
  22     HasBounds,  -- :: (* -> * -> *) -> class
  23
  24     -- * The @Ix@ class and operations
  25     module Data.Ix,
  26
  27     -- * Array construction
  28     array,      -- :: (IArray a e, Ix i) => (i,i) -> [(i, e)] -> a i e
  29     listArray,  -- :: (IArray a e, Ix i) => (i,i) -> [e] -> a i e
  30     accumArray, -- :: (IArray a e, Ix i) => (e -> e' -> e) -> e -> (i,i) -> [(i, e')] -> a i e
  31
  32     -- * Indexing arrays
  33     (!),        -- :: (IArray a e, Ix i) => a i e -> i -> e
  34
  35     -- * Incremental updates
  36     (//),       -- :: (IArray a e, Ix i) => a i e -> [(i, e)] -> a i e
  37     accum,      -- :: (IArray a e, Ix i) => (e -> e' -> e) -> a i e -> [(i, e')] -> a i e
  38
  39     -- * Derived Arrays
  40     amap,       -- :: (IArray a e', IArray a e, Ix i) => (e' -> e) -> a i e' -> a i e
  41     ixmap,      -- :: (IArray a e, Ix i, Ix j) => (i,i) -> (i -> j) -> a j e -> a i e
  42
  43     -- * Deconstructing arrays
  44     bounds,     -- :: (HasBounds a, Ix i) => a i e -> (i,i)
  45     indices,    -- :: (HasBounds a, Ix i) => a i e -> [i]
  46     elems,      -- :: (IArray a e, Ix i) => a i e -> [e]
  47     assocs,     -- :: (IArray a e, Ix i) => a i e -> [(i, e)]
  48  )  where
  49
  50 import Prelude
  51
  52 import Data.Ix
  53 #ifdef __HUGS__
  54 import Hugs.Array.Base
  55 #else
  56 import Data.Array.Base
  57 #endif