Data.MatrixMarket

Pure and composable Matrix Market reader and writer.

Usage example:

 rm <- readMM `liftM` readFile "my-real-matrix.mtx" :: IO (ReadMatrix Double)
 case rm of
   Right m -> -- Do something with the matrix m
   Left err -> -- Report error

Data types

data MValue a => Matrix a

Matrix Market format representation.

Constructors

MM

Fields

mm'data :: MatrixData a

mm'field :: MField

mm'symmetry :: Symmetry

mm'comments :: [String]

Instances

MValue a => Eq (Matrix a)

MValue a => Show (Matrix a)

data MValue a => MatrixData a

Matrix' data block.

Constructors

CoordinateM

Fields

coords'm :: CM a

ArrayM

Fields

array'm :: AM a

Instances

MValue a => Eq (MatrixData a)

MValue a => Show (MatrixData a)

class (Num a, Show a) => MValue a where

Values allowed in the Matrix Market files.

Methods

typename :: a -> String

readval :: [String] -> Maybe a

showval :: a -> String

conj :: a -> a

Instances

MValue Double

MValue Int

MValue (Complex Double)

data MField

Field of the matrix.

Constructors

MInt

MReal

MComplex

MPattern

Instances

Eq MField

Show MField

data Symmetry

Symmetry class of the matrix.

Constructors

General

Symmetric

SkewSymmetric

Hermitian

Instances

Eq Symmetry

Show Symmetry

data MValue a => CM a

Coordinate format (sparse matrix).

Constructors

CM

Fields

cm'rows :: Int

cm'cols :: Int

cm'size :: Int

cm'values :: [((Int, Int), a)]

Instances

MValue a => Eq (CM a)

MValue a => Show (CM a)

data MValue a => AM a

Array format (dense matrix).

Constructors

AM

Fields

am'rows :: Int

am'cols :: Int

am'values :: [a]

Instances

MValue a => Eq (AM a)

MValue a => Show (AM a)

data ReadError

Parsing errors.

Constructors

NotAMatrixMarketFormat

InvalidHeader String

UnknownFormat String

UnexpectedField String

UnknownSymmetry String

NoParse

Instances

Eq ReadError

Show ReadError

type ReadMatrix a = Either ReadError (Matrix a)

Use this type synonym to specify the type of readMM when calling.

Read and write Matrix Market

readMM :: MValue a => String -> ReadMatrix a

Parse Matrix Market format.

dumpMM :: MValue a => Matrix a -> String

Write Matrix Market format.

Utility functions

mm'rows :: MValue a => Matrix a -> Int

Number of rows in the matrix.

mm'cols :: MValue a => Matrix a -> Int

Number of columns in the matrix.

mm'shape :: MValue a => Matrix a -> (Int, Int)

Dimensions of the matrix: (number of rows, number of columns).

toList :: MValue a => Matrix a -> [((Int, Int), a)]

Construct a list of non-zero entries (without symmetric entries).

toCompleteList :: MValue a => Matrix a -> [((Int, Int), a)]

Construct a list of all non-zero entries (including symmetric entries).

toArray

Arguments

:: (IArray arr a, MValue a)

=> Int

array starting index, usually 0 or 1

-> Matrix a

matrix to convert

-> arr (Int, Int) a

Convert to an immutable dense array.

toArrayM

Arguments

:: (MArray arr a m, MValue a)

=> Int

array starting index, usually 0 or 1

-> Matrix a

matrix to convert

-> m (arr (Int, Int) a)

Convert to a mutable dense array.

at :: MValue a => Matrix a -> (Int, Int) -> a

Get an element of the matrix at the specified position. Warning: This operation is slow, use toArray or toArrayM to convert to an array first.

Re-exports

data RealFloat a => Complex a

Complex numbers are an algebraic type.

For a complex number z, abs z is a number with the magnitude of z, but oriented in the positive real direction, whereas signum z has the phase of z, but unit magnitude.

Constructors

!a :+ !a

forms a complex number from its real and imaginary rectangular components.

Instances

Typeable1 Complex

RealFloat a => Eq (Complex a)

RealFloat a => Floating (Complex a)

RealFloat a => Fractional (Complex a)

(Data a, RealFloat a) => Data (Complex a)

RealFloat a => Num (Complex a)

(Read a, RealFloat a) => Read (Complex a)

RealFloat a => Show (Complex a)

MValue (Complex Double)