Data.Primitive.Contiguous

Documentation

class Contiguous (arr :: Type -> Type) where

A contiguous array of elements.

Minimal complete definition

empty, new, index, index#, indexM, read, write, resize, size, sizeMutable, unsafeFreeze, copy, copyMutable, clone, cloneMutable, equals, unlift, lift

Associated Types

type Mutable arr = (r :: Type -> Type -> Type) | r -> arr

type Element arr :: Type -> Constraint

Methods

empty :: arr a

new :: Element arr b => Int -> ST s (Mutable arr s b)

index :: Element arr b => arr b -> Int -> b

index# :: Element arr b => arr b -> Int -> (#b#)

indexM :: (Element arr b, Monad m) => arr b -> Int -> m b

read :: Element arr b => Mutable arr s b -> Int -> ST s b

write :: Element arr b => Mutable arr s b -> Int -> b -> ST s ()

resize :: Element arr b => Mutable arr s b -> Int -> ST s (Mutable arr s b)

size :: Element arr b => arr b -> Int

sizeMutable :: Element arr b => Mutable arr s b -> ST s Int

unsafeFreeze :: Mutable arr s b -> ST s (arr b)

copy :: Element arr b => Mutable arr s b -> Int -> arr b -> Int -> Int -> ST s ()

copyMutable :: Element arr b => Mutable arr s b -> Int -> Mutable arr s b -> Int -> Int -> ST s ()

clone :: Element arr b => arr b -> Int -> Int -> arr b

cloneMutable :: Element arr b => Mutable arr s b -> Int -> Int -> ST s (Mutable arr s b)

equals :: (Element arr b, Eq b) => arr b -> arr b -> Bool

unlift :: arr b -> ArrayArray#

lift :: ArrayArray# -> arr b

Instances

Contiguous UnliftedArray

Associated Types

type Mutable (UnliftedArray :: Type -> Type) = (r :: Type -> Type -> Type)

type Element (UnliftedArray :: Type -> Type) :: Type -> Constraint

Methods

empty :: UnliftedArray a

new :: Element UnliftedArray b => Int -> ST s (Mutable UnliftedArray s b)

index :: Element UnliftedArray b => UnliftedArray b -> Int -> b

index# :: Element UnliftedArray b => UnliftedArray b -> Int -> (#LiftedRep, b#)

indexM :: (Element UnliftedArray b, Monad m) => UnliftedArray b -> Int -> m b

read :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> ST s b

write :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> b -> ST s ()

resize :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> ST s (Mutable UnliftedArray s b)

size :: Element UnliftedArray b => UnliftedArray b -> Int

sizeMutable :: Element UnliftedArray b => Mutable UnliftedArray s b -> ST s Int

unsafeFreeze :: Mutable UnliftedArray s b -> ST s (UnliftedArray b)

copy :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> UnliftedArray b -> Int -> Int -> ST s ()

copyMutable :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> Mutable UnliftedArray s b -> Int -> Int -> ST s ()

clone :: Element UnliftedArray b => UnliftedArray b -> Int -> Int -> UnliftedArray b

cloneMutable :: Element UnliftedArray b => Mutable UnliftedArray s b -> Int -> Int -> ST s (Mutable UnliftedArray s b)

equals :: (Element UnliftedArray b, Eq b) => UnliftedArray b -> UnliftedArray b -> Bool

unlift :: UnliftedArray b -> ArrayArray#

lift :: ArrayArray# -> UnliftedArray b

Contiguous PrimArray

Associated Types

type Mutable (PrimArray :: Type -> Type) = (r :: Type -> Type -> Type)

type Element (PrimArray :: Type -> Type) :: Type -> Constraint

Methods

empty :: PrimArray a

new :: Element PrimArray b => Int -> ST s (Mutable PrimArray s b)

index :: Element PrimArray b => PrimArray b -> Int -> b

index# :: Element PrimArray b => PrimArray b -> Int -> (#LiftedRep, b#)

indexM :: (Element PrimArray b, Monad m) => PrimArray b -> Int -> m b

