1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
-----------------------------------------------------------------------------
-- |
-- Module : Data.Array.ST
-- 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.MArray)
--
-- Mutable boxed and unboxed arrays in the 'Control.Monad.ST.ST' monad.
--
-----------------------------------------------------------------------------
module Data.Array.ST (
-- * Boxed arrays
STArray, -- instance of: Eq, MArray
runSTArray,
-- * Unboxed arrays
STUArray, -- instance of: Eq, MArray
runSTUArray,
castSTUArray, -- :: STUArray s i a -> ST s (STUArray s i b)
-- * Overloaded mutable array interface
module Data.Array.MArray,
) where
import Data.Array.Base ( STUArray, UArray, unsafeFreezeSTUArray )
import Data.Array.MArray
import qualified Data.Array.Unsafe as U ( castSTUArray )
import Control.Monad.ST ( ST, runST )
#ifdef __HUGS__
import Hugs.Array ( Array )
import Hugs.ST ( STArray, unsafeFreezeSTArray )
#endif
#ifdef __GLASGOW_HASKELL__
import GHC.Arr ( STArray, Array, unsafeFreezeSTArray )
#endif
-- | A safe way to create and work with a mutable array before returning an
-- immutable array for later perusal. This function avoids copying
-- the array before returning it - it uses 'unsafeFreeze' internally, but
-- this wrapper is a safe interface to that function.
--
runSTArray :: (Ix i)
=> (forall s . ST s (STArray s i e))
-> Array i e
runSTArray st = runST (st >>= unsafeFreezeSTArray)
-- | A safe way to create and work with an unboxed mutable array before
-- returning an immutable array for later perusal. This function
-- avoids copying the array before returning it - it uses
-- 'unsafeFreeze' internally, but this wrapper is a safe interface to
-- that function.
--
runSTUArray :: (Ix i)
=> (forall s . ST s (STUArray s i e))
-> UArray i e
runSTUArray st = runST (st >>= unsafeFreezeSTUArray)
-- INTERESTING... this is the type we'd like to give to runSTUArray:
--
-- runSTUArray :: (Ix i, IArray UArray e,
-- forall s. MArray (STUArray s) e (ST s))
-- => (forall s . ST s (STUArray s i e))
-- -> UArray i e
--
-- Note the quantified constraint. We dodged the problem by using
-- unsafeFreezeSTUArray directly in the defn of runSTUArray above, but
-- this essentially constrains us to a single unsafeFreeze for all STUArrays
-- (in theory we might have a different one for certain element types).
{-# DEPRECATED castSTUArray
"Please import from Data.Array.Unsafe instead; This will be removed in the next release"
#-}
-- | 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...).
{-# INLINE castSTUArray #-}
castSTUArray :: STUArray s ix a -> ST s (STUArray s ix b)
castSTUArray = U.castSTUArray
|
