Z.Data.Array.Checked

This module provides exactly the same API with Z.Data.Array, but will throw an IndexOutOfBounds ArrayException on bound check failure, it's useful when debugging array algorithms: just swap this module with Z.Data.Array, segmentation faults caused by out bound access will be turned into exceptions with more informations.

Arr typeclass re-export

class Arr (arr :: * -> *) a

A typeclass to unify box & unboxed, mutable & immutable array operations.

Most of these functions simply wrap their primitive counterpart, if there's no primitive ones, we polyfilled using other operations to get the same semantics.

One exception is that shrinkMutableArr only perform closure resizing on PrimArray because current RTS support only that, shrinkMutableArr will do nothing on other array type.

It's reasonable to trust GHC with specializing & inlining these polymorphric functions. They are used across this package and perform identical to their monomophric counterpart.

Minimal complete definition

newArr, newArrWith, readArr, writeArr, setArr, indexArr, indexArr', indexArrM, freezeArr, thawArr, unsafeFreezeArr, unsafeThawArr, copyArr, copyMutableArr, moveArr, cloneArr, cloneMutableArr, resizeMutableArr, shrinkMutableArr, sameMutableArr, sizeofArr, sizeofMutableArr, sameArr

Instances

Prim a => Arr PrimArray a

Defined in Z.Data.Array

Associated Types

type MArr PrimArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr PrimArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr PrimArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> a -> m ()

indexArr :: PrimArray a -> Int -> a

indexArr' :: PrimArray a -> Int -> (#a#)

