Data.Eigen.Matrix.Mutable

Documentation

data MMatrix a b s

Mutable matrix. You can modify elements

Constructors

MMatrix

Fields

mm_rows :: Int

mm_cols :: Int

mm_vals :: MVector s b

type MMatrixXf = MMatrix Float CFloat

Alias for single precision mutable matrix

type MMatrixXd = MMatrix Double CDouble

Alias for double precision mutable matrix

type MMatrixXcf = MMatrix (Complex Float) (CComplex CFloat)

Alias for single previsiom mutable matrix of complex numbers

type MMatrixXcd = MMatrix (Complex Double) (CComplex CDouble)

Alias for double prevision mutable matrix of complex numbers

type IOMatrix a b = MMatrix a b RealWorld

type STMatrix a b s = MMatrix a b s

Construction

new :: (PrimMonad m, Elem a b) => Int -> Int -> m (MMatrix a b (PrimState m))

Create a mutable matrix of the given size and fill it with 0 as an initial value.

replicate :: (PrimMonad m, Elem a b) => Int -> Int -> a -> m (MMatrix a b (PrimState m))

Create a mutable matrix of the given size and fill it with as an initial value.

Consistency check

valid :: Elem a b => MMatrix a b s -> Bool

Verify matrix dimensions and memory layout

Accessing individual elements

read :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> Int -> Int -> m a

Yield the element at the given position.

write :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> Int -> Int -> a -> m ()

Replace the element at the given position.

unsafeRead :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> Int -> Int -> m a

Yield the element at the given position. No bounds checks are performed.

unsafeWrite :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> Int -> Int -> a -> m ()

Replace the element at the given position. No bounds checks are performed.

Modifying matrices

set :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> a -> m ()

Set all elements of the matrix to the given value

copy :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> MMatrix a b (PrimState m) -> m ()

Copy a matrix. The two matrices must have the same size and may not overlap.

unsafeCopy :: (PrimMonad m, Elem a b) => MMatrix a b (PrimState m) -> MMatrix a b (PrimState m) -> m ()

Copy a matrix. The two matrices must have the same size and may not overlap however no bounds check performaned to it may SEGFAULT for incorrect input.

Raw pointers

unsafeWith :: Elem a b => IOMatrix a b -> (Ptr b -> CInt -> CInt -> IO c) -> IO c

Pass a pointer to the matrix's data to the IO action. Modifying data through the pointer is unsafe if the matrix could have been frozen before the modification.