Data.Primitive.Unlifted.Array.ST

A version of the Array interface specialized to ST. This is intended primarily so library developers can easily check whether the basic operations are unboxed properly, but its more constrained type signatures also offer somewhat better type inference where applicable.

Types

data UnliftedArray_ a unlifted_a

An UnliftedArray_ a unlifted_a represents an array of values of a lifted type a that wrap values of an unlifted type unlifted_a. It is expected that unlifted_a ~ Unlifted a, but imposing that constraint here would force the type roles to nominal, which is often undesirable when arrays are used as components of larger datatypes.

Constructors

UnliftedArray (UnliftedArray# unlifted_a)

Instances

(PrimUnlifted a, unlifted_a ~ Unlifted a) => IsList (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Associated Types

type Item (UnliftedArray_ a unlifted_a)

Methods

fromList :: [Item (UnliftedArray_ a unlifted_a)] -> UnliftedArray_ a unlifted_a

fromListN :: Int -> [Item (UnliftedArray_ a unlifted_a)] -> UnliftedArray_ a unlifted_a

toList :: UnliftedArray_ a unlifted_a -> [Item (UnliftedArray_ a unlifted_a)]

(Eq a, PrimUnlifted a, unlifted_a ~ Unlifted a) => Eq (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Methods

(==) :: UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a -> Bool

(/=) :: UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a -> Bool

(Show a, PrimUnlifted a, unlifted_a ~ Unlifted a) => Show (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Methods

showsPrec :: Int -> UnliftedArray_ a unlifted_a -> ShowS

show :: UnliftedArray_ a unlifted_a -> String

showList :: [UnliftedArray_ a unlifted_a] -> ShowS

(PrimUnlifted a, unlifted_a ~ Unlifted a) => Semigroup (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Methods

(<>) :: UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a

sconcat :: NonEmpty (UnliftedArray_ a unlifted_a) -> UnliftedArray_ a unlifted_a

stimes :: Integral b => b -> UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a

(PrimUnlifted a, unlifted_a ~ Unlifted a) => Monoid (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Methods

mempty :: UnliftedArray_ a unlifted_a

mappend :: UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a -> UnliftedArray_ a unlifted_a

mconcat :: [UnliftedArray_ a unlifted_a] -> UnliftedArray_ a unlifted_a

unlifted_a ~ Unlifted a => PrimUnlifted (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Associated Types

type Unlifted (UnliftedArray_ a unlifted_a) :: TYPE 'UnliftedRep

Methods

toUnlifted# :: UnliftedArray_ a unlifted_a -> Unlifted (UnliftedArray_ a unlifted_a)

fromUnlifted# :: Unlifted (UnliftedArray_ a unlifted_a) -> UnliftedArray_ a unlifted_a

type Item (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

type Item (UnliftedArray_ a unlifted_a) = a

type Unlifted (UnliftedArray_ a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

type Unlifted (UnliftedArray_ a unlifted_a) = UnliftedArray# unlifted_a

type UnliftedArray a = UnliftedArray_ a (Unlifted a)

A type synonym for an UnliftedArray_ containing lifted values of a particular type. As a general rule, this type synonym should not be used in class instances—use UnliftedArray_ with an equality constraint instead. It also should not be used when defining newtypes or datatypes, unless those will have restrictive type roles regardless—use UnliftedArray_ instead.

data MutableUnliftedArray_ s a unlifted_a

A mutable version of UnliftedArray_.

Constructors

MutableUnliftedArray (MutableUnliftedArray# s unlifted_a)

Instances

unlifted_a ~ Unlifted a => Eq (MutableUnliftedArray_ s a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Methods

(==) :: MutableUnliftedArray_ s a unlifted_a -> MutableUnliftedArray_ s a unlifted_a -> Bool

(/=) :: MutableUnliftedArray_ s a unlifted_a -> MutableUnliftedArray_ s a unlifted_a -> Bool

unlifted_a ~ Unlifted a => PrimUnlifted (MutableUnliftedArray_ s a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

Associated Types

type Unlifted (MutableUnliftedArray_ s a unlifted_a) :: TYPE 'UnliftedRep

Methods

toUnlifted# :: MutableUnliftedArray_ s a unlifted_a -> Unlifted (MutableUnliftedArray_ s a unlifted_a)

fromUnlifted# :: Unlifted (MutableUnliftedArray_ s a unlifted_a) -> MutableUnliftedArray_ s a unlifted_a

type Unlifted (MutableUnliftedArray_ s a unlifted_a)

Defined in Data.Primitive.Unlifted.Array.ST

type Unlifted (MutableUnliftedArray_ s a unlifted_a) = MutableUnliftedArray# s unlifted_a

type MutableUnliftedArray s a = MutableUnliftedArray_ s a (Unlifted a)

A mutable version of MutableUnliftedArray.

Operations

newUnliftedArray

Arguments

:: PrimUnlifted a

=> Int

size

-> a

initial value

-> ST s (MutableUnliftedArray s a)

Creates a new MutableUnliftedArray with the specified value as initial contents.

unsafeNewUnliftedArray

Arguments

:: Int

size

-> ST s (MutableUnliftedArray s a)

Creates a new MutableUnliftedArray. This function is unsafe because it initializes all elements of the array as pointers to the empty array. Attempting to read one of these elements before writing to it is in effect an unsafe coercion from UnliftedArray a to the element type.

sizeofUnliftedArray :: UnliftedArray e -> Int

Yields the length of an UnliftedArray.

sizeofMutableUnliftedArray :: MutableUnliftedArray s e -> Int

Yields the length of a MutableUnliftedArray.

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.

writeUnliftedArray :: PrimUnlifted a => MutableUnliftedArray s a -> Int -> a -> ST s ()

readUnliftedArray :: PrimUnlifted a => MutableUnliftedArray s a -> Int -> ST s a

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

unsafeFreezeUnliftedArray :: MutableUnliftedArray s a -> ST s (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

Arguments

:: MutableUnliftedArray s a

source

-> Int

offset

-> Int

length

-> ST s (UnliftedArray a)

Freezes a portion of a MutableUnliftedArray, yielding an UnliftedArray. This operation is safe, in that it copies the frozen portion, and the existing mutable array may still be used afterward.

thawUnliftedArray

Arguments

:: UnliftedArray a

source

-> Int

offset

-> Int

length

-> ST s (MutableUnliftedArray s a)

Thaws a portion of an UnliftedArray, yielding a MutableUnliftedArray. This copies the thawed portion, so mutations will not affect the original array.

unsafeThawUnliftedArray

Arguments

:: UnliftedArray a

source

-> ST s (MutableUnliftedArray s a)

Thaws an UnliftedArray, yielding a MutableUnliftedArray. This does not make a copy.

setUnliftedArray

Arguments

:: PrimUnlifted a

=> MutableUnliftedArray s a

destination

-> a

value to fill with

-> Int

offset

-> Int

length

-> ST s ()

copyUnliftedArray

Arguments

:: MutableUnliftedArray s a

destination

-> Int

offset into destination

-> UnliftedArray a

source

-> Int

offset into source

-> Int

number of elements to copy

-> ST s ()

Copies the contents of an immutable array into a mutable array.

copyMutableUnliftedArray

Arguments

:: MutableUnliftedArray s a

destination

-> Int

offset into destination

-> MutableUnliftedArray s a

source

-> Int

offset into source

-> Int

number of elements to copy

-> ST s ()

Copies the contents of one mutable array into another.

cloneUnliftedArray

Arguments

:: UnliftedArray a

source

-> Int

offset

-> Int

length

-> UnliftedArray a

Creates a copy of a portion of an UnliftedArray

cloneMutableUnliftedArray

Arguments

:: MutableUnliftedArray s a

source

-> Int

offset

-> Int

length

-> ST s (MutableUnliftedArray s a)

Creates a new MutableUnliftedArray containing a copy of a portion of another mutable array.

emptyUnliftedArray :: UnliftedArray a

singletonUnliftedArray :: PrimUnlifted a => a -> UnliftedArray a

runUnliftedArray :: (forall s. ST s (MutableUnliftedArray s a)) -> UnliftedArray a

Execute a stateful computation and freeze the resulting array.

dupableRunUnliftedArray :: (forall s. ST s (MutableUnliftedArray s a)) -> UnliftedArray a

Execute a stateful computation and freeze the resulting array. It is possible, but unlikely, that the computation will be run multiple times in multiple threads.

List Conversion

unliftedArrayToList :: PrimUnlifted a => UnliftedArray a -> [a]

Convert the unlifted array to a list.

unliftedArrayFromList :: PrimUnlifted a => [a] -> UnliftedArray a

unliftedArrayFromListN :: forall a. PrimUnlifted a => Int -> [a] -> UnliftedArray a

Folding

foldrUnliftedArray :: forall a b. PrimUnlifted a => (a -> b -> b) -> b -> UnliftedArray a -> b

foldrUnliftedArray' :: forall a b. PrimUnlifted a => (a -> b -> b) -> b -> UnliftedArray a -> b

Strict right-associated fold over the elements of an 'UnliftedArray.

foldlUnliftedArray :: forall a b. PrimUnlifted a => (b -> a -> b) -> b -> UnliftedArray a -> b

Lazy left-associated fold over the elements of an UnliftedArray.

foldlUnliftedArray' :: forall a b. PrimUnlifted a => (b -> a -> b) -> b -> UnliftedArray a -> b

Strict left-associated fold over the elements of an UnliftedArray.

foldlUnliftedArrayM' :: (PrimUnlifted a, Monad m) => (b -> a -> m b) -> b -> UnliftedArray a -> m b

Strict effectful left-associated fold over the elements of an UnliftedArray.

Traversals

traverseUnliftedArray_ :: (PrimUnlifted a, Applicative m) => (a -> m b) -> UnliftedArray a -> m ()

Effectfully traverse the elements of an UnliftedArray, discarding the resulting values.

itraverseUnliftedArray_ :: (PrimUnlifted a, Applicative m) => (Int -> a -> m b) -> UnliftedArray a -> m ()

Effectful indexed traversal of the elements of an UnliftedArray, discarding the resulting values.

Mapping

mapUnliftedArray :: (PrimUnlifted a, PrimUnlifted b) => (a -> b) -> UnliftedArray a -> UnliftedArray b

Map over the elements of an UnliftedArray.