Moduleprimitive-unlifted-2.1.0.0Haskell2010

Data.Primitive.Unlifted.SmallArray.ST

A version of the Data.Primitive.Unlifted.SmallArray 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.

4 types
33 values

Packageprimitive-unlifted-2.1.0.0
Exports37
LanguageHaskell2010
LicenceBSD-3-Clause
SourceST.hs

Types

4 declarations

datadata SmallUnliftedArray_ a (unlifted_a :: UnliftedType)

A SmallUnliftedArray_ 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

SmallUnliftedArray (SmallUnliftedArray# unlifted_a)

Instances8IsList, Eq, Show, Semigroup, Monoid, PrimUnlifted, …

(PrimUnlifted a, unlifted_a ~ Unlifted a) => IsList (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
(Eq a, PrimUnlifted a, unlifted_a ~ Unlifted a) => Eq (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
(Show a, PrimUnlifted a, unlifted_a ~ Unlifted a) => Show (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
(PrimUnlifted a, unlifted_a ~ Unlifted a) => Semigroup (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
(PrimUnlifted a, unlifted_a ~ Unlifted a) => Monoid (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
unlifted_a ~ Unlifted a => PrimUnlifted (SmallUnliftedArray_ a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
type Item (SmallUnliftedArray_ a unlifted_a) = aDefined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
type Unlifted (SmallUnliftedArray_ a unlifted_a) = SmallUnliftedArray# unlifted_aDefined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST

typetype SmallUnliftedArray a = SmallUnliftedArray_ a (Unlifted a)

A type synonym for a SmallUnliftedArray_ containing lifted values of a particular type. As a general rule, this type synonym should not be used in class instances—use SmallUnliftedArray_ 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 SmallUnliftedArray_ instead.

datadata SmallMutableUnliftedArray_ s a (unlifted_a :: UnliftedType)

Constructors

SmallMutableUnliftedArray (SmallMutableUnliftedArray# s unlifted_a)

Instances3Eq, PrimUnlifted, Unlifted

unlifted_a ~ Unlifted a => Eq (SmallMutableUnliftedArray_ s a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
unlifted_a ~ Unlifted a => PrimUnlifted (SmallMutableUnliftedArray_ s a unlifted_a)Defined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST
type Unlifted (SmallMutableUnliftedArray_ s a unlifted_a) = SmallMutableUnliftedArray# s unlifted_aDefined in primitive-unlifted-2.1.0.0 · Data.Primitive.Unlifted.SmallArray.ST

typetype SmallMutableUnliftedArray s a = SmallMutableUnliftedArray_ s a (Unlifted a)

Operations

22 declarations

valuenewSmallUnliftedArray

:: PrimUnlifted a
=> Int
size
-> a
initial value
-> ST s (SmallMutableUnliftedArray s a)

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

valueunsafeNewSmallUnliftedArray

:: Int
size
-> ST s (SmallMutableUnliftedArray 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.

valuesizeofSmallUnliftedArray :: SmallUnliftedArray e -> Int

Yields the length of an UnliftedArray.

valuegetSizeofSmallMutableUnliftedArray

:: SmallMutableUnliftedArray s e
-> ST s Int

Yields the length of a MutableUnliftedArray.

valuesameSmallMutableUnliftedArray

:: SmallMutableUnliftedArray s a
-> SmallMutableUnliftedArray s a
-> Bool

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

valueshrinkSmallMutableUnliftedArray

:: SmallMutableUnliftedArray s a
-> Int
-> ST s ()

Shrink a mutable array to the specified size. The new size argument must be less than or equal to the current size.

valuewriteSmallUnliftedArray

:: PrimUnlifted a
=> SmallMutableUnliftedArray s a
-> Int
-> a
-> ST s ()

valuereadSmallUnliftedArray

:: PrimUnlifted a
=> SmallMutableUnliftedArray s a
-> Int
-> ST s a

valueindexSmallUnliftedArray

:: PrimUnlifted a
=> SmallUnliftedArray a
-> Int
-> a

valueunsafeFreezeSmallUnliftedArray

:: SmallMutableUnliftedArray s a
-> ST s (SmallUnliftedArray a)

Freezes a SmallMutableUnliftedArray, yielding a SmallUnliftedArray. 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.

valuefreezeSmallUnliftedArray

:: SmallMutableUnliftedArray s a
source
-> Int
offset
-> Int
length
-> ST s (SmallUnliftedArray 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.

valuethawSmallUnliftedArray

:: SmallUnliftedArray a
source
-> Int
offset
-> Int
length
-> ST s (SmallMutableUnliftedArray s a)

Thaws a portion of a SmallUnliftedArray, yielding a SmallMutableUnliftedArray. This copies the thawed portion, so mutations will not affect the original array.

valueunsafeThawSmallUnliftedArray

:: SmallUnliftedArray a
source
-> ST s (SmallMutableUnliftedArray s a)

Thaws a SmallUnliftedArray, yielding a SmallMutableUnliftedArray. This does not make a copy.

valuesetSmallUnliftedArray

:: PrimUnlifted a
=> SmallMutableUnliftedArray s a
destination
-> a
value to fill with
-> Int
offset
-> Int
length
-> ST s ()

valuecopySmallUnliftedArray

:: SmallMutableUnliftedArray s a
destination
-> Int
offset into destination
-> SmallUnliftedArray 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.

valuecopySmallMutableUnliftedArray

:: SmallMutableUnliftedArray s a
destination
-> Int
offset into destination
-> SmallMutableUnliftedArray s a
source
-> Int
offset into source
-> Int
number of elements to copy
-> ST s ()

Copies the contents of one mutable array into another.

valuecloneSmallUnliftedArray

:: SmallUnliftedArray a
source
-> Int
offset
-> Int
length
-> SmallUnliftedArray a

Creates a copy of a portion of a SmallUnliftedArray

valuecloneSmallMutableUnliftedArray

:: SmallMutableUnliftedArray s a
source
-> Int
offset
-> Int
length
-> ST s (SmallMutableUnliftedArray s a)

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

valueemptySmallUnliftedArray :: SmallUnliftedArray a

valuesingletonSmallUnliftedArray :: PrimUnlifted a => a -> SmallUnliftedArray a

valuerunSmallUnliftedArray

:: forall s. ST s (SmallMutableUnliftedArray s a)
-> SmallUnliftedArray a

Execute a stateful computation and freeze the resulting array.

valuedupableRunSmallUnliftedArray

:: forall s. ST s (SmallMutableUnliftedArray s a)
-> SmallUnliftedArray 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

3 declarations

valuesmallUnliftedArrayToList :: PrimUnlifted a => SmallUnliftedArray a -> [a]

Convert the unlifted array to a list.

valuesmallUnliftedArrayFromList :: PrimUnlifted a => [a] -> SmallUnliftedArray a

valuesmallUnliftedArrayFromListN

:: PrimUnlifted a
=> Int
-> [a]
-> SmallUnliftedArray a

Folding

5 declarations

valuefoldrSmallUnliftedArray

:: PrimUnlifted a
=> a -> b -> b
-> b
-> SmallUnliftedArray a
-> b

valuefoldrSmallUnliftedArray'

:: PrimUnlifted a
=> a -> b -> b
-> b
-> SmallUnliftedArray a
-> b

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

valuefoldlSmallUnliftedArray

:: PrimUnlifted a
=> b -> a -> b
-> b
-> SmallUnliftedArray a
-> b

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

valuefoldlSmallUnliftedArray'

:: PrimUnlifted a
=> b -> a -> b
-> b
-> SmallUnliftedArray a
-> b

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

valuefoldlSmallUnliftedArrayM'

:: (PrimUnlifted a, Monad m)
=> b -> a -> m b
-> b
-> SmallUnliftedArray a
-> m b

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

Traversals

2 declarations

valuetraverseSmallUnliftedArray_

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

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

valueitraverseSmallUnliftedArray_

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

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

Mapping

1 declaration

valuemapSmallUnliftedArray

:: (PrimUnlifted a, PrimUnlifted b)
=> a -> b
-> SmallUnliftedArray a
-> SmallUnliftedArray b

Map over the elements of an SmallUnliftedArray.