Jpetra.MatrixMarketIO.VectorInfo Class Reference

Public Member Functions
	VectorInfo (boolean sparse, int field)
boolean	isSparse ()
boolean	isCoordinate ()
boolean	isDense ()
boolean	isArray ()
boolean	isReal ()
boolean	isInteger ()
boolean	isComplex ()
boolean	isPattern ()
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

Detailed Description

Contains information on a vector in a variant of the Matrix Market exchange format

Constructor & Destructor Documentation

Jpetra.MatrixMarketIO.VectorInfo.VectorInfo ( boolean  sparse, int  field  )

inline

Creates a specific type

Parameters

sparse	True for sparse vectors, else false
field	Type of data stored

Member Function Documentation

boolean Jpetra.MatrixMarketIO.VectorInfo.isArray ( )

inline

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isComplex ( )

inline

Returns true if the vector stores complex numbers, else false

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isCoordinate ( )

inline

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isDense ( )

inline

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isInteger ( )

inline

Returns true if the vector stores integers, else false

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isPattern ( )

inline

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

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isReal ( )

inline

Returns true if the vector stores real numbers, else false

References Jpetra.MatrixMarketIO.VectorInfo.REAL.

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

boolean Jpetra.MatrixMarketIO.VectorInfo.isSparse ( )

inline

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

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

String Jpetra.MatrixMarketIO.VectorInfo.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 vector coordinate real

References Jpetra.MatrixMarketIO.VectorInfo.isComplex(), Jpetra.MatrixMarketIO.VectorInfo.isInteger(), Jpetra.MatrixMarketIO.VectorInfo.isPattern(), Jpetra.MatrixMarketIO.VectorInfo.isReal(), and Jpetra.MatrixMarketIO.VectorInfo.isSparse().

Member Data Documentation

final int Jpetra.MatrixMarketIO.VectorInfo.REAL = 0

static

What kind of numbers are stored

Referenced by Jpetra.MatrixMarketIO.VectorInfo.isReal(), and Jpetra.MatrixMarketIO.MatrixVectorReader.readVectorInfo().

---

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

• VectorInfo.java