Package org.flag4j.core

Interface TensorComparisonsMixin

All Known Implementing Classes:

CMatrix, ComplexDenseTensorBase, ComplexSparseTensorBase, CooCMatrix, CooCTensor, CooCVector, CooMatrix, CooTensor, CooVector, CsrCMatrix, CsrMatrix, CTensor, CVector, DenseTensorBase, Matrix, RealDenseTensorBase, RealSparseTensorBase, SparseTensorBase, Tensor, TensorBase, Vector

public interface TensorComparisonsMixin

This interface specifies comparisons which all tensors (i.e. matrices and vectors) should implement.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object B)	Checks if this tensor is equal to a specified Object.
boolean	isOnes()	Checks if this tensor only contains ones.
boolean	isZeros()	Checks if this tensor only contains zeros.
boolean	tensorEquals(TensorBase<?,?,?,?,?,?,?> B)	Checks if two tensors are equal.

Method Details

isZeros

boolean isZeros()

Checks if this tensor only contains zeros.

Returns:

True if this tensor only contains zeros. Otherwise, returns false.

isOnes

boolean isOnes()

Checks if this tensor only contains ones.

Returns:

True if this tensor only contains ones. Otherwise, returns false.

equals

boolean equals(Object B)

Checks if this tensor is equal to a specified Object. Note, this method differs from tensorEquals(TensorBase) as, in this method, the types of the objects must match where in tensorEquals(TensorBase) the typed need not match.

Overrides:

equals in class Object

Parameters:

B - Object to compare this tensor to.

Returns:

True if B is the same object type as this tensor, has the same shape, and each element of the two tensors are numerically equal. Otherwise, returns false.

tensorEquals

boolean tensorEquals(TensorBase<?,?,?,?,?,?,?> B)

Checks if two tensors are equal. Note, this method is much more permissive than equals(Object) as it allows for comparisons with any tensor, matrix, or vector. If the shapes are equal and entries are element-wise equivalent then this method returns true regardless of the types of the two tensors.

xFor Example, a Dense Tensor of rank 2 with the same values as a

Sparse CSR Matrix will be considered equal.

Parameters:

B - Tensor, matrix, or vector to compare to this tensor.

Returns:

True if both tensors (or matrix/vector) have the same shape and all entries are numerically equivalent by index. This accounts for possible zero values in sparse objects. Returns false if the tensors do not have the same shape or if the tensors differ in value at any index.