Data.Matrix.MatrixMarket

attoparsec-based parser and serializer for the NIST MatrixMarket format [1]. The parser logic originally appeared in accelerate-examples and it is reused here (courtesy of T.McDonell and the accelerate developers) with some amendments.

References :

1. https://math.nist.gov/MatrixMarket/

Load

Matrix

readMatrix :: FilePath -> IO (Matrix Scientific)

Load a matrix (sparse, i.e. in Coordinate format) from file.

Uses readMatrix' internally

readMatrix' :: MonadThrow m => ByteString -> m (Matrix Scientific)

Deserialize a matrix (sparse, i.e. in Coordinate format) from a lazy ByteString.

Throws a FileParseError if the input cannot be parsed

Array

readArray :: FilePath -> IO (Array Scientific)

Load a dense matrix (i.e. a matrix or vector in Array format) from file.

Uses readArray' internally

readArray' :: MonadThrow m => ByteString -> m (Array Scientific)

Deserialize a dense matrix (i.e. a matrix or vector in Array format) from a lazy ByteString.

Throws a FileParseError if the input cannot be parsed

Save

Matrix

writeMatrix :: Show b => FilePath -> Matrix b -> IO ()

Store a sparse matrix in Coordinate format to a file.

Uses writeMatrix' internally

writeMatrix' :: (MonadThrow m, Show b) => Matrix b -> m ByteString

Serialize a sparse matrix in Coordinate format into a ByteString.

Throws a FormatExportNotSupported if the user tries to serialize a PatternMatrix value.

Array

writeArray :: Show a => FilePath -> Array a -> IO ()

Write a dense matrix from the Array format into a file.

Uses writeArray' internally.

writeArray' :: Show a => Array a -> ByteString

Serialize a dense matrix from the Array format into a ByteString

Types

data Matrix a

Sparse matrix in coordinate form (row, column, entry) NB: indices are 1-based i.e. A(1,1) is the top-left entry of matrix A

Constructors

RMatrix (Int, Int) Int Structure [(Int, Int, a)]

CMatrix (Int, Int) Int Structure [(Int, Int, Complex a)]

PatternMatrix (Int, Int) Int Structure [(Int32, Int32)]

IntMatrix (Int, Int) Int Structure [(Int32, Int32, Int)]

Instances

Eq a => Eq (Matrix a)

Defined in Data.Matrix.MatrixMarket.Internal

Methods

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

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

Show a => Show (Matrix a)

Defined in Data.Matrix.MatrixMarket.Internal

Methods

showsPrec :: Int -> Matrix a -> ShowS

show :: Matrix a -> String

showList :: [Matrix a] -> ShowS

data Array a

Array, i.e. a DENSE matrix (also used to represent vectors as n-by-1 matrices)

Constructors

RArray (Int, Int) Structure [a]

CArray (Int, Int) Structure [Complex a]

Instances

Eq a => Eq (Array a)

Defined in Data.Matrix.MatrixMarket.Internal

Methods

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

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

Show a => Show (Array a)

Defined in Data.Matrix.MatrixMarket.Internal

Methods

showsPrec :: Int -> Array a -> ShowS

show :: Array a -> String

showList :: [Array a] -> ShowS

data Format

Specifies either sparse or dense storage. In sparse ("coordinate") storage, elements are given in (i,j,x) triplets for matrices (or (i,x) for vectors). Indices are 1-based, so that A(1,1) is the first element of a matrix, and x(1) is the first element of a vector.

In dense ("array") storage, elements are given in column-major order.

In both cases, each element is given on a separate line.

Constructors

Coordinate

Array

Instances

Eq Format

Defined in Data.Matrix.MatrixMarket.Internal

Methods

(==) :: Format -> Format -> Bool

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

Show Format

Defined in Data.Matrix.MatrixMarket.Internal

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

data Structure

Specifies any special structure in the matrix. For symmetric and hermitian matrices, only the lower-triangular part of the matrix is given. For skew matrices, only the entries below the diagonal are stored.

Constructors

General

Symmetric

Hermitian

Skew

Instances

Eq Structure

Defined in Data.Matrix.MatrixMarket.Internal

Methods

(==) :: Structure -> Structure -> Bool

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

Show Structure

Defined in Data.Matrix.MatrixMarket.Internal

Methods

showsPrec :: Int -> Structure -> ShowS

show :: Structure -> String

showList :: [Structure] -> ShowS

Helpers

Matrix-related

nnz :: Matrix t -> Int

Number of matrix nonzeros

dim :: Matrix t -> (Int, Int)

Matrix size : number of rows, number of columns

numDat :: Matrix t -> Int

Length of data vector internal to the Matrix; this is _not_ necessarily the actual number of matrix entries because symmetric entries are not stored

Array-related

dimArr :: Array t -> (Int, Int)

Array size : number of rows, number of columns

numDatArr :: Array a -> Int

Length of data vector internal to the Array; this is _not_ necessarily the actual number of matrix entries because symmetric entries are not stored

Exceptions

data ImportError

Exceptions related to loading/importing data

Constructors

FileParseError String String

Instances

Eq ImportError

Defined in Control.Exception.Common

Methods

(==) :: ImportError -> ImportError -> Bool

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

Show ImportError

Defined in Control.Exception.Common

Methods

showsPrec :: Int -> ImportError -> ShowS

show :: ImportError -> String

showList :: [ImportError] -> ShowS

Exception ImportError

Defined in Control.Exception.Common

Methods

toException :: ImportError -> SomeException

fromException :: SomeException -> Maybe ImportError

displayException :: ImportError -> String

data ExportError

Exceptions related to serializing/storing data

Constructors

FormatExportNotSupported String String

Instances

Eq ExportError

Defined in Control.Exception.Common

Methods

(==) :: ExportError -> ExportError -> Bool

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

Show ExportError

Defined in Control.Exception.Common

Methods

showsPrec :: Int -> ExportError -> ShowS

show :: ExportError -> String

showList :: [ExportError] -> ShowS

Exception ExportError

Defined in Control.Exception.Common

Methods

toException :: ExportError -> SomeException

fromException :: SomeException -> Maybe ExportError

displayException :: ExportError -> String