Data/Array/MArray.hs

   1 {-# OPTIONS -monly-3-regs #-}
   2 -----------------------------------------------------------------------------
   3 -- |
   4 -- Module      :  Data.Array.MArray
   5 -- Copyright   :  (c) The University of Glasgow 2001
   6 -- License     :  BSD-style (see the file libraries/base/LICENSE)
   7 --
   8 -- Maintainer  :  libraries@haskell.org
   9 -- Stability   :  experimental
  10 -- Portability :  non-portable
  11 --
  12 -- An overloaded interface to mutable arrays.  For array types which can be
  13 -- used with this interface, see "Data.Array.IO", "Data.Array.ST",
  14 -- and "Data.Array.Storable".
  15 --
  16 -----------------------------------------------------------------------------
  17
  18 module Data.Array.MArray (
  19     -- * Class of mutable array types
  20     MArray,       -- :: (* -> * -> *) -> * -> (* -> *) -> class
  21
  22     -- * Class of array types with bounds
  23     HasBounds,    -- :: (* -> * -> *) -> class
  24
  25     -- * The @Ix@ class and operations
  26     module Data.Ix,
  27
  28     -- * Constructing mutable arrays
  29     newArray,     -- :: (MArray a e m, Ix i) => (i,i) -> e -> m (a i e)
  30     newArray_,    -- :: (MArray a e m, Ix i) => (i,i) -> m (a i e)
  31     newListArray, -- :: (MArray a e m, Ix i) => (i,i) -> [e] -> m (a i e)
  32
  33     -- * Reading and writing mutable arrays
  34     readArray,    -- :: (MArray a e m, Ix i) => a i e -> i -> m e
  35     writeArray,   -- :: (MArray a e m, Ix i) => a i e -> i -> e -> m ()
  36
  37     -- * Derived arrays
  38     mapArray,     -- :: (MArray a e' m, MArray a e m, Ix i) => (e' -> e) -> a i e' -> m (a i e)
  39     mapIndices,   -- :: (MArray a e m, Ix i, Ix j) => (i,i) -> (i -> j) -> a j e -> m (a i e)
  40
  41     -- * Deconstructing mutable arrays
  42     bounds,       -- :: (HasBounds a, Ix i) => a i e -> (i,i)
  43     indices,      -- :: (HasBounds a, Ix i) => a i e -> [i]
  44     getElems,     -- :: (MArray a e m, Ix i) => a i e -> m [e]
  45     getAssocs,    -- :: (MArray a e m, Ix i) => a i e -> m [(i, e)]
  46
  47     -- * Conversions between mutable and immutable arrays
  48     freeze,       -- :: (Ix i, MArray a e m, IArray b e) => a i e -> m (b i e)
  49     unsafeFreeze, -- :: (Ix i, MArray a e m, IArray b e) => a i e -> m (b i e)
  50     thaw,         -- :: (Ix i, IArray a e, MArray b e m) => a i e -> m (b i e)
  51     unsafeThaw,   -- :: (Ix i, IArray a e, MArray b e m) => a i e -> m (b i e)
  52   ) where
  53
  54 import Prelude
  55
  56 import Data.Ix
  57 import Data.Array.Base