Package org.flag4j.operations.common

Class TensorEquals

java.lang.Object

org.flag4j.operations.common.TensorEquals

public final class TensorEquals
extends Object

Utility class for determining if arbitrary pairs of tensors are equal. Could be a real dense tensor and a sparse complex matrix, if they have the same shape and entries, then they are considered equal.

Field Summary

Fields

Modifier and Type	Field	Description
private static final HashMap<String,BiFunction<CTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>>	complexDenseLookUp
private static final HashMap<String,BiFunction<CooCTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>>	complexSparseLookUp
private static final HashMap<String,BiFunction<Tensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>>	realDenseLookUp
private static final HashMap<String,BiFunction<CooTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>>	realSparseLookUp

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TensorEquals()

Method Summary

Modifier and Type	Method	Description
private static TensorBase<?,?,?,?,?,?,?>	ensureTensor(TensorBase<?,?,?,?,?,?,?> src)	Converts a tensor to an explicit tensor if it is a vector or matrix.
private static boolean	generalEquals(CTensor A, DenseTensorBase<?,?,?,?,?> B)	Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
private static boolean	generalEquals(CTensor A, SparseTensorBase<?,?,?,?,?,?,?> B)	Checks if a complex dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
private static boolean	generalEquals(Tensor A, DenseTensorBase<?,?,?,?,?> B)	Checks if a real dense tensor is equal to any dense tensor (including Matrix, CMatrix, Vector, etc.).
private static boolean	generalEquals(Tensor A, SparseTensorBase<?,?,?,?,?,?,?> B)	Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
private static boolean	generalEquals(CooCTensor A, SparseTensorBase<?,?,?,?,?,?,?> B)	Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
private static boolean	generalEquals(CooTensor A, SparseTensorBase<?,?,?,?,?,?,?> B)	Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
private static boolean	generalEquals(DenseTensorBase<?,?,?,?,?> A, SparseTensorBase<?,?,?,?,?,?,?> B)	Checks if a dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).
static boolean	generalEquals(TensorBase<?,?,?,?,?,?,?> A, TensorBase<?,?,?,?,?,?,?> B)	Checks if two arbitrary tensors are equal regardless implementation (e.g.

Methods inherited from class java.lang.Object

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

Field Details

realDenseLookUp

private static final HashMap<String,BiFunction<Tensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>> realDenseLookUp

complexDenseLookUp

private static final HashMap<String,BiFunction<CTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>> complexDenseLookUp

realSparseLookUp

private static final HashMap<String,BiFunction<CooTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>> realSparseLookUp

complexSparseLookUp

private static final HashMap<String,BiFunction<CooCTensor,SparseTensorBase<?,?,?,?,?,?,?>,Boolean>> complexSparseLookUp

Constructor Details

TensorEquals

private TensorEquals()

Method Details

generalEquals

public static boolean generalEquals(TensorBase<?,?,?,?,?,?,?> A,
 TensorBase<?,?,?,?,?,?,?> B)

Checks if two arbitrary tensors are equal regardless implementation (e.g. any combination of real, complex, dense and sparse). Tensors do not need to be the same type and for the purposes of this method, matrices and vectors are considered tensors.

Parameters:

A - First tensor in equality comparison.

B - Second tensor in equality comparison.

Returns:

True if both tensors have the same shape and are element-wise equal.

ensureTensor

private static TensorBase<?,?,?,?,?,?,?> ensureTensor(TensorBase<?,?,?,?,?,?,?> src)

Converts a tensor to an explicit tensor if it is a vector or matrix.

Parameters:

src - Tensor to convert to an explicit tensor.

Returns:

Returns src if it is already a tensor. Otherwise, i.e. src is a matrix or vector, returns an explicit tensor equivalent to src.

generalEquals

private static boolean generalEquals(Tensor A,
 DenseTensorBase<?,?,?,?,?> B)

Checks if a real dense tensor is equal to any dense tensor (including Matrix, CMatrix, Vector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(CTensor A,
 DenseTensorBase<?,?,?,?,?> B)

Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(DenseTensorBase<?,?,?,?,?> A,
 SparseTensorBase<?,?,?,?,?,?,?> B)

Checks if a dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(Tensor A,
 SparseTensorBase<?,?,?,?,?,?,?> B)

Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(CTensor A,
 SparseTensorBase<?,?,?,?,?,?,?> B)

Checks if a complex dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(CooTensor A,
 SparseTensorBase<?,?,?,?,?,?,?> B)

Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.

generalEquals

private static boolean generalEquals(CooCTensor A,
 SparseTensorBase<?,?,?,?,?,?,?> B)

Checks if a real dense tensor is equal to any sparse tensor (including CooMatrix, CsrMatrix, CooCMatrix, CsrCMatrix, CooVector, etc.).

Parameters:

A - Real dense tensor.

B - Sparse tensor.

Returns:

True if the two matrices are element-wise equivalent.