Package org.flag4j.operations.sparse.csr.real

Class RealCsrEquals

java.lang.Object

org.flag4j.operations.sparse.csr.real.RealCsrEquals

public final class RealCsrEquals
extends Object

This class contains methods to check equality or approximate equality between two sparse CSR matrices.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RealCsrEquals()

Method Summary

Modifier and Type	Method	Description
static boolean	allClose(CsrMatrix src1, CsrMatrix src2, double relTol, double absTol)	Checks if all entries of this tensor are close to the entries of the argument tensor.
private static void	removeCloseToZero(CsrMatrix src, List<Double> entries, int[] rowPointers, List<Integer> colIndices, double aTol)	Removes entries in src which are within atol in absolute value from zero.

Methods inherited from class java.lang.Object

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

Constructor Details

RealCsrEquals

private RealCsrEquals()

Method Details

allClose

public static boolean allClose(CsrMatrix src1,
 CsrMatrix src2,
 double relTol,
 double absTol)

Checks if all entries of this tensor are close to the entries of the argument tensor.

Parameters:

src1 - First matrix in the comparison.

src2 - Second matrix in the comparison.

relTol - Relative tolerance.

absTol - Absolute tolerance.

Returns:

True if the src1 matrix is the same shape as the src2 matrix and all entries are 'close', i.e. elements a and b at the same positions in the two matrices respectively satisfy |a-b| <= (absTol + relTol*|b|). Otherwise, returns false.

removeCloseToZero

private static void removeCloseToZero(CsrMatrix src,
 List<Double> entries,
 int[] rowPointers,
 List<Integer> colIndices,
 double aTol)

Removes entries in src which are within atol in absolute value from zero.

Parameters:

src - Source CSR matrix.

entries - List to store value in src which are not within atol in absolute value from zero.

rowPointers - Row pointers for entries.

colIndices - Column indices of entries.

aTol - Absolute tolerance for value to be considered close to zero.