Package org.ejml.ops

Class MatrixFeatures_F

java.lang.Object

org.ejml.ops.MatrixFeatures_F

public class MatrixFeatures_F
extends java.lang.Object

Generic (slow) matrix features for real matrices

Constructor Summary

Constructors

Constructor	Description
MatrixFeatures_F()

Method Summary

Modifier and Type	Method	Description
static boolean	isEquals(FMatrix a, FMatrix b)	Checks to see if each element in the two matrices are equal: aij == bij
static boolean	isIdentical(FMatrix a, FMatrix b, float tol)	Checks to see if each corresponding element in the two matrices are within tolerance of each other or have the some symbolic meaning.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatrixFeatures_F

public MatrixFeatures_F()

Method Detail

isEquals

public static boolean isEquals(FMatrix a,
                               FMatrix b)

Checks to see if each element in the two matrices are equal: a_ij == b_ij

NOTE: If any of the elements are NaN then false is returned. If two corresponding elements are both positive or negative infinity then they are equal.

Parameters:

a - A matrix. Not modified.

b - A matrix. Not modified.

Returns:

true if identical and false otherwise.

isIdentical

public static boolean isIdentical(FMatrix a,
                                  FMatrix b,
                                  float tol)

Checks to see if each corresponding element in the two matrices are within tolerance of each other or have the some symbolic meaning. This can handle NaN and Infinite numbers.

If both elements are countable then the following equality test is used:
|a_ij - b_ij| ≤ tol.
Otherwise both numbers must both be Float.NaN, Float.POSITIVE_INFINITY, or Float.NEGATIVE_INFINITY to be identical.

Parameters:

a - A matrix. Not modified.

b - A matrix. Not modified.

tol - Tolerance for equality.

Returns:

true if identical and false otherwise.