Modulearray-0.5.8.0Haskell2010

Data.Array.Storable.Internals

Actual implementation of Data.Array.Storable.

WARNING

This module is considered internal.

The Package Versioning Policy does not apply.

The contents of this module may change in any way whatsoever and without any warning between minor versions of this package.

Authors importing this module are expected to track development closely.

1 type
3 values

Packagearray-0.5.8.0
Exports4
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternals.hs

datadata StorableArray i e

The array type

Constructors

StorableArray !i !i Int !(ForeignPtr e)

Instances1MArray

Storable e => MArray StorableArray e IODefined in array-0.5.8.0 · Data.Array.Storable.Internals

valuewithStorableArray :: StorableArray i e -> (Ptr e -> IO a) -> IO a

The pointer to the array contents is obtained by withStorableArray. The idea is similar to ForeignPtr (used internally here). The pointer should be used only during execution of the IO action retured by the function passed as argument to withStorableArray.

valuetouchStorableArray :: StorableArray i e -> IO ()

If you want to use it afterwards, ensure that you touchStorableArray after the last use of the pointer, so the array is not freed too early.

valueunsafeForeignPtrToStorableArray

:: Ix i
=> ForeignPtr e
-> (i, i)
-> IO (StorableArray i e)

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.