Package org.ejml

Class EjmlUnitTests

java.lang.Object

org.ejml.EjmlUnitTests

public class EjmlUnitTests
extends java.lang.Object

Contains various functions related to unit testing matrix operations.

Constructor Summary

Constructors

Constructor	Description
EjmlUnitTests()

Method Summary

Modifier and Type	Method	Description
static void	assertCountable(DMatrix A)	Checks to see if every element in A is countable.
static void	assertEquals(CMatrix A, CMatrix B, float tol)
static void	assertEquals(Complex_F32 a, Complex_F32 b, float tol)
static void	assertEquals(Complex_F64 a, Complex_F64 b, double tol)
static void	assertEquals(DMatrix A, DMatrix B, double tol)	Checks to see if each element in the matrices are within tolerance of each other and countable:
static void	assertEquals(FMatrix A, FMatrix B, float tol)
static void	assertEquals(Matrix A, Matrix B)
static void	assertEquals(ZMatrix A, ZMatrix B, double tol)
static void	assertEqualsTrans(DMatrix A, DMatrix B, double tol)	Checks to see if the transpose of B is equal to A and countable:
static void	assertEqualsTrans(FMatrix A, FMatrix B, double tol)
static void	assertEqualsUncountable(DMatrix A, DMatrix B, double tol)	Checks to see if each element in the matrix is within tolerance of each other:
static void	assertRelativeEquals(DMatrix expected, DMatrix found, double tol)	Assert equals with a relative error
static void	assertRelativeEquals(FMatrix expected, FMatrix found, double tol)	Assert equals with a relative error
static void	assertShape(Matrix A, int numRows, int numCols)	Checks to see if the matrix has the specified number of rows and columns.
static void	assertShape(Matrix A, Matrix B)	Checks to see if A and B have the same shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

EjmlUnitTests

public EjmlUnitTests()

Method Detail

assertCountable

public static void assertCountable(DMatrix A)

Checks to see if every element in A is countable. A doesn't have any element with a value of NaN or infinite.

Parameters:

A - Matrix

assertShape

public static void assertShape(Matrix A,
                               Matrix B)

Checks to see if A and B have the same shape.

Parameters:

A - Matrix

B - Matrix

assertShape

public static void assertShape(Matrix A,
                               int numRows,
                               int numCols)

Checks to see if the matrix has the specified number of rows and columns.

Parameters:

A - Matrix

numRows - expected number of rows in the matrix

numCols - expected number of columns in the matrix

assertEqualsUncountable

public static void assertEqualsUncountable(DMatrix A,
                                           DMatrix B,
                                           double tol)

Checks to see if each element in the matrix is within tolerance of each other:

The two matrices are identical with in tolerance if:
|a_ij - b_ij| ≤ tol

In addition if an element is NaN or infinite in one matrix it must be the same in the other.

Parameters:

A - Matrix A

B - Matrix B

tol - Tolerance

assertEquals

public static void assertEquals(Matrix A,
                                Matrix B)

assertEquals

public static void assertEquals(DMatrix A,
                                DMatrix B,
                                double tol)

Checks to see if each element in the matrices are within tolerance of each other and countable:

The two matrices are identical with in tolerance if:
|a_ij - b_ij| ≤ tol

The test will fail if any element in either matrix is NaN or infinite.

Parameters:

A - Matrix A

B - Matrix B

tol - Tolerance

assertRelativeEquals

public static void assertRelativeEquals(DMatrix expected,
                                        DMatrix found,
                                        double tol)

Assert equals with a relative error

assertRelativeEquals

public static void assertRelativeEquals(FMatrix expected,
                                        FMatrix found,
                                        double tol)

Assert equals with a relative error

assertEquals

public static void assertEquals(FMatrix A,
                                FMatrix B,
                                float tol)

assertEquals

public static void assertEquals(Complex_F64 a,
                                Complex_F64 b,
                                double tol)

assertEquals

public static void assertEquals(Complex_F32 a,
                                Complex_F32 b,
                                float tol)

assertEquals

public static void assertEquals(ZMatrix A,
                                ZMatrix B,
                                double tol)

assertEquals

public static void assertEquals(CMatrix A,
                                CMatrix B,
                                float tol)

assertEqualsTrans

public static void assertEqualsTrans(DMatrix A,
                                     DMatrix B,
                                     double tol)

Checks to see if the transpose of B is equal to A and countable:

|a_ij - b_ji| ≤ tol

The test will fail if any element in either matrix is NaN or infinite.

Parameters:

A - Matrix A

B - Matrix B

tol - Tolerance

assertEqualsTrans

public static void assertEqualsTrans(FMatrix A,
                                     FMatrix B,
                                     double tol)