Module flag4j

Package org.flag4j.arrays.backend

Record Class SparseVectorData<T>

java.lang.Object

java.lang.Record

org.flag4j.arrays.backend.SparseVectorData<T>

public record SparseVectorData<T>(List<T> entries, List<Integer> indices)
extends Record

Data class for storing information for a sparse COO vector.

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

Field Summary

Fields

Modifier and Type	Field	Description
private final List<T>	entries	The field for the entries record component.
private final List<Integer>	indices	The field for the indices record component.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<T>	entries()	Returns the value of the entries 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.
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

Field Details

entries

private final List<T> entries

The field for the entries record component.

indices

private final List<Integer> indices

The field for the indices record component.

Constructor Details

SparseVectorData

public SparseVectorData(List<T> entries,
 List<Integer> indices)

Creates an instance of a SparseVectorData record class.

Parameters:

entries - the value for the entries record component

indices - the value for the indices record component

Method Details

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.

entries

public List<T> entries()

Returns the value of the entries record component.

Returns:

the value of the entries record component

indices

public List<Integer> indices()

Returns the value of the indices record component.

Returns:

the value of the indices record component