Data.Matrix.Class

Documentation

type family Mutable (m :: (* -> *) -> * -> *) :: (* -> * -> *) -> * -> * -> *

Instances

type Mutable Matrix

Defined in Data.Matrix.Generic

type Mutable Matrix = MMatrix

type Mutable CSR

mutable sparse matrix not implemented

Defined in Data.Matrix.Sparse.Generic

type Mutable CSR = MMatrix

type Mutable SymMatrix

Defined in Data.Matrix.Symmetric.Generic

type Mutable SymMatrix = SymMMatrix

class (MMatrix (Mutable m) (Mutable v) a, Vector v a) => Matrix m v a where

Minimal complete definition

dim, unsafeIndex, unsafeFromVector, thaw, unsafeThaw, freeze, unsafeFreeze

Methods

dim :: m v a -> (Int, Int)

unsafeIndex :: m v a -> (Int, Int) -> a

unsafeFromVector :: (Int, Int) -> v a -> m v a

flatten :: m v a -> v a

Default algorithm is O((m*n) * O(unsafeIndex)).

unsafeTakeRow :: m v a -> Int -> v a

Extract a row. Default algorithm is O(n * O(unsafeIndex)).

unsafeTakeColumn :: m v a -> Int -> v a

Extract a column. Default algorithm is O(m * O(unsafeIndex)).

takeDiag :: m v a -> v a

Extract the diagonal. Default algorithm is O(min(m,n) * O(unsafeIndex)).

thaw :: PrimMonad s => m v a -> s (Mutable m (Mutable v) (PrimState s) a)

unsafeThaw :: PrimMonad s => m v a -> s (Mutable m (Mutable v) (PrimState s) a)

freeze :: PrimMonad s => Mutable m (Mutable v) (PrimState s) a -> s (m v a)

unsafeFreeze :: PrimMonad s => Mutable m (Mutable v) (PrimState s) a -> s (m v a)

Instances

Vector v a => Matrix Matrix v a

Defined in Data.Matrix.Generic

Methods

dim :: Matrix v a -> (Int, Int)

unsafeIndex :: Matrix v a -> (Int, Int) -> a

unsafeFromVector :: (Int, Int) -> v a -> Matrix v a

flatten :: Matrix v a -> v a

unsafeTakeRow :: Matrix v a -> Int -> v a

unsafeTakeColumn :: Matrix v a -> Int -> v a

takeDiag :: Matrix v a -> v a

thaw :: PrimMonad s => Matrix v a -> s (Mutable Matrix (Mutable v) (PrimState s) a)

unsafeThaw :: PrimMonad s => Matrix v a -> s (Mutable Matrix (Mutable v) (PrimState s) a)

freeze :: PrimMonad s => Mutable Matrix (Mutable v) (PrimState s) a -> s (Matrix v a)

unsafeFreeze :: PrimMonad s => Mutable Matrix (Mutable v) (PrimState s) a -> s (Matrix v a)

(Zero a, Vector v a) => Matrix CSR v a

Defined in Data.Matrix.Sparse.Generic

Methods

dim :: CSR v a -> (Int, Int)

unsafeIndex :: CSR v a -> (Int, Int) -> a

unsafeFromVector :: (Int, Int) -> v a -> CSR v a

flatten :: CSR v a -> v a

unsafeTakeRow :: CSR v a -> Int -> v a

unsafeTakeColumn :: CSR v a -> Int -> v a

takeDiag :: CSR v a -> v a

thaw :: PrimMonad s => CSR v a -> s (Mutable CSR (Mutable v) (PrimState s) a)

unsafeThaw :: PrimMonad s => CSR v a -> s (Mutable CSR (Mutable v) (PrimState s) a)

freeze :: PrimMonad s => Mutable CSR (Mutable v) (PrimState s) a -> s (CSR v a)

unsafeFreeze :: PrimMonad s => Mutable CSR (Mutable v) (PrimState s) a -> s (CSR v a)

Vector v a => Matrix SymMatrix v a

Defined in Data.Matrix.Symmetric.Generic

Methods

dim :: SymMatrix v a -> (Int, Int)

unsafeIndex :: SymMatrix v a -> (Int, Int) -> a

unsafeFromVector :: (Int, Int) -> v a -> SymMatrix v a

flatten :: SymMatrix v a -> v a

unsafeTakeRow :: SymMatrix v a -> Int -> v a

unsafeTakeColumn :: SymMatrix v a -> Int -> v a

takeDiag :: SymMatrix v a -> v a

thaw :: PrimMonad s => SymMatrix v a -> s (Mutable SymMatrix (Mutable v) (PrimState s) a)

unsafeThaw :: PrimMonad s => SymMatrix v a -> s (Mutable SymMatrix (Mutable v) (PrimState s) a)

freeze :: PrimMonad s => Mutable SymMatrix (Mutable v) (PrimState s) a -> s (SymMatrix v a)

unsafeFreeze :: PrimMonad s => Mutable SymMatrix (Mutable v) (PrimState s) a -> s (SymMatrix v a)

Derived mothods

rows :: Matrix m v a => m v a -> Int

Derived methods

Return the number of rows

cols :: Matrix m v a => m v a -> Int

Return the number of columns

(!) :: Matrix m v a => m v a -> (Int, Int) -> a

Indexing

fromVector :: Matrix m v a => (Int, Int) -> v a -> m v a

fromList :: Matrix m v a => (Int, Int) -> [a] -> m v a

empty :: Matrix m v a => m v a

toList :: Matrix m v a => m v a -> [a]

O(m*n) Create a list by concatenating rows

fromLists :: Matrix m v a => [[a]] -> m v a

O(m*n) Create matrix from list of lists, it doesn't check if the list of list is a valid matrix

matrix

Arguments

:: Matrix m v a

=> Int

number of columns

-> [a]

row list

-> m v a

O(m*n) Matrix construction

fromRows :: Matrix m v a => [v a] -> m v a

O(m*n) Create matrix from rows

takeRow :: Matrix m v a => m v a -> Int -> v a

Extract a row.

toRows :: Matrix m v a => m v a -> [v a]

O(m) Return the rows

takeColumn :: Matrix m v a => m v a -> Int -> v a

Extract a row.

toColumns :: Matrix m v a => m v a -> [v a]

O(m*n) Return the columns

toLists :: Matrix m v a => m v a -> [[a]]

O(m*n) List of lists

create :: Matrix m v a => (forall s. ST s (Mutable m (Mutable v) s a)) -> m v a