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
|
-----------------------------------------------------------------------------
-- |
-- Module : Data.Array.Storable
-- 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)
--
-- A storable array is an IO-mutable array which stores its
-- contents in a contiguous memory block living in the C
-- heap. Elements are stored according to the class 'Storable'.
-- You can obtain the pointer to the array contents to manipulate
-- elements from languages like C.
--
-- It is similar to 'Data.Array.IO.IOUArray' but slower.
-- Its advantage is that it's compatible with C.
--
-----------------------------------------------------------------------------
module Data.Array.Storable (
-- * Arrays of 'Storable' things.
StorableArray, -- data StorableArray index element
-- + index type must be in class Ix
-- + element type must be in class Storable
-- * Overloaded mutable array interface
-- | Module "Data.Array.MArray" provides the interface of storable arrays.
-- They are instances of class 'MArray' (with the 'IO' monad).
module Data.Array.MArray,
-- * Accessing the pointer to the array contents
withStorableArray, -- :: StorableArray i e -> (Ptr e -> IO a) -> IO a
touchStorableArray, -- :: StorableArray i e -> IO ()
unsafeForeignPtrToStorableArray
) where
import Foreign hiding (newArray)
import Data.Array.MArray
import Data.Array.Storable.Internals hiding ( unsafeForeignPtrToStorableArray )
import qualified Data.Array.Unsafe as U ( unsafeForeignPtrToStorableArray )
{-# DEPRECATED unsafeForeignPtrToStorableArray
"Please import from Data.Array.Unsafe instead; This will be removed in the next release"
#-}
-- |Construct a 'StorableArray' from an arbitrary 'ForeignPtr'. It is
-- the caller's responsibility to ensure that the 'ForeignPtr' points to
-- an area of memory sufficient for the specified bounds.
{-# INLINE unsafeForeignPtrToStorableArray #-}
unsafeForeignPtrToStorableArray
:: Ix i => ForeignPtr e -> (i,i) -> IO (StorableArray i e)
unsafeForeignPtrToStorableArray = U.unsafeForeignPtrToStorableArray
|
