Record Class SparseMatrixData<T>

java.lang.Object

java.lang.Record

org.flag4j.arrays.SparseMatrixData<T>

Type Parameters:

T - Type of the data of the matrix.

Record Components:

shape - Shape of the matrix.

data - Non-zero data of the sparse matrix.

rowData - Non-zero row indices/pointers.

colData - Non-zero column indices.

public record SparseMatrixData<T>(Shape shape, List<T> data, List<Integer> rowData, List<Integer> colData)
extends Record

Data class for storing information for a sparse (CSR or COO) matrix.

This record stores three lists: the non-zero data, the row indices/pointers, and the column indices.

Constructor Summary

Constructors

Constructor	Description
SparseMatrixData(Shape shape, List<T> data, List<Integer> rowData, List<Integer> colData)	Creates an instance of a SparseMatrixData record class.

Method Summary

Modifier and Type	Method	Description
List<Integer>	colData()	Returns the value of the colData record component.
int[]	colIndicesToArray()	Converts the column indices of this sparse matrix data to a primitive integer array.
List<T>	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<Integer>	rowData()	Returns the value of the rowData record component.
int[]	rowIndicesToArray()	Converts the row indices of this sparse matrix data to a primitive integer array.
Shape	shape()	Returns the value of the shape record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

SparseMatrixData

public SparseMatrixData(Shape shape,
 List<T> data,
 List<Integer> rowData,
 List<Integer> colData)

Creates an instance of a SparseMatrixData record class.

Parameters:

shape - the value for the shape record component

data - the value for the data record component

rowData - the value for the rowData record component

colData - the value for the colData record component

Method Details

rowIndicesToArray

public int[] rowIndicesToArray()

Converts the row indices of this sparse matrix data to a primitive integer array.

Returns:

A primitive integer array containing the row indices of this sparse matrix data.

colIndicesToArray

public int[] colIndicesToArray()

Converts the column indices of this sparse matrix data to a primitive integer array.

Returns:

A primitive integer array containing the column indices of this sparse matrix data.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

shape

public Shape shape()

Returns the value of the shape record component.

Returns:

the value of the shape record component

data

public List<T> data()

Returns the value of the data record component.

Returns:

the value of the data record component

rowData

public List<Integer> rowData()

Returns the value of the rowData record component.

Returns:

the value of the rowData record component

colData

public List<Integer> colData()

Returns the value of the colData record component.

Returns:

the value of the colData record component