Record Class MatrixMarketHeader

java.lang.Object

java.lang.Record

org.flag4j.io.MatrixMarketHeader

Record Components:

object - The type of object the Matrix Market file contains (e.g. matrix or vector).

format - The format of the data the Matrix Market file contains (e.g. array (dense) or coordinate (sparse COO)).

field - The field the elements belong to in the Matrix Market file (e.g. real, integer, or complex).

symmetry - The symmetry of the data in the Matrix Market file (e.g. general, symmetric, skew-symmetric, Hermitian).

comments - Comments to prepend to file after the main header.

public record MatrixMarketHeader(MatrixMarketHeader.MMObject object, MatrixMarketHeader.MMFormat format, MatrixMarketHeader.MMField field, MatrixMarketHeader.MMSymmetry symmetry, String[] comments)
extends Record

A data record for storing the tokens of a Matrix Market Exchange Format file header. Valid tokens for each modifier are defined by the following enums:

• MatrixMarketHeader.MMObject - Valid object types in the Matrix Market file.
• MatrixMarketHeader.MMFormat - Valid formats in the Matrix Market file.
• MatrixMarketHeader.MMField - Valid field types in the Matrix Market file.
• MatrixMarketHeader.MMSymmetry - Valid symmetries in the Matrix Market file.

See Also:

• MatrixMarketReader
• MatrixMarketWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MatrixMarketHeader.MMField	Enum containing valid field types in a Matrix Market file.
static enum	MatrixMarketHeader.MMFormat	Enum containing valid formats in a Matrix Market file.
static enum	MatrixMarketHeader.MMObject	Enum containing valid object types in a Matrix Market file.
static enum	MatrixMarketHeader.MMSymmetry	Enum containing valid symmetry in a Matrix Market file.

Constructor Summary

Constructors

Constructor	Description
MatrixMarketHeader(MatrixMarketHeader.MMObject object, MatrixMarketHeader.MMFormat format, MatrixMarketHeader.MMField field, MatrixMarketHeader.MMSymmetry symmetry, String... comments)	Creates an instance of a MatrixMarketHeader record class.

Method Summary

Modifier and Type	Method	Description
String[]	comments()	Returns the value of the comments record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
MatrixMarketHeader.MMField	field()	Returns the value of the field record component.
MatrixMarketHeader.MMFormat	format()	Returns the value of the format record component.
final int	hashCode()	Returns a hash code value for this object.
MatrixMarketHeader.MMObject	object()	Returns the value of the object record component.
static MatrixMarketHeader	parseHeader(String header)	Parses a string representing the header of a Matrix Market file and stores in a MatrixMarketHeader object.
MatrixMarketHeader.MMSymmetry	symmetry()	Returns the value of the symmetry record component.
String	toString()	The String representation of this Matrix Market Exchange Format header.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MatrixMarketHeader

public MatrixMarketHeader(MatrixMarketHeader.MMObject object,
 MatrixMarketHeader.MMFormat format,
 MatrixMarketHeader.MMField field,
 MatrixMarketHeader.MMSymmetry symmetry,
 String... comments)

Creates an instance of a MatrixMarketHeader record class.

Parameters:

object - the value for the object record component

format - the value for the format record component

field - the value for the field record component

symmetry - the value for the symmetry record component

comments - the value for the comments record component

Method Details

parseHeader

public static MatrixMarketHeader parseHeader(String header)

Parses a string representing the header of a Matrix Market file and stores in a MatrixMarketHeader object.

Parameters:

header - String containing the header, and only the header, of the Matrix Market file.

Returns:

A MatrixMarketHeader object containing information about the Matrix Market object type, format, field type, and symmetry.

toString

public String toString()

The String representation of this Matrix Market Exchange Format header.

Specified by:

toString in class Record

Returns:

This Matrix Market Exchange Format header as a string.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

object

public MatrixMarketHeader.MMObject object()

Returns the value of the object record component.

Returns:

the value of the object record component

format

public MatrixMarketHeader.MMFormat format()

Returns the value of the format record component.

Returns:

the value of the format record component

field

public MatrixMarketHeader.MMField field()

Returns the value of the field record component.

Returns:

the value of the field record component

symmetry

public MatrixMarketHeader.MMSymmetry symmetry()

Returns the value of the symmetry record component.

Returns:

the value of the symmetry record component

comments

public String[] comments()

Returns the value of the comments record component.

Returns:

the value of the comments record component