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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
{-# LANGUAGE DeriveDataTypeable, FlexibleInstances, MultiParamTypeClasses,
CPP #-}
#if __GLASGOW_HASKELL__ >= 708
{-# LANGUAGE RoleAnnotations #-}
#endif
{-# OPTIONS_HADDOCK hide #-}
-----------------------------------------------------------------------------
-- |
-- Module : Data.Array.IO.Internal
-- Copyright : (c) The University of Glasgow 2001-2012
-- License : BSD-style (see the file libraries/base/LICENSE)
--
-- Maintainer : libraries@haskell.org
-- Stability : experimental
-- Portability : non-portable (uses Data.Array.Base)
--
-- Mutable boxed and unboxed arrays in the IO monad.
--
-----------------------------------------------------------------------------
module Data.Array.IO.Internals (
IOArray(..), -- instance of: Eq, Typeable
IOUArray(..), -- instance of: Eq, Typeable
castIOUArray, -- :: IOUArray ix a -> IO (IOUArray ix b)
unsafeThawIOUArray,
) where
import Data.Int
import Data.Word
import Data.Typeable
import Control.Monad.ST ( RealWorld, stToIO )
import Foreign.Ptr ( Ptr, FunPtr )
import Foreign.StablePtr ( StablePtr )
#if __GLASGOW_HASKELL__ < 711
import Data.Ix
#endif
import Data.Array.Base
import GHC.IOArray (IOArray(..))
-----------------------------------------------------------------------------
-- Flat unboxed mutable arrays (IO monad)
-- | Mutable, unboxed, strict arrays in the 'IO' monad. The type
-- arguments are as follows:
--
-- * @i@: the index type of the array (should be an instance of 'Ix')
--
-- * @e@: the element type of the array. Only certain element types
-- are supported: see "Data.Array.MArray" for a list of instances.
--
newtype IOUArray i e = IOUArray (STUArray RealWorld i e)
deriving Typeable
#if __GLASGOW_HASKELL__ >= 708
-- Both parameters have class-based invariants. See also #9220.
type role IOUArray nominal nominal
#endif
instance Eq (IOUArray i e) where
IOUArray s1 == IOUArray s2 = s1 == s2
instance MArray IOUArray Bool IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Char IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Int IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Word IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray (Ptr a) IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray (FunPtr a) IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Float IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Double IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray (StablePtr a) IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Int8 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Int16 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Int32 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Int64 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Word8 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Word16 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Word32 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
instance MArray IOUArray Word64 IO where
{-# INLINE getBounds #-}
getBounds (IOUArray arr) = stToIO $ getBounds arr
{-# INLINE getNumElements #-}
getNumElements (IOUArray arr) = stToIO $ getNumElements arr
{-# INLINE newArray #-}
newArray lu initialValue = stToIO $ do
marr <- newArray lu initialValue; return (IOUArray marr)
{-# INLINE unsafeNewArray_ #-}
unsafeNewArray_ lu = stToIO $ do
marr <- unsafeNewArray_ lu; return (IOUArray marr)
{-# INLINE newArray_ #-}
newArray_ = unsafeNewArray_
{-# INLINE unsafeRead #-}
unsafeRead (IOUArray marr) i = stToIO (unsafeRead marr i)
{-# INLINE unsafeWrite #-}
unsafeWrite (IOUArray marr) i e = stToIO (unsafeWrite marr i e)
-- | Casts an 'IOUArray' 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...).
castIOUArray :: IOUArray ix a -> IO (IOUArray ix b)
castIOUArray (IOUArray marr) = stToIO $ do
marr' <- castSTUArray marr
return (IOUArray marr')
{-# INLINE unsafeThawIOUArray #-}
#if __GLASGOW_HASKELL__ >= 711
unsafeThawIOUArray :: UArray ix e -> IO (IOUArray ix e)
#else
unsafeThawIOUArray :: Ix ix => UArray ix e -> IO (IOUArray ix e)
#endif
unsafeThawIOUArray arr = stToIO $ do
marr <- unsafeThawSTUArray arr
return (IOUArray marr)
{-# RULES
"unsafeThaw/IOUArray" unsafeThaw = unsafeThawIOUArray
#-}
#if __GLASGOW_HASKELL__ >= 711
thawIOUArray :: UArray ix e -> IO (IOUArray ix e)
#else
thawIOUArray :: Ix ix => UArray ix e -> IO (IOUArray ix e)
#endif
thawIOUArray arr = stToIO $ do
marr <- thawSTUArray arr
return (IOUArray marr)
{-# RULES
"thaw/IOUArray" thaw = thawIOUArray
#-}
{-# INLINE unsafeFreezeIOUArray #-}
#if __GLASGOW_HASKELL__ >= 711
unsafeFreezeIOUArray :: IOUArray ix e -> IO (UArray ix e)
#else
unsafeFreezeIOUArray :: Ix ix => IOUArray ix e -> IO (UArray ix e)
#endif
unsafeFreezeIOUArray (IOUArray marr) = stToIO (unsafeFreezeSTUArray marr)
{-# RULES
"unsafeFreeze/IOUArray" unsafeFreeze = unsafeFreezeIOUArray
#-}
#if __GLASGOW_HASKELL__ >= 711
freezeIOUArray :: IOUArray ix e -> IO (UArray ix e)
#else
freezeIOUArray :: Ix ix => IOUArray ix e -> IO (UArray ix e)
#endif
freezeIOUArray (IOUArray marr) = stToIO (freezeSTUArray marr)
{-# RULES
"freeze/IOUArray" freeze = freezeIOUArray
#-}
|