Package org.ejml.dense.row.decomposition.eig

Class SymmetricQRAlgorithmDecomposition_FDRM

java.lang.Object
org.ejml.dense.row.decomposition.eig.SymmetricQRAlgorithmDecomposition_FDRM
All Implemented Interfaces:
DecompositionInterface<FMatrixRMaj>, EigenDecomposition<FMatrixRMaj>, EigenDecomposition_F32<FMatrixRMaj>
@Generated("org.ejml.dense.row.decomposition.eig.SymmetricQRAlgorithmDecomposition_DDRM") public class SymmetricQRAlgorithmDecomposition_FDRM extends Object implements EigenDecomposition_F32<FMatrixRMaj>

Computes the eigenvalues and eigenvectors of a real symmetric matrix using the symmetric implicit QR algorithm. Inside each iteration a QR decomposition of Ai-piI is implicitly computed.

This implementation is based on the algorithm is sketched out in:
David S. Watkins, "Fundamentals of Matrix Computations," Second Edition. page 377-385

See Also:

  • Constructor Details

    • SymmetricQRAlgorithmDecomposition_FDRM

      public SymmetricQRAlgorithmDecomposition_FDRM(TridiagonalSimilarDecomposition_F32<FMatrixRMaj> decomp, boolean computeVectors)

    • SymmetricQRAlgorithmDecomposition_FDRM

      public SymmetricQRAlgorithmDecomposition_FDRM(boolean computeVectors)

  • Method Details

    • setComputeVectorsWithValues

      public void setComputeVectorsWithValues(boolean computeVectorsWithValues)

    • setMaxIterations

      public void setMaxIterations(int max)
      Used to limit the number of internal QR iterations that the QR algorithm performs. 20 should be enough for most applications.
      Parameters:
      max - The maximum number of QR iterations it will perform.

    • getNumberOfEigenvalues

      public int getNumberOfEigenvalues()
      Description copied from interface: EigenDecomposition
      Returns the number of eigenvalues/eigenvectors. This is the matrix's dimension.
      Specified by:
      getNumberOfEigenvalues in interface EigenDecomposition<FMatrixRMaj>
      Returns:
      number of eigenvalues/eigenvectors.

    • getEigenvalue

      public Complex_F32 getEigenvalue(int index)
      Description copied from interface: EigenDecomposition_F32

      Returns an eigenvalue as a complex number. For symmetric matrices the returned eigenvalue will always be a real number, which means the imaginary component will be equal to zero.

      NOTE: The order of the eigenvalues is dependent upon the decomposition algorithm used. This means that they may or may not be ordered by magnitude. For example the QR algorithm will returns results that are partially ordered by magnitude, but this behavior should not be relied upon.

      Specified by:
      getEigenvalue in interface EigenDecomposition_F32<FMatrixRMaj>
      Parameters:
      index - Index of the eigenvalue eigenvector pair.
      Returns:
      An eigenvalue.

    • getEigenVector

      public FMatrixRMaj getEigenVector(int index)
      Description copied from interface: EigenDecomposition

      Used to retrieve real valued eigenvectors. If an eigenvector is associated with a complex eigenvalue then null is returned instead.

      Specified by:
      getEigenVector in interface EigenDecomposition<FMatrixRMaj>
      Parameters:
      index - Index of the eigenvalue eigenvector pair.
      Returns:
      If the associated eigenvalue is real then an eigenvector is returned, null otherwise.

    • decompose

      public boolean decompose(FMatrixRMaj orig)
      Decomposes the matrix using the QR algorithm. Care was taken to minimize unnecessary memory copying and cache skipping.
      Specified by:
      decompose in interface DecompositionInterface<FMatrixRMaj>
      Parameters:
      orig - The matrix which is being decomposed. Not modified.
      Returns:
      true if it decomposed the matrix or false if an error was detected. This will not catch all errors.

    • inputModified

      public boolean inputModified()
      Description copied from interface: DecompositionInterface
      Checks if the input matrix to DecompositionInterface.decompose(org.ejml.data.Matrix) is modified during the decomposition process.
      Specified by:
      inputModified in interface DecompositionInterface<FMatrixRMaj>
      Returns:
      true if the input matrix to decompose() is modified.