Control.Imperative.Vector.Static

Documentation

An efficient array which has two features.

• Automatic switching unboxed and boxed arrays.
• Multi-dimension support

There are two basic operation exported from the Control.Imperative module.

ref

O(1). return the element of a vector at the given index.

assign

O(1). replace the element at the given index.

Types

data Vector m n a

Instances

PrimMonad m => Indexable (Ref m (Vector m (S (S n)) a))

(VectorElem a, PrimMonad m) => Indexable (Ref m (Vector m (S Z) a))

Monad m => HasVector (Ref m (Vector m n a)) (Vector m n a) m

PrimMonad m => Indexable (Vector m (S (S n)) a)

(VectorElem a, PrimMonad m) => Indexable (Vector m (S Z) a)

Monad m => HasVector (Vector m n a) (Vector m n a) m

type Element (Ref m (Vector m (S (S n)) a)) = Ref m (Vector m (S n) a)

type Element (Ref m (Vector m (S Z) a)) = Ref m a

type IndexType (Ref m (Vector m (S (S n)) a)) = Int

type IndexType (Ref m (Vector m (S Z) a)) = Int

type Element (Vector m (S (S n)) a) = Ref m (Vector m (S n) a)

type Element (Vector m (S Z) a) = Ref m a

type IndexType (Vector m (S (S n)) a) = Int

type IndexType (Vector m (S Z) a) = Int

type MonadVector m = (MonadBase (BaseEff m) m, PrimMonad (BaseEff m))

Useful constraint synonym for vector operations.

type VectorElem a = MVector (VectorEntity a) a

type family VectorEntity a :: * -> * -> *

Equations

VectorEntity Bool = MVector

VectorEntity Char = MVector

VectorEntity Double = MVector

VectorEntity Float = MVector

VectorEntity Int = MVector

VectorEntity Int8 = MVector

VectorEntity Int16 = MVector

VectorEntity Int32 = MVector

VectorEntity Int64 = MVector

VectorEntity Word = MVector

VectorEntity Word8 = MVector

VectorEntity Word16 = MVector

VectorEntity Word32 = MVector

VectorEntity Word64 = MVector

VectorEntity () = MVector

VectorEntity a = MVector

class Monad m => HasVector s v m | s -> v, s -> m

Minimal complete definition

getVector

Instances

Monad m => HasVector (Ref m (Vector m n a)) (Vector m n a) m

Monad m => HasVector (Vector m n a) (Vector m n a) m

type family NestedList n a

Equations

NestedList Z a = a

NestedList (S n) a = [NestedList n a]

data Size n where

A sized-list type for specify the size of array.

Constructors

One :: Size Z

(:*:) :: !Int -> Size n -> Size (S n) infixr 5

data Dim n

Specialized Proxy type.

Constructors

Dim

dim1 :: Dim (S Z)

dim2 :: Dim (S (S Z))

dim3 :: Dim (S (S (S Z)))

Operations

newSized :: (VectorElem a, MonadVector m) => Size (S n) -> m (Vector (BaseEff m) (S n) a)

O(n). Create a vector of the given length.

newSized' :: (VectorElem a, MonadVector m) => Size (S n) -> a -> m (Vector (BaseEff m) (S n) a)

O(n). Create a vector filled with an initial value.

length :: (VectorElem a, HasVector s (Vector (BaseEff m) (S n) a) (BaseEff m), MonadVector m) => s -> m Int

O(1). The number of elements in the vector.

size :: (VectorElem a, HasVector s (Vector (BaseEff m) (S n) a) (BaseEff m), MonadVector m) => s -> m Int

Short alias for length.

fromListN

Arguments

:: (VectorElem a, MonadVector m)

=> Size (S n)

sizes of vector

-> NestedList (S n) a

nested list

-> m (Vector (BaseEff m) (S n) a)

O(n). Build a vector from a nested list.

toList :: (VectorElem a, HasVector s (Vector (BaseEff m) (S n) a) (BaseEff m), MonadVector m) => s -> m (NestedList (S n) a)

O(n). Convert the vector to a nested list.