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

Class CholeskyDecompositionCommon_CDRM

java.lang.Object
org.ejml.dense.row.decompose.chol.CholeskyDecompositionCommon_CDRM
All Implemented Interfaces:
org.ejml.interfaces.decomposition.CholeskyDecomposition<org.ejml.data.CMatrixRMaj>, org.ejml.interfaces.decomposition.CholeskyDecomposition_F32<org.ejml.data.CMatrixRMaj>, org.ejml.interfaces.decomposition.DecompositionInterface<org.ejml.data.CMatrixRMaj>
Direct Known Subclasses:
CholeskyDecompositionInner_CDRM
@Generated("org.ejml.dense.row.decompose.chol.CholeskyDecompositionCommon_ZDRM")
public abstract class CholeskyDecompositionCommon_CDRM
extends Object
implements org.ejml.interfaces.decomposition.CholeskyDecomposition_F32<org.ejml.data.CMatrixRMaj>

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_F32

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected org.ejml.data.Complex_F32 det  
    protected boolean lower  
    protected int n  
    protected float[] t  
    protected org.ejml.data.CMatrixRMaj T  

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    org.ejml.data.CMatrixRMaj _getT()
    Returns the raw decomposed matrix.
    org.ejml.data.Complex_F32 computeDeterminant()  
    boolean decompose​(org.ejml.data.CMatrixRMaj mat)
    protected abstract boolean decomposeLower()
    Performs an lower triangular decomposition.
    protected abstract boolean decomposeUpper()
    Performs an upper triangular decomposition.
    org.ejml.data.CMatrixRMaj getT​(@Nullable org.ejml.data.CMatrixRMaj T)  
    boolean inputModified()  
    boolean isLower()

    Methods inherited from class java.lang.Object

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

  • Field Details

    • n

      protected int n

    • T

      protected org.ejml.data.CMatrixRMaj T

    • t

      protected float[] t

    • lower

      protected boolean lower

    • det

      protected org.ejml.data.Complex_F32 det

  • Constructor Details

    • CholeskyDecompositionCommon_CDRM

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

  • Method Details

    • isLower

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

    • decompose

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

    • inputModified

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

    • 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.CMatrixRMaj getT​(@Nullable @Nullable org.ejml.data.CMatrixRMaj T)
      Specified by:
      getT in interface org.ejml.interfaces.decomposition.CholeskyDecomposition<org.ejml.data.CMatrixRMaj>

    • _getT

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

    • computeDeterminant

      public org.ejml.data.Complex_F32 computeDeterminant()
      Specified by:
      computeDeterminant in interface org.ejml.interfaces.decomposition.CholeskyDecomposition_F32<org.ejml.data.CMatrixRMaj>