read :: Element PrimArray b => Mutable PrimArray s b -> Int -> ST s b

write :: Element PrimArray b => Mutable PrimArray s b -> Int -> b -> ST s ()

resize :: Element PrimArray b => Mutable PrimArray s b -> Int -> ST s (Mutable PrimArray s b)

size :: Element PrimArray b => PrimArray b -> Int

sizeMutable :: Element PrimArray b => Mutable PrimArray s b -> ST s Int

unsafeFreeze :: Mutable PrimArray s b -> ST s (PrimArray b)

copy :: Element PrimArray b => Mutable PrimArray s b -> Int -> PrimArray b -> Int -> Int -> ST s ()

copyMutable :: Element PrimArray b => Mutable PrimArray s b -> Int -> Mutable PrimArray s b -> Int -> Int -> ST s ()

clone :: Element PrimArray b => PrimArray b -> Int -> Int -> PrimArray b

cloneMutable :: Element PrimArray b => Mutable PrimArray s b -> Int -> Int -> ST s (Mutable PrimArray s b)

equals :: (Element PrimArray b, Eq b) => PrimArray b -> PrimArray b -> Bool

unlift :: PrimArray b -> ArrayArray#

lift :: ArrayArray# -> PrimArray b

Contiguous Array

Associated Types

type Mutable (Array :: Type -> Type) = (r :: Type -> Type -> Type)

type Element (Array :: Type -> Type) :: Type -> Constraint

Methods

empty :: Array a

new :: Element Array b => Int -> ST s (Mutable Array s b)

index :: Element Array b => Array b -> Int -> b

index# :: Element Array b => Array b -> Int -> (#LiftedRep, b#)

indexM :: (Element Array b, Monad m) => Array b -> Int -> m b

read :: Element Array b => Mutable Array s b -> Int -> ST s b

write :: Element Array b => Mutable Array s b -> Int -> b -> ST s ()

resize :: Element Array b => Mutable Array s b -> Int -> ST s (Mutable Array s b)

size :: Element Array b => Array b -> Int

sizeMutable :: Element Array b => Mutable Array s b -> ST s Int

unsafeFreeze :: Mutable Array s b -> ST s (Array b)

copy :: Element Array b => Mutable Array s b -> Int -> Array b -> Int -> Int -> ST s ()

copyMutable :: Element Array b => Mutable Array s b -> Int -> Mutable Array s b -> Int -> Int -> ST s ()

clone :: Element Array b => Array b -> Int -> Int -> Array b

cloneMutable :: Element Array b => Mutable Array s b -> Int -> Int -> ST s (Mutable Array s b)

equals :: (Element Array b, Eq b) => Array b -> Array b -> Bool

unlift :: Array b -> ArrayArray#

lift :: ArrayArray# -> Array b

class Always a

Instances

Always a

map :: (Contiguous arr, Element arr b, Element arr c) => (b -> c) -> arr b -> arr c

Map over the elements of an array.

foldr :: (Contiguous arr, Element arr a) => (a -> b -> b) -> b -> arr a -> b

Right fold over the element of an array.

foldl' :: (Contiguous arr, Element arr a) => (b -> a -> b) -> b -> arr a -> b

Strict left fold over the elements of an array.

foldr' :: (Contiguous arr, Element arr a) => (a -> b -> b) -> b -> arr a -> b

Strict right fold over the elements of an array.

foldMap' :: (Contiguous arr, Element arr a, Monoid m) => (a -> m) -> arr a -> m

Strict monoidal fold over the elements of an array.

foldlM' :: (Contiguous arr, Element arr a, Monad m) => (b -> a -> m b) -> b -> arr a -> m b

Strict left monadic fold over the elements of an array.

unsafeFromListN

Arguments

:: (Contiguous arr, Element arr a)

=> Int

length of list

-> [a]

list

-> arr a

Create an array from a list. If the given length does not match the actual length, this function has undefined behavior.

unsafeFromListReverseN :: (Contiguous arr, Element arr a) => Int -> [a] -> arr a

Create an array from a list, reversing the order of the elements. If the given length does not match the actual length, this function has undefined behavior.