org.ejml.ops

Class CMatrixFeatures

java.lang.Object

org.ejml.ops.CMatrixFeatures

public class CMatrixFeatures
extends java.lang.Object

Functions for computing the features of complex matrices

Constructor Summary

Constructors

Constructor and Description
CMatrixFeatures()

Method Summary

Modifier and Type	Method and Description
static boolean	hasNaN(org.ejml.data.CD1Matrix64F m) Checks to see if any element in the matrix is NaN.
static boolean	hasUncountable(org.ejml.data.CD1Matrix64F m) Checks to see if any element in the matrix is NaN of Infinite.
static boolean	isEquals(org.ejml.data.CD1Matrix64F a, org.ejml.data.CD1Matrix64F b) Checks to see if each element in the two matrices are equal: aij == bij
static boolean	isEquals(org.ejml.data.CD1Matrix64F a, org.ejml.data.CD1Matrix64F b, double tol) Checks to see if each element in the two matrices are within tolerance of each other: tol ≥ |aij - bij|.
static boolean	isHermitian(org.ejml.data.CDenseMatrix64F Q, double tol) Hermitian matrix is a square matrix with complex entries that are equal to its own conjugate transpose.
static boolean	isIdentical(org.ejml.data.CD1Matrix64F a, org.ejml.data.CD1Matrix64F b, double tol) Checks to see if each corresponding element in the two matrices are within tolerance of each other or have the some symbolic meaning.
static boolean	isIdentity(org.ejml.data.ComplexMatrix64F mat, double tol) Checks to see if the provided matrix is within tolerance to an identity matrix.
static boolean	isLowerTriangle(org.ejml.data.CDenseMatrix64F A, int hessenberg, double tol) Checks to see if a matrix is lower triangular or Hessenberg.
static boolean	isNegative(org.ejml.data.CD1Matrix64F a, org.ejml.data.CD1Matrix64F b, double tol) Checks to see if the two matrices are the negative of each other: aij = -bij
static boolean	isPositiveDefinite(org.ejml.data.CDenseMatrix64F A) Checks to see if the matrix is positive definite.
static boolean	isUnitary(org.ejml.data.CDenseMatrix64F Q, double tol) Unitary matrices have the following properties: Q*QH = I
static boolean	isUpperTriangle(org.ejml.data.CDenseMatrix64F A, int hessenberg, double tol) Checks to see if a matrix is upper triangular or Hessenberg.
static boolean	isVector(org.ejml.data.Matrix mat) Checks to see if the matrix is a vector or not.
static boolean	isZeros(org.ejml.data.CD1Matrix64F m, double tol) Checks to see all the elements in the matrix are zeros

Methods inherited from class java.lang.Object

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

Constructor Detail

CMatrixFeatures

public CMatrixFeatures()

Method Detail

isVector

public static boolean isVector(org.ejml.data.Matrix mat)

Checks to see if the matrix is a vector or not.

Parameters:

mat - A matrix. Not modified.

Returns:

True if it is a vector and false if it is not.

isNegative

public static boolean isNegative(org.ejml.data.CD1Matrix64F a,
                                 org.ejml.data.CD1Matrix64F b,
                                 double tol)

Checks to see if the two matrices are the negative of each other:

a_ij = -b_ij

Parameters:

a - First matrix. Not modified.

b - Second matrix. Not modified.

tol - Numerical tolerance.

Returns:

True if they are the negative of each other within tolerance.

hasNaN

public static boolean hasNaN(org.ejml.data.CD1Matrix64F m)

Checks to see if any element in the matrix is NaN.

Parameters:

m - A matrix. Not modified.

Returns:

True if any element in the matrix is NaN.

hasUncountable

public static boolean hasUncountable(org.ejml.data.CD1Matrix64F m)

Checks to see if any element in the matrix is NaN of Infinite.

Parameters:

m - A matrix. Not modified.

Returns:

True if any element in the matrix is NaN of Infinite.

