Package org.ejml.dense.row.decompose.chol

Class CholeskyDecompositionCommon_ZDRM

  • All Implemented Interfaces:
    org.ejml.interfaces.decomposition.CholeskyDecomposition<org.ejml.data.ZMatrixRMaj>, org.ejml.interfaces.decomposition.CholeskyDecomposition_F64<org.ejml.data.ZMatrixRMaj>, org.ejml.interfaces.decomposition.DecompositionInterface<org.ejml.data.ZMatrixRMaj>
    Direct Known Subclasses:
    CholeskyDecompositionInner_ZDRM
    public abstract class CholeskyDecompositionCommon_ZDRM
extends java.lang.Object
implements org.ejml.interfaces.decomposition.CholeskyDecomposition_F64<org.ejml.data.ZMatrixRMaj>

    This is an abstract class for a Cholesky decomposition. It provides the solvers, but the actual decomposition is provided in other classes.

    See Also:
    CholeskyDecomposition_F64

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.ejml.data.Complex_F64 det  
      protected boolean lower  
      protected int n  
      protected double[] t  
      protected org.ejml.data.ZMatrixRMaj T  

    • Constructor Summary

      Constructors 
      Constructor Description
      CholeskyDecompositionCommon_ZDRM​(boolean lower)
      Specifies if a lower or upper variant should be constructed.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.ejml.data.ZMatrixRMaj _getT()
      Returns the raw decomposed matrix.
      org.ejml.data.Complex_F64 computeDeterminant()  
      boolean decompose​(org.ejml.data.ZMatrixRMaj mat)
      protected abstract boolean decomposeLower()
      Performs an lower triangular decomposition.
      protected abstract boolean decomposeUpper()
      Performs an upper triangular decomposition.
      org.ejml.data.ZMatrixRMaj getT​(org.ejml.data.ZMatrixRMaj T)  
      boolean inputModified()  
      boolean isLower()

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • n

        protected int n

      • T

        protected org.ejml.data.ZMatrixRMaj T

      • t

        protected double[] t

      • lower

        protected boolean lower

      • det

        protected org.ejml.data.Complex_F64 det

    • Constructor Detail

      • CholeskyDecompositionCommon_ZDRM

        public CholeskyDecompositionCommon_ZDRM​(boolean lower)
        Specifies if a lower or upper variant should be constructed.
        Parameters:
        lower - should a lower or upper triangular matrix be used.

    • Method Detail

      • isLower

        public boolean isLower()
        Specified by:
        isLower in interface org.ejml.interfaces.decomposition.CholeskyDecomposition<org.ejml.data.ZMatrixRMaj>

      • decompose

        public boolean decompose​(org.ejml.data.ZMatrixRMaj mat)
        Specified by:
        decompose in interface org.ejml.interfaces.decomposition.DecompositionInterface<org.ejml.data.ZMatrixRMaj>

      • inputModified

        public boolean inputModified()
        Specified by:
        inputModified in interface org.ejml.interfaces.decomposition.DecompositionInterface<org.ejml.data.ZMatrixRMaj>

      • decomposeLower

        protected abstract boolean decomposeLower()
        Performs an lower triangular decomposition.
        Returns:
        true if the matrix was decomposed.

      • decomposeUpper

        protected abstract boolean decomposeUpper()
        Performs an upper triangular decomposition.
        Returns:
        true if the matrix was decomposed.

      • getT

        public org.ejml.data.ZMatrixRMaj getT​(org.ejml.data.ZMatrixRMaj T)
        Specified by:
        getT in interface org.ejml.interfaces.decomposition.CholeskyDecomposition<org.ejml.data.ZMatrixRMaj>

      • _getT

        public org.ejml.data.ZMatrixRMaj _getT()
        Returns the raw decomposed matrix.
        Returns:
        A lower or upper triangular matrix.

      • computeDeterminant

        public org.ejml.data.Complex_F64 computeDeterminant()
        Specified by:
        computeDeterminant in interface org.ejml.interfaces.decomposition.CholeskyDecomposition_F64<org.ejml.data.ZMatrixRMaj>