Record Class SparseVectorData<T>

java.lang.Object

java.lang.Record

org.flag4j.arrays.SparseVectorData<T>

Record Components:

shape - Shape of the vector.

data - Non-zero data of the sparse COO vector.

indices - Non-zero indices of the sparse COO vector.

public record SparseVectorData<T>(Shape shape, List<T> data, List<Integer> indices)
extends Record

Data class for storing information for a sparse COO vector.

This record stores two lists: the non-zero data and the indices of the vector.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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>	indices()	Returns the value of the indices record component.
int[]	indicesToArray()	Converts the indices of this sparse vector 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

SparseVectorData

public SparseVectorData(Shape shape,
 List<T> data,
 List<Integer> indices)

Creates an instance of a SparseVectorData record class.

Parameters:

shape - the value for the shape record component

data - the value for the data record component

indices - the value for the indices record component

Method Details

indicesToArray

public int[] indicesToArray()

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

Returns:

A primitive integer array containing the indices of this sparse vector 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

indices

public List<Integer> indices()

Returns the value of the indices record component.

Returns:

the value of the indices record component