isEquals

public static boolean isEquals(org.ejml.data.CD1Matrix64F a,
                               org.ejml.data.CD1Matrix64F 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.

isEquals

public static boolean isEquals(org.ejml.data.CD1Matrix64F a,
                               org.ejml.data.CD1Matrix64F b,
                               double tol)

Checks to see if each element in the two matrices are within tolerance of each other: tol ≥ |a_ij - b_ij|.

NOTE: If any of the elements are not countable then false is returned.
NOTE: If a tolerance of zero is passed in this is equivalent to calling isEquals(org.ejml.data.CD1Matrix64F, org.ejml.data.CD1Matrix64F)

Parameters:

a - A matrix. Not modified.

b - A matrix. Not modified.

tol - How close to being identical each element needs to be.

Returns:

true if equals and false otherwise.

isIdentical

public static boolean isIdentical(org.ejml.data.CD1Matrix64F a,
                                  org.ejml.data.CD1Matrix64F b,
                                  double 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 Double.NaN, Double.POSITIVE_INFINITY, or Double.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.

isIdentity

public static boolean isIdentity(org.ejml.data.ComplexMatrix64F mat,
                                 double tol)

Checks to see if the provided matrix is within tolerance to an identity matrix.

Parameters:

mat - Matrix being examined. Not modified.

tol - Tolerance.

Returns:

True if it is within tolerance to an identify matrix.

isHermitian

public static boolean isHermitian(org.ejml.data.CDenseMatrix64F Q,
                                  double tol)

Hermitian matrix is a square matrix with complex entries that are equal to its own conjugate transpose.

a[i,j] = conj(a[j,i])

Parameters:

Q - The matrix being tested. Not modified.

tol - Tolerance.

Returns:

True if it passes the test.

isUnitary

public static boolean isUnitary(org.ejml.data.CDenseMatrix64F Q,
                                double tol)

Unitary matrices have the following properties:

Q*Q^H = I

This is the complex equivalent of orthogonal matrix.

Parameters:

Q - The matrix being tested. Not modified.

tol - Tolerance.

Returns:

True if it passes the test.

isPositiveDefinite

public static boolean isPositiveDefinite(org.ejml.data.CDenseMatrix64F A)

Checks to see if the matrix is positive definite.

x^T A x > 0
for all x where x is a non-zero vector and A is a hermitian matrix.

Parameters:

A - square hermitian matrix. Not modified.

Returns:

True if it is positive definite and false if it is not.

isUpperTriangle

public static boolean isUpperTriangle(org.ejml.data.CDenseMatrix64F A,
                                      int hessenberg,
                                      double tol)

Checks to see if a matrix is upper triangular or Hessenberg. A Hessenberg matrix of degree N has the following property:

a_ij ≤ 0 for all i < j+N

A triangular matrix is a Hessenberg matrix of degree 0.

Parameters:

A - Matrix being tested. Not modified.

hessenberg - The degree of being hessenberg.

tol - How close to zero the lower left elements need to be.

Returns:

If it is an upper triangular/hessenberg matrix or not.

isLowerTriangle

public static boolean isLowerTriangle(org.ejml.data.CDenseMatrix64F A,
                                      int hessenberg,
                                      double tol)

Checks to see if a matrix is lower triangular or Hessenberg. A Hessenberg matrix of degree N has the following property:

a_ij ≤ 0 for all i < j+N

A triangular matrix is a Hessenberg matrix of degree 0.

Parameters:

A - Matrix being tested. Not modified.

hessenberg - The degree of being hessenberg.

tol - How close to zero the lower left elements need to be.

Returns:

If it is an upper triangular/hessenberg matrix or not.

isZeros

public static boolean isZeros(org.ejml.data.CD1Matrix64F m,
                              double tol)

Checks to see all the elements in the matrix are zeros

Parameters:

m - A matrix. Not modified.

Returns:

True if all elements are zeros or false if not