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

Class LUDecompositionBase_ZDRM

java.lang.Object
org.ejml.dense.row.decompose.lu.LUDecompositionBase_ZDRM
All Implemented Interfaces:
DecompositionInterface<ZMatrixRMaj>, LUDecomposition<ZMatrixRMaj>, LUDecomposition_F64<ZMatrixRMaj>
Direct Known Subclasses:
LUDecompositionAlt_ZDRM
public abstract class LUDecompositionBase_ZDRM extends Object implements LUDecomposition_F64<ZMatrixRMaj>

Contains common data structures and operations for LU decomposition algorithms.

  • Field Details

    • LU

      protected ZMatrixRMaj LU

    • maxWidth

      protected int maxWidth

    • m

      protected int m

    • n

      protected int n

    • stride

      protected int stride

    • dataLU

      protected double[] dataLU

    • vv

      protected double[] vv

    • indx

      protected int[] indx

    • pivot

      protected int[] pivot

    • pivsign

      protected double pivsign

    • det

      protected Complex_F64 det

  • Constructor Details

    • LUDecompositionBase_ZDRM

      public LUDecompositionBase_ZDRM()

  • Method Details

    • setExpectedMaxSize

      public void setExpectedMaxSize(int numRows, int numCols)

    • getLU

      public ZMatrixRMaj getLU()

    • getIndx

      public int[] getIndx()

    • getPivot

      public int[] getPivot()

    • 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<ZMatrixRMaj>
      Returns:
      true if the input matrix to decompose() is modified.

    • getLower

      public ZMatrixRMaj getLower(@Nullable @Nullable ZMatrixRMaj lower)
      Writes the lower triangular matrix into the specified matrix.
      Specified by:
      getLower in interface LUDecomposition<ZMatrixRMaj>
      Parameters:
      lower - Where the lower triangular matrix is written to.
      Returns:
      The L matrix.

    • getUpper

      public ZMatrixRMaj getUpper(@Nullable @Nullable ZMatrixRMaj upper)
      Writes the upper triangular matrix into the specified matrix.
      Specified by:
      getUpper in interface LUDecomposition<ZMatrixRMaj>
      Parameters:
      upper - Where the upper triangular matrix is writen to.
      Returns:
      The U matrix.

    • getRowPivot

      public ZMatrixRMaj getRowPivot(@Nullable @Nullable ZMatrixRMaj pivot)
      Description copied from interface: LUDecomposition

      For numerical stability there are often row interchanges. This computes a pivot matrix that will undo those changes.

      Specified by:
      getRowPivot in interface LUDecomposition<ZMatrixRMaj>
      Parameters:
      pivot - Storage for the pivot matrix. If null then a new matrix is returned. Modified.
      Returns:
      The pivot matrix.

    • getRowPivotV

      public int[] getRowPivotV(@Nullable @Nullable IGrowArray pivot)
      Description copied from interface: LUDecomposition
      Returns the row pivot vector
      Specified by:
      getRowPivotV in interface LUDecomposition<ZMatrixRMaj>
      Parameters:
      pivot - (Optional) Storage for pivot vector
      Returns:
      The pivot vector

    • decomposeCommonInit

      protected void decomposeCommonInit(ZMatrixRMaj 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 LUDecomposition<ZMatrixRMaj>
      Returns:
      true if singular false otherwise.

    • computeDeterminant

      public Complex_F64 computeDeterminant()
      Computes the determinant from the LU decomposition.
      Specified by:
      computeDeterminant in interface LUDecomposition_F64<ZMatrixRMaj>
      Returns:
      The matrix's determinant.

    • quality

      public double quality()

    • _solveVectorInternal

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

    • solveL

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

    • _getVV

      public double[] _getVV()