Package org.flag4j.arrays.sparse

Class SparseUtils

java.lang.Object

org.flag4j.arrays.sparse.SparseUtils

final class SparseUtils
extends Object

Utility class for computations with sparse tensor, matrices, and vectors.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SparseUtils()

Method Summary

Modifier and Type	Method	Description
(package private) static boolean	CSREquals(CsrCMatrix src1, CsrCMatrix src2)	Checks if two Complex CSR Matrices are equal considering the fact that one may explicitly store zeros at some position that the other does not store.
(package private) static boolean	CSREquals(CsrMatrix src1, CsrMatrix src2)	Checks if two CSR Matrices are equal considering the fact that one may explicitly store zeros at some position that the other does not store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SparseUtils

private SparseUtils()

Method Details

CSREquals

static boolean CSREquals(CsrMatrix src1,
 CsrMatrix src2)

Checks if two CSR Matrices are equal considering the fact that one may explicitly store zeros at some position that the other does not store.

If zeros are explicitly stored at some position in only one matrix, it will be checked that the other matrix does not have a non-zero value at the same index. If it does, the matrices will not be equal. If no value is stored for that index then it is assumed to be zero by definition of the CSR format and the equality check continues with the remaining values.

Parameters:

src1 - First CSR matrix in the equality comparison.

src2 - Second CSR matrix in the equality comparison.

Returns:

True if all non-zero values stored in the two matrices are equal and occur at the same indices.

CSREquals

static boolean CSREquals(CsrCMatrix src1,
 CsrCMatrix src2)

Checks if two Complex CSR Matrices are equal considering the fact that one may explicitly store zeros at some position that the other does not store.

If zeros are explicitly stored at some position in only one matrix, it will be checked that the other matrix does not have a non-zero value at the same index. If it does, the matrices will not be equal. If no value is stored for that index then it is assumed to be zero by definition of the CSR format and the equality check continues with the remaining values.

Parameters:

src1 - First CSR matrix in the equality comparison.

src2 - Second CSR matrix in the equality comparison.

Returns:

True if all non-zero values stored in the two matrices are equal and occur at the same indices.