Data.Massiv.Array.Manifest.Vector

Documentation

fromVectorM

Arguments

:: (MonadThrow m, Typeable v, Vector v a, Mutable (ARepr v) ix a, Construct r ix a, Mutable r ix a)

=> Comp

-> Sz ix

Resulting size of the array

-> v a

Source Vector

-> m (Array r ix a)

In case when resulting array representation matches the one of vector's it will do a O(1) - conversion using castFromVector, otherwise Vector elements will be copied into a new array. Will throw an error if length of resulting array doesn't match the source vector length.

Since: 0.3.0

fromVector'

Arguments

:: (Typeable v, Vector v a, Mutable (ARepr v) ix a, Construct r ix a, Mutable r ix a)

=> Comp

-> Sz ix

Resulting size of the array

-> v a

Source Vector

-> Array r ix a

Just like fromVectorM, but will throw an exception on a mismatched size.

Since: 0.3.0

fromVector

Arguments

:: (Typeable v, Vector v a, Mutable (ARepr v) ix a, Construct r ix a, Mutable r ix a)

=> Comp

-> Sz ix

Resulting size of the array

-> v a

Source Vector

-> Array r ix a

Deprecated: In favor of safer fromVectorM

castFromVector

Arguments

:: (Vector v e, Typeable v, Mutable r ix e, ARepr v ~ r)

=> Comp

-> Sz ix

Size of the result Array

-> v e

Source Vector

-> Maybe (Array r ix e)

O(1) - conversion from vector to an array with a corresponding representation. Will return Nothing if there is a size mismatch, vector has been sliced before or if some non-standard vector type is supplied.

toVector :: forall r ix e v. (Manifest r ix e, Mutable (ARepr v) ix e, Vector v e, VRepr (ARepr v) ~ v) => Array r ix e -> v e

Convert an array into a vector. Will perform a cast if resulting vector is of compatible representation, otherwise memory copy will occur.

Examples

In this example a Storable Array is created and then casted into a Storable Vector in costant time:

>>> import Data.Massiv.Array as A
>>> import qualified Data.Vector.Storable as VS
>>> toVector (makeArrayR S Par (Sz2 5 6) (\(i :. j) -> i + j)) :: VS.Vector Int
[0,1,2,3,4,5,1,2,3,4,5,6,2,3,4,5,6,7,3,4,5,6,7,8,4,5,6,7,8,9]

While in this example Storable Array will first be converted into Unboxed representation in Parallel and only after that will be coverted into Unboxed Vector in constant time.

>>> import qualified Data.Vector.Unboxed as VU
>>> toVector (makeArrayR S Par (Sz2 5 6) (\(i :. j) -> i + j)) :: VU.Vector Int
[0,1,2,3,4,5,1,2,3,4,5,6,2,3,4,5,6,7,3,4,5,6,7,8,4,5,6,7,8,9]

castToVector :: forall v r ix e. (Mutable r ix e, VRepr r ~ v) => Array r ix e -> Maybe (v e)

O(1) - conversion from Mutable array to a corresponding vector. Will return Nothing only if source array representation was not one of B, N, P, S or U.

type family ARepr (v :: * -> *) :: * where ...

Match vector type to array representation

Equations

ARepr Vector = U

ARepr Vector = S

ARepr Vector = P

ARepr Vector = B

type family VRepr r :: * -> * where ...

Match array representation to a vector type

Equations

VRepr U = Vector

VRepr S = Vector

VRepr P = Vector

VRepr B = Vector

VRepr N = Vector