indexArrM :: Monad m => PrimArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> m (PrimArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => PrimArray a -> Int -> Int -> m (MArr PrimArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> m (PrimArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => PrimArray a -> m (MArr PrimArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> PrimArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> MArr PrimArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> MArr PrimArray s a -> Int -> Int -> m ()

cloneArr :: PrimArray a -> Int -> Int -> PrimArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> m (MArr PrimArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m (MArr PrimArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m ()

sameMutableArr :: MArr PrimArray s a -> MArr PrimArray s a -> Bool

sizeofArr :: PrimArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> m Int

sameArr :: PrimArray a -> PrimArray a -> Bool

Arr SmallArray a

Defined in Z.Data.Array

Associated Types

type MArr SmallArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr SmallArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr SmallArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> a -> m ()

indexArr :: SmallArray a -> Int -> a

indexArr' :: SmallArray a -> Int -> (#a#)

indexArrM :: Monad m => SmallArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> m (SmallArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => SmallArray a -> Int -> Int -> m (MArr SmallArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> m (SmallArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => SmallArray a -> m (MArr SmallArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> SmallArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> MArr SmallArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> MArr SmallArray s a -> Int -> Int -> m ()

cloneArr :: SmallArray a -> Int -> Int -> SmallArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> m (MArr SmallArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m (MArr SmallArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m ()

sameMutableArr :: MArr SmallArray s a -> MArr SmallArray s a -> Bool

sizeofArr :: SmallArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> m Int

sameArr :: SmallArray a -> SmallArray a -> Bool

Arr Array a

Defined in Z.Data.Array

Associated Types

type MArr Array = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr Array s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr Array s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> a -> m ()

indexArr :: Array a -> Int -> a

indexArr' :: Array a -> Int -> (#a#)

indexArrM :: Monad m => Array a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> m (Array a)

thawArr :: (PrimMonad m, PrimState m ~ s) => Array a -> Int -> Int -> m (MArr Array s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> m (Array a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => Array a -> m (MArr Array s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Array a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> MArr Array s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> MArr Array s a -> Int -> Int -> m ()

cloneArr :: Array a -> Int -> Int -> Array a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> m (MArr Array s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m (MArr Array s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m ()

sameMutableArr :: MArr Array s a -> MArr Array s a -> Bool

sizeofArr :: Array a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> m Int

sameArr :: Array a -> Array a -> Bool

PrimUnlifted a => Arr UnliftedArray a

Defined in Z.Data.Array

Associated Types

type MArr UnliftedArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr UnliftedArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr UnliftedArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> a -> m ()

indexArr :: UnliftedArray a -> Int -> a

indexArr' :: UnliftedArray a -> Int -> (#a#)

indexArrM :: Monad m => UnliftedArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (UnliftedArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> Int -> Int -> m (MArr UnliftedArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m (UnliftedArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> m (MArr UnliftedArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> UnliftedArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

cloneArr :: UnliftedArray a -> Int -> Int -> UnliftedArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (MArr UnliftedArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m (MArr UnliftedArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m ()

sameMutableArr :: MArr UnliftedArray s a -> MArr UnliftedArray s a -> Bool

sizeofArr :: UnliftedArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m Int

sameArr :: UnliftedArray a -> UnliftedArray a -> Bool

data RealWorld :: Type

RealWorld is deeply magical. It is primitive, but it is not unlifted (hence ptrArg). We never manipulate values of type RealWorld; it's only used in the type system, to parameterise State#.

Bound checked array operations

newArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => Int -> m (MArr arr s a)

newArrWith :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => Int -> a -> m (MArr arr s a)

readArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> m a

writeArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> a -> m ()

setArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> Int -> a -> m ()

indexArr :: (Arr arr a, HasCallStack) => arr a -> Int -> a

indexArr' :: (Arr arr a, HasCallStack) => arr a -> Int -> (#a#)

indexArrM :: (Arr arr a, Monad m, HasCallStack) => arr a -> Int -> m a

freezeArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> Int -> m (arr a)

thawArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => arr a -> Int -> Int -> m (MArr arr s a)

copyArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> arr a -> Int -> Int -> m ()

copyMutableArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> MArr arr s a -> Int -> Int -> m ()

moveArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> MArr arr s a -> Int -> Int -> m ()

cloneArr :: (Arr arr a, HasCallStack) => arr a -> Int -> Int -> arr a

cloneMutableArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> Int -> m (MArr arr s a)

resizeMutableArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> m (MArr arr s a)

shrinkMutableArr :: (Arr arr a, PrimMonad m, PrimState m ~ s, HasCallStack) => MArr arr s a -> Int -> m ()

New size should be >= 0, and <= original size.

No bound checked operations

unsafeFreezeArr :: (Arr arr a, PrimMonad m, PrimState m ~ s) => MArr arr s a -> m (arr a)

In place freeze a mutable array, the original mutable array can not be used anymore.

unsafeThawArr :: (Arr arr a, PrimMonad m, PrimState m ~ s) => arr a -> m (MArr arr s a)

In place thaw a immutable array, the original immutable array can not be used anymore.

sameMutableArr :: Arr arr a => MArr arr s a -> MArr arr s a -> Bool

Is two mutable array are reference equal.

sizeofArr :: Arr arr a => arr a -> Int

Size of immutable array.

sizeofMutableArr :: (Arr arr a, PrimMonad m, PrimState m ~ s) => MArr arr s a -> m Int

Size of mutable array.

sameArr :: Arr arr a => arr a -> arr a -> Bool

Is two immutable array are referencing the same one.

Note that sameArr 's result may change depending on compiler's optimizations, for example let arr = runST ... in arr sameArr arr may return false if compiler decides to inline it.

See https://ghc.haskell.org/trac/ghc/ticket/13908 for more background.

Boxed array type

data Array a

Boxed arrays

Constructors

Array

Fields

• array# :: Array# a

Instances

Monad Array

Defined in Data.Primitive.Array

Methods

(>>=) :: Array a -> (a -> Array b) -> Array b

(>>) :: Array a -> Array b -> Array b

return :: a -> Array a

fail :: String -> Array a

Functor Array

Defined in Data.Primitive.Array

Methods

fmap :: (a -> b) -> Array a -> Array b

(<$) :: a -> Array b -> Array a

MonadFix Array

Defined in Data.Primitive.Array

Methods

mfix :: (a -> Array a) -> Array a

MonadFail Array

Defined in Data.Primitive.Array

Methods

fail :: String -> Array a

Applicative Array

Defined in Data.Primitive.Array

Methods

pure :: a -> Array a

(<*>) :: Array (a -> b) -> Array a -> Array b

liftA2 :: (a -> b -> c) -> Array a -> Array b -> Array c

(*>) :: Array a -> Array b -> Array b

(<*) :: Array a -> Array b -> Array a

Foldable Array

Defined in Data.Primitive.Array

Methods

fold :: Monoid m => Array m -> m

foldMap :: Monoid m => (a -> m) -> Array a -> m

foldr :: (a -> b -> b) -> b -> Array a -> b

foldr' :: (a -> b -> b) -> b -> Array a -> b

foldl :: (b -> a -> b) -> b -> Array a -> b

foldl' :: (b -> a -> b) -> b -> Array a -> b

foldr1 :: (a -> a -> a) -> Array a -> a

foldl1 :: (a -> a -> a) -> Array a -> a

toList :: Array a -> [a]

null :: Array a -> Bool

length :: Array a -> Int

elem :: Eq a => a -> Array a -> Bool

maximum :: Ord a => Array a -> a

minimum :: Ord a => Array a -> a

sum :: Num a => Array a -> a

product :: Num a => Array a -> a

Traversable Array

Defined in Data.Primitive.Array

Methods

traverse :: Applicative f => (a -> f b) -> Array a -> f (Array b)

sequenceA :: Applicative f => Array (f a) -> f (Array a)

mapM :: Monad m => (a -> m b) -> Array a -> m (Array b)

sequence :: Monad m => Array (m a) -> m (Array a)

Eq1 Array

Since: primitive-0.6.4.0

Defined in Data.Primitive.Array

Methods

liftEq :: (a -> b -> Bool) -> Array a -> Array b -> Bool

Ord1 Array

Since: primitive-0.6.4.0

Defined in Data.Primitive.Array

Methods

liftCompare :: (a -> b -> Ordering) -> Array a -> Array b -> Ordering

Read1 Array

Since: primitive-0.6.4.0

Defined in Data.Primitive.Array

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (Array a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [Array a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (Array a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [Array a]

Show1 Array

Since: primitive-0.6.4.0

Defined in Data.Primitive.Array

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> Array a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [Array a] -> ShowS

MonadZip Array

Defined in Data.Primitive.Array

Methods

mzip :: Array a -> Array b -> Array (a, b)

mzipWith :: (a -> b -> c) -> Array a -> Array b -> Array c

munzip :: Array (a, b) -> (Array a, Array b)

Alternative Array

Defined in Data.Primitive.Array

Methods

empty :: Array a

(<|>) :: Array a -> Array a -> Array a

some :: Array a -> Array [a]

many :: Array a -> Array [a]

MonadPlus Array

Defined in Data.Primitive.Array

Methods

mzero :: Array a

mplus :: Array a -> Array a -> Array a

NFData1 Array

Defined in Data.Primitive.Array

Methods

liftRnf :: (a -> ()) -> Array a -> ()

Arr Array a

Defined in Z.Data.Array

Associated Types

type MArr Array = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr Array s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr Array s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> a -> m ()

indexArr :: Array a -> Int -> a

indexArr' :: Array a -> Int -> (#a#)

indexArrM :: Monad m => Array a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> m (Array a)

thawArr :: (PrimMonad m, PrimState m ~ s) => Array a -> Int -> Int -> m (MArr Array s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> m (Array a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => Array a -> m (MArr Array s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Array a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> MArr Array s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> MArr Array s a -> Int -> Int -> m ()

cloneArr :: Array a -> Int -> Int -> Array a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> Int -> m (MArr Array s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m (MArr Array s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> Int -> m ()

sameMutableArr :: MArr Array s a -> MArr Array s a -> Bool

sizeofArr :: Array a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr Array s a -> m Int

sameArr :: Array a -> Array a -> Bool

Vec Array a

Defined in Z.Data.Vector.Base

Associated Types

type IArray Array :: Type -> Type

Methods

toArr :: Array a -> (IArray Array a, Int, Int)

fromArr :: IArray Array a -> Int -> Int -> Array a

IsList (Array a)

Defined in Data.Primitive.Array

Associated Types

type Item (Array a) :: Type

Methods

fromList :: [Item (Array a)] -> Array a

fromListN :: Int -> [Item (Array a)] -> Array a

toList :: Array a -> [Item (Array a)]

Eq a => Eq (Array a)

Defined in Data.Primitive.Array

Methods

(==) :: Array a -> Array a -> Bool

(/=) :: Array a -> Array a -> Bool

Data a => Data (Array a)

Defined in Data.Primitive.Array

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Array a -> c (Array a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Array a)

toConstr :: Array a -> Constr

dataTypeOf :: Array a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Array a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Array a))

gmapT :: (forall b. Data b => b -> b) -> Array a -> Array a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Array a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Array a -> r

gmapQ :: (forall d. Data d => d -> u) -> Array a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Array a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Array a -> m (Array a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a -> m (Array a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a -> m (Array a)

Ord a => Ord (Array a)

Lexicographic ordering. Subject to change between major versions.

Defined in Data.Primitive.Array

Methods

compare :: Array a -> Array a -> Ordering

(<) :: Array a -> Array a -> Bool

(<=) :: Array a -> Array a -> Bool

(>) :: Array a -> Array a -> Bool

(>=) :: Array a -> Array a -> Bool

max :: Array a -> Array a -> Array a

min :: Array a -> Array a -> Array a

Read a => Read (Array a)

Defined in Data.Primitive.Array

Methods

readsPrec :: Int -> ReadS (Array a)

readList :: ReadS [Array a]

readPrec :: ReadPrec (Array a)

readListPrec :: ReadPrec [Array a]

Show a => Show (Array a)

Defined in Data.Primitive.Array

Methods

showsPrec :: Int -> Array a -> ShowS

show :: Array a -> String

showList :: [Array a] -> ShowS

Semigroup (Array a)

Since: primitive-0.6.3.0

Defined in Data.Primitive.Array

Methods

(<>) :: Array a -> Array a -> Array a

sconcat :: NonEmpty (Array a) -> Array a

stimes :: Integral b => b -> Array a -> Array a

Monoid (Array a)

Defined in Data.Primitive.Array

Methods

mempty :: Array a

mappend :: Array a -> Array a -> Array a

mconcat :: [Array a] -> Array a

NFData a => NFData (Array a)

Defined in Data.Primitive.Array

Methods

rnf :: Array a -> ()

type MArr Array

Defined in Z.Data.Array

type MArr Array = MutableArray

type IArray Array

Defined in Z.Data.Vector.Base

type IArray Array = Array

type Item (Array a)

Defined in Data.Primitive.Array

type Item (Array a) = a

data MutableArray s a

Mutable boxed arrays associated with a primitive state token.

Constructors

MutableArray

Fields

• marray# :: MutableArray# s a

Instances

Eq (MutableArray s a)

Defined in Data.Primitive.Array

Methods

(==) :: MutableArray s a -> MutableArray s a -> Bool

(/=) :: MutableArray s a -> MutableArray s a -> Bool

(Typeable s, Typeable a) => Data (MutableArray s a)

Defined in Data.Primitive.Array

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MutableArray s a -> c (MutableArray s a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (MutableArray s a)

toConstr :: MutableArray s a -> Constr

dataTypeOf :: MutableArray s a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (MutableArray s a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (MutableArray s a))

gmapT :: (forall b. Data b => b -> b) -> MutableArray s a -> MutableArray s a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MutableArray s a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MutableArray s a -> r

gmapQ :: (forall d. Data d => d -> u) -> MutableArray s a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MutableArray s a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a)

data SmallArray a

Constructors

SmallArray (SmallArray# a)

Instances

Monad SmallArray

Defined in Data.Primitive.SmallArray

Methods

(>>=) :: SmallArray a -> (a -> SmallArray b) -> SmallArray b

(>>) :: SmallArray a -> SmallArray b -> SmallArray b

return :: a -> SmallArray a

fail :: String -> SmallArray a

Functor SmallArray

Defined in Data.Primitive.SmallArray

Methods

fmap :: (a -> b) -> SmallArray a -> SmallArray b

(<$) :: a -> SmallArray b -> SmallArray a

MonadFix SmallArray

Defined in Data.Primitive.SmallArray

Methods

mfix :: (a -> SmallArray a) -> SmallArray a

MonadFail SmallArray

Defined in Data.Primitive.SmallArray

Methods

fail :: String -> SmallArray a

Applicative SmallArray

Defined in Data.Primitive.SmallArray

Methods

pure :: a -> SmallArray a

(<*>) :: SmallArray (a -> b) -> SmallArray a -> SmallArray b

liftA2 :: (a -> b -> c) -> SmallArray a -> SmallArray b -> SmallArray c

(*>) :: SmallArray a -> SmallArray b -> SmallArray b

(<*) :: SmallArray a -> SmallArray b -> SmallArray a

Foldable SmallArray

Defined in Data.Primitive.SmallArray

Methods

fold :: Monoid m => SmallArray m -> m

foldMap :: Monoid m => (a -> m) -> SmallArray a -> m

foldr :: (a -> b -> b) -> b -> SmallArray a -> b

foldr' :: (a -> b -> b) -> b -> SmallArray a -> b

foldl :: (b -> a -> b) -> b -> SmallArray a -> b

foldl' :: (b -> a -> b) -> b -> SmallArray a -> b

foldr1 :: (a -> a -> a) -> SmallArray a -> a

foldl1 :: (a -> a -> a) -> SmallArray a -> a

toList :: SmallArray a -> [a]

null :: SmallArray a -> Bool

length :: SmallArray a -> Int

elem :: Eq a => a -> SmallArray a -> Bool

maximum :: Ord a => SmallArray a -> a

minimum :: Ord a => SmallArray a -> a

sum :: Num a => SmallArray a -> a

product :: Num a => SmallArray a -> a

Traversable SmallArray

Defined in Data.Primitive.SmallArray

Methods

traverse :: Applicative f => (a -> f b) -> SmallArray a -> f (SmallArray b)

sequenceA :: Applicative f => SmallArray (f a) -> f (SmallArray a)

mapM :: Monad m => (a -> m b) -> SmallArray a -> m (SmallArray b)

sequence :: Monad m => SmallArray (m a) -> m (SmallArray a)

Eq1 SmallArray

Since: primitive-0.6.4.0

Defined in Data.Primitive.SmallArray

Methods

liftEq :: (a -> b -> Bool) -> SmallArray a -> SmallArray b -> Bool

Ord1 SmallArray

Since: primitive-0.6.4.0

Defined in Data.Primitive.SmallArray

Methods

liftCompare :: (a -> b -> Ordering) -> SmallArray a -> SmallArray b -> Ordering

Read1 SmallArray

Since: primitive-0.6.4.0

Defined in Data.Primitive.SmallArray

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (SmallArray a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [SmallArray a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (SmallArray a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [SmallArray a]

Show1 SmallArray

Since: primitive-0.6.4.0

Defined in Data.Primitive.SmallArray

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> SmallArray a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [SmallArray a] -> ShowS

MonadZip SmallArray

Defined in Data.Primitive.SmallArray

Methods

mzip :: SmallArray a -> SmallArray b -> SmallArray (a, b)

mzipWith :: (a -> b -> c) -> SmallArray a -> SmallArray b -> SmallArray c

munzip :: SmallArray (a, b) -> (SmallArray a, SmallArray b)

Alternative SmallArray

Defined in Data.Primitive.SmallArray

Methods

empty :: SmallArray a

(<|>) :: SmallArray a -> SmallArray a -> SmallArray a

some :: SmallArray a -> SmallArray [a]

many :: SmallArray a -> SmallArray [a]

MonadPlus SmallArray

Defined in Data.Primitive.SmallArray

Methods

mzero :: SmallArray a

mplus :: SmallArray a -> SmallArray a -> SmallArray a

NFData1 SmallArray

Defined in Data.Primitive.SmallArray

Methods

liftRnf :: (a -> ()) -> SmallArray a -> ()

Arr SmallArray a

Defined in Z.Data.Array

Associated Types

type MArr SmallArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr SmallArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr SmallArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> a -> m ()

indexArr :: SmallArray a -> Int -> a

indexArr' :: SmallArray a -> Int -> (#a#)

indexArrM :: Monad m => SmallArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> m (SmallArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => SmallArray a -> Int -> Int -> m (MArr SmallArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> m (SmallArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => SmallArray a -> m (MArr SmallArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> SmallArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> MArr SmallArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> MArr SmallArray s a -> Int -> Int -> m ()

cloneArr :: SmallArray a -> Int -> Int -> SmallArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> Int -> m (MArr SmallArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m (MArr SmallArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> Int -> m ()

sameMutableArr :: MArr SmallArray s a -> MArr SmallArray s a -> Bool

sizeofArr :: SmallArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr SmallArray s a -> m Int

sameArr :: SmallArray a -> SmallArray a -> Bool

Vec SmallArray a

Defined in Z.Data.Vector.Base

Associated Types

type IArray SmallArray :: Type -> Type

Methods

toArr :: SmallArray a -> (IArray SmallArray a, Int, Int)

fromArr :: IArray SmallArray a -> Int -> Int -> SmallArray a

IsList (SmallArray a)

Defined in Data.Primitive.SmallArray

Associated Types

type Item (SmallArray a) :: Type

Methods

fromList :: [Item (SmallArray a)] -> SmallArray a

fromListN :: Int -> [Item (SmallArray a)] -> SmallArray a

toList :: SmallArray a -> [Item (SmallArray a)]

Eq a => Eq (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

(==) :: SmallArray a -> SmallArray a -> Bool

(/=) :: SmallArray a -> SmallArray a -> Bool

Data a => Data (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SmallArray a -> c (SmallArray a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SmallArray a)

toConstr :: SmallArray a -> Constr

dataTypeOf :: SmallArray a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SmallArray a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SmallArray a))

gmapT :: (forall b. Data b => b -> b) -> SmallArray a -> SmallArray a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SmallArray a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SmallArray a -> r

gmapQ :: (forall d. Data d => d -> u) -> SmallArray a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SmallArray a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SmallArray a -> m (SmallArray a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SmallArray a -> m (SmallArray a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SmallArray a -> m (SmallArray a)

Ord a => Ord (SmallArray a)

Lexicographic ordering. Subject to change between major versions.

Defined in Data.Primitive.SmallArray

Methods

compare :: SmallArray a -> SmallArray a -> Ordering

(<) :: SmallArray a -> SmallArray a -> Bool

(<=) :: SmallArray a -> SmallArray a -> Bool

(>) :: SmallArray a -> SmallArray a -> Bool

(>=) :: SmallArray a -> SmallArray a -> Bool

max :: SmallArray a -> SmallArray a -> SmallArray a

min :: SmallArray a -> SmallArray a -> SmallArray a

Read a => Read (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

readsPrec :: Int -> ReadS (SmallArray a)

readList :: ReadS [SmallArray a]

readPrec :: ReadPrec (SmallArray a)

readListPrec :: ReadPrec [SmallArray a]

Show a => Show (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

showsPrec :: Int -> SmallArray a -> ShowS

show :: SmallArray a -> String

showList :: [SmallArray a] -> ShowS

Semigroup (SmallArray a)

Since: primitive-0.6.3.0

Defined in Data.Primitive.SmallArray

Methods

(<>) :: SmallArray a -> SmallArray a -> SmallArray a

sconcat :: NonEmpty (SmallArray a) -> SmallArray a

stimes :: Integral b => b -> SmallArray a -> SmallArray a

Monoid (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

mempty :: SmallArray a

mappend :: SmallArray a -> SmallArray a -> SmallArray a

mconcat :: [SmallArray a] -> SmallArray a

NFData a => NFData (SmallArray a)

Defined in Data.Primitive.SmallArray

Methods

rnf :: SmallArray a -> ()

type MArr SmallArray

Defined in Z.Data.Array

type MArr SmallArray = SmallMutableArray

type IArray SmallArray

Defined in Z.Data.Vector.Base

type IArray SmallArray = SmallArray

type Item (SmallArray a)

Defined in Data.Primitive.SmallArray

type Item (SmallArray a) = a

data SmallMutableArray s a

Constructors

SmallMutableArray (SmallMutableArray# s a)

Instances

Eq (SmallMutableArray s a)

Defined in Data.Primitive.SmallArray

Methods

(==) :: SmallMutableArray s a -> SmallMutableArray s a -> Bool

(/=) :: SmallMutableArray s a -> SmallMutableArray s a -> Bool

(Typeable s, Typeable a) => Data (SmallMutableArray s a)

Defined in Data.Primitive.SmallArray

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SmallMutableArray s a -> c (SmallMutableArray s a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (SmallMutableArray s a)

toConstr :: SmallMutableArray s a -> Constr

dataTypeOf :: SmallMutableArray s a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (SmallMutableArray s a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (SmallMutableArray s a))

gmapT :: (forall b. Data b => b -> b) -> SmallMutableArray s a -> SmallMutableArray s a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SmallMutableArray s a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SmallMutableArray s a -> r

gmapQ :: (forall d. Data d => d -> u) -> SmallMutableArray s a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SmallMutableArray s a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SmallMutableArray s a -> m (SmallMutableArray s a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SmallMutableArray s a -> m (SmallMutableArray s a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SmallMutableArray s a -> m (SmallMutableArray s a)

uninitialized :: a

Bottom value (throw (UndefinedElement "Data.Array.uninitialized")) for initialize new boxed array(Array, SmallArray..).

Primitive array type

data PrimArray a

Arrays of unboxed elements. This accepts types like Double, Char, Int, and Word, as well as their fixed-length variants (Word8, Word16, etc.). Since the elements are unboxed, a PrimArray is strict in its elements. This differs from the behavior of Array, which is lazy in its elements.

Constructors

PrimArray ByteArray#

Instances

Prim a => Arr PrimArray a

Defined in Z.Data.Array

Associated Types

type MArr PrimArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr PrimArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr PrimArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> a -> m ()

indexArr :: PrimArray a -> Int -> a

indexArr' :: PrimArray a -> Int -> (#a#)

indexArrM :: Monad m => PrimArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> m (PrimArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => PrimArray a -> Int -> Int -> m (MArr PrimArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> m (PrimArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => PrimArray a -> m (MArr PrimArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> PrimArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> MArr PrimArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> MArr PrimArray s a -> Int -> Int -> m ()

cloneArr :: PrimArray a -> Int -> Int -> PrimArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> Int -> m (MArr PrimArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m (MArr PrimArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> Int -> m ()

sameMutableArr :: MArr PrimArray s a -> MArr PrimArray s a -> Bool

sizeofArr :: PrimArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr PrimArray s a -> m Int

sameArr :: PrimArray a -> PrimArray a -> Bool

Prim a => Vec PrimArray a

Defined in Z.Data.Vector.Base

Associated Types

type IArray PrimArray :: Type -> Type

Methods

toArr :: PrimArray a -> (IArray PrimArray a, Int, Int)

fromArr :: IArray PrimArray a -> Int -> Int -> PrimArray a

Prim a => IsList (PrimArray a)

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Associated Types

type Item (PrimArray a) :: Type

Methods

fromList :: [Item (PrimArray a)] -> PrimArray a

fromListN :: Int -> [Item (PrimArray a)] -> PrimArray a

toList :: PrimArray a -> [Item (PrimArray a)]

(Eq a, Prim a) => Eq (PrimArray a)

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Methods

(==) :: PrimArray a -> PrimArray a -> Bool

(/=) :: PrimArray a -> PrimArray a -> Bool

(Ord a, Prim a) => Ord (PrimArray a)

Lexicographic ordering. Subject to change between major versions.

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Methods

compare :: PrimArray a -> PrimArray a -> Ordering

(<) :: PrimArray a -> PrimArray a -> Bool

(<=) :: PrimArray a -> PrimArray a -> Bool

(>) :: PrimArray a -> PrimArray a -> Bool

(>=) :: PrimArray a -> PrimArray a -> Bool

max :: PrimArray a -> PrimArray a -> PrimArray a

min :: PrimArray a -> PrimArray a -> PrimArray a

(Show a, Prim a) => Show (PrimArray a)

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Methods

showsPrec :: Int -> PrimArray a -> ShowS

show :: PrimArray a -> String

showList :: [PrimArray a] -> ShowS

Semigroup (PrimArray a)

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Methods

(<>) :: PrimArray a -> PrimArray a -> PrimArray a

sconcat :: NonEmpty (PrimArray a) -> PrimArray a

stimes :: Integral b => b -> PrimArray a -> PrimArray a

Monoid (PrimArray a)

Since: primitive-0.6.4.0

Defined in Data.Primitive.PrimArray

Methods

mempty :: PrimArray a

mappend :: PrimArray a -> PrimArray a -> PrimArray a

mconcat :: [PrimArray a] -> PrimArray a

NFData (PrimArray a)

Defined in Data.Primitive.PrimArray

Methods

rnf :: PrimArray a -> ()

PrimUnlifted (PrimArray a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> PrimArray a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, PrimArray a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> PrimArray a

type MArr PrimArray

Defined in Z.Data.Array

type MArr PrimArray = MutablePrimArray

type IArray PrimArray

Defined in Z.Data.Vector.Base

type IArray PrimArray = PrimArray

type Item (PrimArray a)

Defined in Data.Primitive.PrimArray

type Item (PrimArray a) = a

data MutablePrimArray s a

Mutable primitive arrays associated with a primitive state token. These can be written to and read from in a monadic context that supports sequencing such as IO or ST. Typically, a mutable primitive array will be built and then convert to an immutable primitive array using unsafeFreezePrimArray. However, it is also acceptable to simply discard a mutable primitive array since it lives in managed memory and will be garbage collected when no longer referenced.

Constructors

MutablePrimArray (MutableByteArray# s)

Instances

Eq (MutablePrimArray s a)

Defined in Data.Primitive.PrimArray

Methods

(==) :: MutablePrimArray s a -> MutablePrimArray s a -> Bool

(/=) :: MutablePrimArray s a -> MutablePrimArray s a -> Bool

NFData (MutablePrimArray s a)

Defined in Data.Primitive.PrimArray

Methods

rnf :: MutablePrimArray s a -> ()

PrimUnlifted (MutablePrimArray s a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> MutablePrimArray s a -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (#State# s0, MutablePrimArray s a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> MutablePrimArray s a

Bound checked primitive array operations

newPinnedPrimArray :: (PrimMonad m, Prim a, HasCallStack) => Int -> m (MutablePrimArray (PrimState m) a)

Create a pinned byte array of the specified size, The garbage collector is guaranteed not to move it.

newAlignedPinnedPrimArray :: (PrimMonad m, Prim a, HasCallStack) => Int -> m (MutablePrimArray (PrimState m) a)

Create a pinned primitive array of the specified size and respect given primitive type's alignment. The garbage collector is guaranteed not to move it.

copyPrimArrayToPtr :: (PrimMonad m, Prim a, HasCallStack) => Ptr a -> PrimArray a -> Int -> Int -> m ()

copyMutablePrimArrayToPtr :: (PrimMonad m, Prim a, HasCallStack) => Ptr a -> MutablePrimArray (PrimState m) a -> Int -> Int -> m ()

copyPtrToMutablePrimArray :: (PrimMonad m, Prim a, HasCallStack) => MutablePrimArray (PrimState m) a -> Int -> Ptr a -> Int -> m ()

No bound checked primitive array operations

primArrayContents :: PrimArray a -> Ptr a

Yield a pointer to the array's data. This operation is only safe on pinned prim arrays allocated by newPinnedByteArray or newAlignedPinnedByteArray.

Since: primitive-0.7.1.0

mutablePrimArrayContents :: MutablePrimArray s a -> Ptr a

Yield a pointer to the array's data. This operation is only safe on pinned byte arrays allocated by newPinnedByteArray or newAlignedPinnedByteArray.

Since: primitive-0.7.1.0

withPrimArrayContents :: PrimArray a -> (Ptr a -> IO b) -> IO b

Yield a pointer to the array's data and do computation with it.

This operation is only safe on pinned primitive arrays allocated by newPinnedPrimArray or newAlignedPinnedPrimArray.

Don't pass a forever loop to this function, see #14346.

withMutablePrimArrayContents :: MutablePrimArray RealWorld a -> (Ptr a -> IO b) -> IO b

Yield a pointer to the array's data and do computation with it.

This operation is only safe on pinned primitive arrays allocated by newPinnedPrimArray or newAlignedPinnedPrimArray.

Don't pass a forever loop to this function, see #14346.

isPrimArrayPinned :: PrimArray a -> Bool

Check whether or not the byte array is pinned. Pinned primitive arrays cannot be moved by the garbage collector. It is safe to use primArrayContents on such byte arrays. This function is only available when compiling with GHC 8.2 or newer.

Since: primitive-0.7.1.0

isMutablePrimArrayPinned :: MutablePrimArray s a -> Bool

Check whether or not the mutable primitive array is pinned. This function is only available when compiling with GHC 8.2 or newer.

Since: primitive-0.7.1.0

Unlifted array type

data UnliftedArray a

Constructors

UnliftedArray ArrayArray#

Instances

PrimUnlifted a => Arr UnliftedArray a

Defined in Z.Data.Array

Associated Types

type MArr UnliftedArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr UnliftedArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr UnliftedArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> a -> m ()

indexArr :: UnliftedArray a -> Int -> a

indexArr' :: UnliftedArray a -> Int -> (#a#)

indexArrM :: Monad m => UnliftedArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (UnliftedArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> Int -> Int -> m (MArr UnliftedArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m (UnliftedArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> m (MArr UnliftedArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> UnliftedArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

cloneArr :: UnliftedArray a -> Int -> Int -> UnliftedArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (MArr UnliftedArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m (MArr UnliftedArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m ()

sameMutableArr :: MArr UnliftedArray s a -> MArr UnliftedArray s a -> Bool

sizeofArr :: UnliftedArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m Int

sameArr :: UnliftedArray a -> UnliftedArray a -> Bool

PrimUnlifted a => Vec UnliftedArray a

Defined in Z.Data.Vector.Base

Associated Types

type IArray UnliftedArray :: Type -> Type

Methods

toArr :: UnliftedArray a -> (IArray UnliftedArray a, Int, Int)

fromArr :: IArray UnliftedArray a -> Int -> Int -> UnliftedArray a

type MArr UnliftedArray

Defined in Z.Data.Array

type MArr UnliftedArray = MutableUnliftedArray

type IArray UnliftedArray

Defined in Z.Data.Vector.Base

type IArray UnliftedArray = UnliftedArray

data MutableUnliftedArray s a

Constructors

MutableUnliftedArray (MutableArrayArray# s)

class PrimUnlifted a where

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> a

Instances

PrimUnlifted ByteArray

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> ByteArray -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, ByteArray#)

indexUnliftedArray# :: ArrayArray# -> Int# -> ByteArray

PrimUnlifted (IORef a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> IORef a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, IORef a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> IORef a

PrimUnlifted (MVar a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> MVar a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, MVar a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> MVar a

PrimUnlifted (PrimArray a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> PrimArray a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (#State# s, PrimArray a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> PrimArray a

PrimUnlifted (MutableByteArray s)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> MutableByteArray s -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (#State# s0, MutableByteArray s#)

indexUnliftedArray# :: ArrayArray# -> Int# -> MutableByteArray s

PrimUnlifted (STRef s a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> STRef s a -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (#State# s0, STRef s a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> STRef s a

PrimUnlifted (MutablePrimArray s a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> MutablePrimArray s a -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (#State# s0, MutablePrimArray s a#)

indexUnliftedArray# :: ArrayArray# -> Int# -> MutablePrimArray s a

The ArrayException type

data ArrayException

Exceptions generated by array operations

Constructors

IndexOutOfBounds String

An attempt was made to index an array outside its declared bounds.

UndefinedElement String

An attempt was made to evaluate an element of an array that had not been initialized.

Instances

Eq ArrayException

Since: base-4.2.0.0

Defined in GHC.IO.Exception

Methods

(==) :: ArrayException -> ArrayException -> Bool

(/=) :: ArrayException -> ArrayException -> Bool

Ord ArrayException

Since: base-4.2.0.0

Defined in GHC.IO.Exception

Methods

compare :: ArrayException -> ArrayException -> Ordering

(<) :: ArrayException -> ArrayException -> Bool

(<=) :: ArrayException -> ArrayException -> Bool

(>) :: ArrayException -> ArrayException -> Bool

(>=) :: ArrayException -> ArrayException -> Bool

max :: ArrayException -> ArrayException -> ArrayException

min :: ArrayException -> ArrayException -> ArrayException

Show ArrayException

Since: base-4.1.0.0

Defined in GHC.IO.Exception

Methods

showsPrec :: Int -> ArrayException -> ShowS

show :: ArrayException -> String

showList :: [ArrayException] -> ShowS

Exception ArrayException

Since: base-4.1.0.0

Defined in GHC.IO.Exception

Methods

toException :: ArrayException -> SomeException

fromException :: SomeException -> Maybe ArrayException

displayException :: ArrayException -> String