Package org.ejml.sparse.csc

Class MatrixFeatures_FSCC

  • public class MatrixFeatures_FSCC
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean hasUncountable​(org.ejml.data.FMatrixSparseCSC A)  
      static boolean isEquals​(org.ejml.data.FMatrixSparseCSC a, org.ejml.data.FMatrixSparseCSC b)  
      static boolean isEquals​(org.ejml.data.FMatrixSparseCSC a, org.ejml.data.FMatrixSparseCSC b, float tol)  
      static boolean isEqualsSort​(org.ejml.data.FMatrixSparseCSC a, org.ejml.data.FMatrixSparseCSC b, float tol)  
      static boolean isIdenticalSort​(org.ejml.data.FMatrixSparseCSC a, org.ejml.data.FMatrixSparseCSC b, float tol)  
      static boolean isIdentity​(org.ejml.data.FMatrixSparseCSC A, float tol)  
      static boolean isLowerTriangle​(org.ejml.data.FMatrixSparseCSC A, int hessenberg, float tol)
      Checks to see if a matrix is lower triangular or Hessenberg.
      static boolean isOrthogonal​(org.ejml.data.FMatrixSparseCSC Q, float tol)
      Checks to see if a matrix is orthogonal or isometric.
      static boolean isPositiveDefinite​(org.ejml.data.FMatrixSparseCSC A)
      Checks to see if the matrix is positive definite.
      static boolean isSameStructure​(org.ejml.data.FMatrixSparseCSC a, org.ejml.data.FMatrixSparseCSC b)
      Checks to see if the two matrices have the same shape and same pattern of non-zero elements
      static boolean isSymmetric​(org.ejml.data.FMatrixSparseCSC A, float tol)
      Checks to see if the matrix is symmetric to within tolerance.
      static boolean isTranspose​(org.ejml.data.FMatrixSparseCSC A, org.ejml.data.FMatrixSparseCSC B, float tol)  
      static boolean isVector​(org.ejml.data.FMatrixSparseCSC a)
      Returns true if the input is a vector
      static boolean isZeros​(org.ejml.data.FMatrixSparseCSC A, float tol)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MatrixFeatures_FSCC

        public MatrixFeatures_FSCC()

    • Method Detail

      • isEquals

        public static boolean isEquals​(org.ejml.data.FMatrixSparseCSC a,
                               org.ejml.data.FMatrixSparseCSC b)

      • isEquals

        public static boolean isEquals​(org.ejml.data.FMatrixSparseCSC a,
                               org.ejml.data.FMatrixSparseCSC b,
                               float tol)

      • isEqualsSort

        public static boolean isEqualsSort​(org.ejml.data.FMatrixSparseCSC a,
                                   org.ejml.data.FMatrixSparseCSC b,
                                   float tol)

      • isIdenticalSort

        public static boolean isIdenticalSort​(org.ejml.data.FMatrixSparseCSC a,
                                      org.ejml.data.FMatrixSparseCSC b,
                                      float tol)

      • isSameStructure

        public static boolean isSameStructure​(org.ejml.data.FMatrixSparseCSC a,
                                      org.ejml.data.FMatrixSparseCSC b)
        Checks to see if the two matrices have the same shape and same pattern of non-zero elements
        Parameters:
        a - Matrix
        b - Matrix
        Returns:
        true if the structure is the same

      • hasUncountable

        public static boolean hasUncountable​(org.ejml.data.FMatrixSparseCSC A)

      • isZeros

        public static boolean isZeros​(org.ejml.data.FMatrixSparseCSC A,
                              float tol)

      • isIdentity

        public static boolean isIdentity​(org.ejml.data.FMatrixSparseCSC A,
                                 float tol)

      • isLowerTriangle

        public static boolean isLowerTriangle​(org.ejml.data.FMatrixSparseCSC A,
                                      int hessenberg,
                                      float tol)

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

        aij ≤ 0 for all i < j+N

        A triangular matrix is a Hessenberg matrix of degree 0. Only the upper most diagonal elements are explicitly checked to see if they are non-zero

        Parameters:
        A - Matrix being tested. Not modified.
        hessenberg - The degree of being hessenberg.
        tol - How not zero diagonal elements must be.
        Returns:
        If it is an upper triangular/hessenberg matrix or not.

      • isTranspose

        public static boolean isTranspose​(org.ejml.data.FMatrixSparseCSC A,
                                  org.ejml.data.FMatrixSparseCSC B,
                                  float tol)

      • isVector

        public static boolean isVector​(org.ejml.data.FMatrixSparseCSC a)
        Returns true if the input is a vector
        Parameters:
        a - A matrix or vector
        Returns:
        true if it's a vector. Column or row.

      • isSymmetric

        public static boolean isSymmetric​(org.ejml.data.FMatrixSparseCSC A,
                                  float tol)
        Checks to see if the matrix is symmetric to within tolerance.
        Parameters:
        A - Matrix being tested. Not modified.
        tol - Tolerance that defines how similar two values must be to be considered identical
        Returns:
        true if symmetric or false if not

      • isPositiveDefinite

        public static boolean isPositiveDefinite​(org.ejml.data.FMatrixSparseCSC A)

        Checks to see if the matrix is positive definite.

        xT A x > 0
        for all x where x is a non-zero vector and A is a symmetric matrix.

        Parameters:
        A - square symmetric matrix. Not modified.
        Returns:
        True if it is positive definite and false if it is not.

      • isOrthogonal

        public static boolean isOrthogonal​(org.ejml.data.FMatrixSparseCSC Q,
                                   float tol)

        Checks to see if a matrix is orthogonal or isometric.

        Parameters:
        Q - The matrix being tested. Not modified.
        tol - Tolerance.
        Returns:
        True if it passes the test.