Jpetra.MatrixMarketIO.MatrixInfo Class Reference

Public Member Functions
	MatrixInfo (boolean sparse, int field, int symmetry)
boolean	isSparse ()
boolean	isCoordinate ()
boolean	isDense ()
boolean	isArray ()
boolean	isReal ()
boolean	isInteger ()
boolean	isComplex ()
boolean	isPattern ()
boolean	isGeneral ()
boolean	isSymmetric ()
boolean	isSkewSymmetric ()
boolean	isHermitian ()
String	toString ()

Static Public Attributes
static final int	REAL = 0
static final int	INTEGER = 1
static final int	COMPLEX = 2
static final int	PATTERN = 3
static final int	GENERAL = 4
static final int	SYMMETRIC = 5
static final int	SKEWSYMMETRIC = 6
static final int	HERMITIAN = 7

Detailed Description

Contains information on a matrix in the Matrix Market exchange format. Supports all valid matrices.

Constructor & Destructor Documentation

Jpetra.MatrixMarketIO.MatrixInfo.MatrixInfo ( boolean  sparse, int  field, int  symmetry  )

inline

Creates a specific type

Parameters

sparse	True for sparse matrices, else false
field	Type of data stored
symmetry	Matrix symmetry

Member Function Documentation

boolean Jpetra.MatrixMarketIO.MatrixInfo.isArray ( )

inline

Returns true if the matrix is in array format, else false

boolean Jpetra.MatrixMarketIO.MatrixInfo.isComplex ( )

inline

Returns true if the matrix stores complex numbers, else false

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isCoordinate ( )

inline

Returns true if the matrix is in coordinate format, else false

boolean Jpetra.MatrixMarketIO.MatrixInfo.isDense ( )

inline

Returns true if the matrix is in array format, else false

Referenced by Jpetra.MatrixMarketIO.MatrixSize.MatrixSize().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isGeneral ( )

inline

Returns true if the matrix form is general, else false

References Jpetra.MatrixMarketIO.MatrixInfo.GENERAL.

Referenced by Jpetra.MatrixMarketIO.MatrixSize.MatrixSize(), and Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isHermitian ( )

inline

Returns true if the matrix is Hermitian, else false

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isInteger ( )

inline

Returns true if the matrix stores integers, else false

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isPattern ( )

inline

Returns true if the matrix does not store any numbers, else false

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isReal ( )

inline

Returns true if the matrix stores real numbers, else false

References Jpetra.MatrixMarketIO.MatrixInfo.REAL.

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isSkewSymmetric ( )

inline

Returns true if the matrix is skew-symmetrical, else false

Referenced by Jpetra.MatrixMarketIO.MatrixSize.MatrixSize(), and Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isSparse ( )

inline

Returns true if the matrix is in coordinate format, else false

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.toString().

boolean Jpetra.MatrixMarketIO.MatrixInfo.isSymmetric ( )

inline

Returns true if the matrix is symmetrical, else false

Referenced by Jpetra.MatrixMarketIO.MatrixSize.MatrixSize(), and Jpetra.MatrixMarketIO.MatrixInfo.toString().

String Jpetra.MatrixMarketIO.MatrixInfo.toString ( )

inline

Returns a string representation of the specifier. Can be used to provide a header for writing to a file. It is a two-line output, which can look like this:

 %MatrixMarket matrix coordinate real general

References Jpetra.MatrixMarketIO.MatrixInfo.isComplex(), Jpetra.MatrixMarketIO.MatrixInfo.isGeneral(), Jpetra.MatrixMarketIO.MatrixInfo.isHermitian(), Jpetra.MatrixMarketIO.MatrixInfo.isInteger(), Jpetra.MatrixMarketIO.MatrixInfo.isPattern(), Jpetra.MatrixMarketIO.MatrixInfo.isReal(), Jpetra.MatrixMarketIO.MatrixInfo.isSkewSymmetric(), Jpetra.MatrixMarketIO.MatrixInfo.isSparse(), and Jpetra.MatrixMarketIO.MatrixInfo.isSymmetric().

Member Data Documentation

final int Jpetra.MatrixMarketIO.MatrixInfo.GENERAL = 4

static

Symmetry structure of the matrix, if any

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.isGeneral(), and Jpetra.MatrixMarketIO.MatrixVectorReader.readMatrixInfo().

final int Jpetra.MatrixMarketIO.MatrixInfo.REAL = 0

static

What kind of numbers are stored

Referenced by Jpetra.MatrixMarketIO.MatrixInfo.isReal(), and Jpetra.MatrixMarketIO.MatrixVectorReader.readMatrixInfo().

---

The documentation for this class was generated from the following file:

• MatrixInfo.java