Safe Haskell	None
Language	Haskell2010

Data.Primitive.UnliftedArray

Synopsis

Documentation

data UnliftedArray e :: * -> * #

Immutable arrays that efficiently store types that are simple wrappers around unlifted primitive types. The values of the unlifted type are stored directly, eliminating a layer of indirection.

Constructors

UnliftedArray ArrayArray#

Instances

(Eq a, PrimUnlifted a) => Eq (UnliftedArray a)
Methods (==) :: UnliftedArray a -> UnliftedArray a -> Bool # (/=) :: UnliftedArray a -> UnliftedArray a -> Bool #
PrimUnlifted (UnliftedArray e)
Methods toArrayArray# :: UnliftedArray e -> ArrayArray# # fromArrayArray# :: ArrayArray# -> UnliftedArray e #

data MutableUnliftedArray s e :: * -> * -> * #

Mutable arrays that efficiently store types that are simple wrappers around unlifted primitive types. The values of the unlifted type are stored directly, eliminating a layer of indirection.

Constructors

MutableUnliftedArray (MutableArrayArray# s)

Instances

Eq (MutableUnliftedArray s a)
Methods (==) :: MutableUnliftedArray s a -> MutableUnliftedArray s a -> Bool # (/=) :: MutableUnliftedArray s a -> MutableUnliftedArray s a -> Bool #
PrimUnlifted (MutableUnliftedArray s e)
Methods toArrayArray# :: MutableUnliftedArray s e -> ArrayArray# # fromArrayArray# :: ArrayArray# -> MutableUnliftedArray s e #

class PrimUnlifted a where #

Classifies the types that are able to be stored in UnliftedArray and MutableUnliftedArray. These should be types that are just liftings of the unlifted pointer types, so that their internal contents can be safely coerced into an ArrayArray#.

Minimal complete definition

toArrayArray#, fromArrayArray#

Methods

toArrayArray# :: a -> ArrayArray# #

fromArrayArray# :: ArrayArray# -> a #

Instances

PrimUnlifted ByteArray
Methods toArrayArray# :: ByteArray -> ArrayArray# # fromArrayArray# :: ArrayArray# -> ByteArray #
PrimUnlifted (UnliftedArray e)
Methods toArrayArray# :: UnliftedArray e -> ArrayArray# # fromArrayArray# :: ArrayArray# -> UnliftedArray e #
PrimUnlifted (MutableByteArray s)
Methods toArrayArray# :: MutableByteArray s -> ArrayArray# # fromArrayArray# :: ArrayArray# -> MutableByteArray s #
PrimUnlifted (SmallArray a)
Methods toArrayArray# :: SmallArray a -> ArrayArray# # fromArrayArray# :: ArrayArray# -> SmallArray a #
PrimUnlifted (Array a)
Methods toArrayArray# :: Array a -> ArrayArray# # fromArrayArray# :: ArrayArray# -> Array a #
PrimUnlifted (MutableUnliftedArray s e)
Methods toArrayArray# :: MutableUnliftedArray s e -> ArrayArray# # fromArrayArray# :: ArrayArray# -> MutableUnliftedArray s e #
PrimUnlifted (SmallMutableArray s a)
Methods toArrayArray# :: SmallMutableArray s a -> ArrayArray# # fromArrayArray# :: ArrayArray# -> SmallMutableArray s a #
PrimUnlifted (MutVar s a)
Methods toArrayArray# :: MutVar s a -> ArrayArray# # fromArrayArray# :: ArrayArray# -> MutVar s a #
PrimUnlifted (MutableArray s a)
Methods toArrayArray# :: MutableArray s a -> ArrayArray# # fromArrayArray# :: ArrayArray# -> MutableArray s a #

unsafeNewUnliftedArray :: PrimMonad m => Int -> m (MutableUnliftedArray (PrimState m) a) Source #

newUnliftedArray :: (PrimMonad m, PrimUnlifted a) => Int -> a -> m (MutableUnliftedArray (PrimState m) a) Source #

setUnliftedArray #

Arguments

:: (PrimMonad m, PrimUnlifted a)
=> MutableUnliftedArray (PrimState m) a	destination
-> a	value to fill with
-> m ()

Sets all the positions in an unlifted array to the designated value.

sizeofUnliftedArray :: UnliftedArray e -> Int #

Yields the length of an UnliftedArray.

sizeofMutableUnliftedArray :: MutableUnliftedArray s e -> Int #

Yields the length of a MutableUnliftedArray.

readUnliftedArray :: (PrimMonad m, PrimUnlifted a) => MutableUnliftedArray (PrimState m) a -> Int -> m a Source #

writeUnliftedArray :: (PrimMonad m, PrimUnlifted a) => MutableUnliftedArray (PrimState m) a -> Int -> a -> m () Source #

indexUnliftedArray :: PrimUnlifted a => UnliftedArray a -> Int -> a Source #

indexUnliftedArrayM :: (Monad m, PrimUnlifted a) => UnliftedArray a -> Int -> m a Source #

unsafeFreezeUnliftedArray :: PrimMonad m => MutableUnliftedArray (PrimState m) a -> m (UnliftedArray a) #

Freezes a MutableUnliftedArray, yielding an UnliftedArray. This simply marks the array as frozen in place, so it should only be used when no further modifications to the mutable array will be performed.

freezeUnliftedArray Source #

Arguments

:: PrimMonad m
=> MutableUnliftedArray (PrimState m) a	source
-> Int	offset
-> Int	length
-> m (UnliftedArray a)

thawUnliftedArray Source #

Arguments

:: PrimMonad m
=> UnliftedArray a	source
-> Int	offset
-> Int	length
-> m (MutableUnliftedArray (PrimState m) a)

sameMutableUnliftedArray :: MutableUnliftedArray s a -> MutableUnliftedArray s a -> Bool #

Determines whether two MutableUnliftedArray values are the same. This is object/pointer identity, not based on the contents.

copyUnliftedArray Source #

Arguments

:: PrimMonad m
=> MutableUnliftedArray (PrimState m) a	destination array
-> Int	offset into destination array
-> UnliftedArray a	source array
-> Int	offset into source array
-> Int	number of elements to copy
-> m ()

copyMutableUnliftedArray Source #

Arguments

:: PrimMonad m
=> MutableUnliftedArray (PrimState m) a	destination array
-> Int	offset into destination array
-> MutableUnliftedArray (PrimState m) a	source array
-> Int	offset into source array
-> Int	number of elements to copy
-> m ()

cloneUnliftedArray Source #

Arguments

:: UnliftedArray a	source array
-> Int	offset into destination array
-> Int	number of elements to copy
-> UnliftedArray a

cloneMutableUnliftedArray Source #

Arguments

:: PrimMonad m
=> MutableUnliftedArray (PrimState m) a	source array
-> Int	offset into destination array
-> Int	number of elements to copy
-> m (MutableUnliftedArray (PrimState m) a)