Package org.ejml.dense.row.decompose.lu

Class LUDecompositionBase_CDRM

java.lang.Object
org.ejml.dense.row.decompose.lu.LUDecompositionBase_CDRM
All Implemented Interfaces:
org.ejml.interfaces.decomposition.DecompositionInterface<org.ejml.data.CMatrixRMaj>, org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>, org.ejml.interfaces.decomposition.LUDecomposition_F32<org.ejml.data.CMatrixRMaj>
Direct Known Subclasses:
LUDecompositionAlt_CDRM
@Generated("org.ejml.dense.row.decompose.lu.LUDecompositionBase_ZDRM")
public abstract class LUDecompositionBase_CDRM
extends Object
implements org.ejml.interfaces.decomposition.LUDecomposition_F32<org.ejml.data.CMatrixRMaj>

Contains common data structures and operations for LU decomposition algorithms.

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected float[] dataLU  
    protected org.ejml.data.Complex_F32 det  
    protected int[] indx  
    protected org.ejml.data.CMatrixRMaj LU  
    protected int m  
    protected int maxWidth  
    protected int n  
    protected int[] pivot  
    protected float pivsign  
    protected int stride  
    protected float[] vv  

  • Constructor Summary

    Constructors
    Constructor Description
    LUDecompositionBase_CDRM()  

  • Method Summary

    Modifier and Type Method Description
    float[] _getVV()  
    void _solveVectorInternal​(float[] vv)
    a specialized version of solve that avoid additional checks that are not needed.
    org.ejml.data.Complex_F32 computeDeterminant()
    Computes the determinant from the LU decomposition.
    protected void decomposeCommonInit​(org.ejml.data.CMatrixRMaj a)  
    int[] getIndx()  
    org.ejml.data.CMatrixRMaj getLower​(@Nullable org.ejml.data.CMatrixRMaj lower)
    Writes the lower triangular matrix into the specified matrix.
    org.ejml.data.CMatrixRMaj getLU()  
    int[] getPivot()  
    org.ejml.data.CMatrixRMaj getRowPivot​(@Nullable org.ejml.data.CMatrixRMaj pivot)  
    int[] getRowPivotV​(@Nullable org.ejml.data.IGrowArray pivot)  
    org.ejml.data.CMatrixRMaj getUpper​(@Nullable org.ejml.data.CMatrixRMaj upper)
    Writes the upper triangular matrix into the specified matrix.
    boolean inputModified()  
    boolean isSingular()
    Determines if the decomposed matrix is singular.
    double quality()  
    void setExpectedMaxSize​(int numRows, int numCols)  
    protected void solveL​(float[] vv)
    Solve the using the lower triangular matrix in LU.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.ejml.interfaces.decomposition.DecompositionInterface

    decompose

  • Field Details

    • LU

      protected org.ejml.data.CMatrixRMaj LU

    • maxWidth

      protected int maxWidth

    • m

      protected int m

    • n

      protected int n

    • stride

      protected int stride

    • dataLU

      protected float[] dataLU

    • vv

      protected float[] vv

    • indx

      protected int[] indx

    • pivot

      protected int[] pivot

    • pivsign

      protected float pivsign

    • det

      protected org.ejml.data.Complex_F32 det

  • Constructor Details

    • LUDecompositionBase_CDRM

      public LUDecompositionBase_CDRM()

  • Method Details

    • setExpectedMaxSize

      public void setExpectedMaxSize​(int numRows, int numCols)

    • getLU

      public org.ejml.data.CMatrixRMaj getLU()

    • getIndx

      public int[] getIndx()

    • getPivot

      public int[] getPivot()

    • inputModified

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

    • getLower

      public org.ejml.data.CMatrixRMaj getLower​(@Nullable @Nullable org.ejml.data.CMatrixRMaj lower)
      Writes the lower triangular matrix into the specified matrix.
      Specified by:
      getLower in interface org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>
      Parameters:
      lower - Where the lower triangular matrix is written to.

    • getUpper

      public org.ejml.data.CMatrixRMaj getUpper​(@Nullable @Nullable org.ejml.data.CMatrixRMaj upper)
      Writes the upper triangular matrix into the specified matrix.
      Specified by:
      getUpper in interface org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>
      Parameters:
      upper - Where the upper triangular matrix is writen to.

    • getRowPivot

      public org.ejml.data.CMatrixRMaj getRowPivot​(@Nullable @Nullable org.ejml.data.CMatrixRMaj pivot)
      Specified by:
      getRowPivot in interface org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>

    • getRowPivotV

      public int[] getRowPivotV​(@Nullable @Nullable org.ejml.data.IGrowArray pivot)
      Specified by:
      getRowPivotV in interface org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>

    • decomposeCommonInit

      protected void decomposeCommonInit​(org.ejml.data.CMatrixRMaj a)

    • isSingular

      public boolean isSingular()
      Determines if the decomposed matrix is singular. This function can return false and the matrix be almost singular, which is still bad.
      Specified by:
      isSingular in interface org.ejml.interfaces.decomposition.LUDecomposition<org.ejml.data.CMatrixRMaj>
      Returns:
      true if singular false otherwise.

    • computeDeterminant

      public org.ejml.data.Complex_F32 computeDeterminant()
      Computes the determinant from the LU decomposition.
      Specified by:
      computeDeterminant in interface org.ejml.interfaces.decomposition.LUDecomposition_F32<org.ejml.data.CMatrixRMaj>
      Returns:
      The matrix's determinant.

    • quality

      public double quality()

    • _solveVectorInternal

      public void _solveVectorInternal​(float[] vv)
      a specialized version of solve that avoid additional checks that are not needed.

    • solveL

      protected void solveL​(float[] vv)
      Solve the using the lower triangular matrix in LU. Diagonal elements are assumed to be 1

    • _getVV

      public float[] _getVV()