[project @ 2002-05-28 16:33:46 by simonmar]

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

diff --git a/Data/Array/ST.hs b/Data/Array/ST.hs
index e2b8465..6c4b416 100644 (file)
--- a/Data/Array/ST.hs
+++ b/Data/Array/ST.hs
@@ -8,26 +8,35 @@
 -- Stability   :  experimental
 -- Portability :  non-portable
 --
--- Mutable boxed and unboxed arrays in the ST monad.
+-- Mutable boxed and unboxed arrays in the 'ST' monad.
 --
 -----------------------------------------------------------------------------
 
 module Data.Array.ST (
-   module Data.Array.MArray,
+
+   -- * Boxed arrays
    STArray,            -- instance of: Eq, MArray
+
+   -- * Unboxed arrays
    STUArray,           -- instance of: Eq, MArray
    castSTUArray,       -- :: STUArray s i a -> ST s (STUArray s i b)
+
+   -- * Overloaded mutable array interface
+   module Data.Array.MArray,
  ) where
 
 import Prelude
 
 import Data.Array.MArray
-import Data.Array.Base
+import Data.Array.Base hiding (MArray(..))
 
 #ifdef __GLASGOW_HASKELL__
 import GHC.Arr
 import GHC.ST
 
+-- | Casts an 'STUArray' with one element type into one with a
+-- different element type.  All the elements of the resulting array
+-- are undefined (unless you know what you\'re doing...).
 castSTUArray :: STUArray s ix a -> ST s (STUArray s ix b)
 castSTUArray (STUArray l u marr#) = return (STUArray l u marr#)
 #endif