Module ojalgo

Package org.ojalgo.matrix.decomposition

Interface MatrixDecomposition.RankRevealing<N extends java.lang.Comparable<N>>

All Superinterfaces:

MatrixDecomposition<N>, MatrixDecomposition.Ordered<N>, Provider2D, Provider2D.Rank, Structure1D, Structure2D

All Known Subinterfaces:

Cholesky<N>, Eigenvalue.Spectral<N>, LDL<N>, LDU<N>, LU<N>, QR<N>, SingularValue<N>

All Known Implementing Classes:

DenseCholesky, DenseCholesky.C128, DenseCholesky.H256, DenseCholesky.Q128, DenseCholesky.R064, DenseCholesky.R128, DenseLDL, DenseLDL.C128, DenseLDL.H256, DenseLDL.Q128, DenseLDL.R064, DenseLDL.R128, DenseLU, DenseLU.C128, DenseLU.H256, DenseLU.Q128, DenseLU.R064, DenseLU.R128, DenseQR, DenseQR.C128, DenseQR.H256, DenseQR.Q128, DenseQR.R064, DenseQR.R128, DenseSingularValue, DenseSingularValue.C128, DenseSingularValue.H256, DenseSingularValue.Q128, DenseSingularValue.R064, DenseSingularValue.R128, HermitianEvD, HermitianEvD.C128, HermitianEvD.H256, HermitianEvD.Q128, HermitianEvD.R064, HermitianEvD.R128, RawCholesky, RawEigenvalue.Symmetric, RawLU, RawQR, RawSingularValue, SparseLU

Enclosing interface:

MatrixDecomposition<N extends java.lang.Comparable<N>>

public static interface MatrixDecomposition.RankRevealing<N extends java.lang.Comparable<N>>
extends MatrixDecomposition.Ordered<N>, Provider2D.Rank

A rank-revealing matrix decomposition of a matrix [A] is a decomposition that is, or can be transformed to be, on the form [A]=[X][D][Y]^T where:

• [X] and [Y] are square and well conditioned.
• [D] is diagonal with nonnegative and non-increasing values on the diagonal.

The defintion that [X] and [Y] should be well conditioned is subject to interpretation. A specific decomposition algorithm can be more or less good at revealing the rank. Typically the SingularValue decomposition is the best.

The requirement to have the diagonal elements of [D] ordered can be very practical, but is not always strictly necessary in order to just reveal the rank. The method MatrixDecomposition.Ordered.isOrdered() indicates if the elements (rows and columns) of the returned matrix factors actually are ordered or not for this particular implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

MatrixDecomposition.Determinant<N extends java.lang.Comparable<N>>, MatrixDecomposition.EconomySize<N extends java.lang.Comparable<N>>, MatrixDecomposition.Factory<D extends MatrixDecomposition<?>>, MatrixDecomposition.Hermitian<N extends java.lang.Comparable<N>>, MatrixDecomposition.Ordered<N extends java.lang.Comparable<N>>, MatrixDecomposition.Pivoting<N extends java.lang.Comparable<N>>, MatrixDecomposition.RankRevealing<N extends java.lang.Comparable<N>>, MatrixDecomposition.Solver<N extends java.lang.Comparable<N>>, MatrixDecomposition.Updatable<N extends java.lang.Comparable<N>>, MatrixDecomposition.Values<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.Provider2D

Provider2D.Condition, Provider2D.Determinant<N extends java.lang.Comparable<N>>, Provider2D.Eigenpairs, Provider2D.Hermitian, Provider2D.Inverse<M>, Provider2D.Rank, Provider2D.Solution<M>, Provider2D.Symmetric, Provider2D.Trace<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure2D

Structure2D.IntRowColumn, Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,B>>, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.Reshapable, Structure2D.RowColumnKey<R,C>, Structure2D.RowColumnMapper<R,C>

Field Summary

Fields inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

TYPICAL

Method Summary

Modifier and Type	Method	Description
int	countSignificant(double threshold)
default int	getRank()	The best (and most expensive) way to get the effective numerical rank is by calculating a SingularValue decomposition and then find the number of nonnegligible singular values.
double	getRankThreshold()
default boolean	isFullRank()

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

decompose, isComputed, reconstruct, reset

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition.Ordered

isOrdered

Methods inherited from interface org.ojalgo.structure.Structure2D

count, countColumns, countRows, firstInColumn, firstInRow, getColDim, getMaxDim, getMinDim, getRowDim, isEmpty, isFat, isScalar, isSquare, isTall, isVector, limitOfColumn, limitOfRow, size

Method Detail

countSignificant

int countSignificant(double threshold)

Parameters:

threshold - Significance limit

Returns:

The number of elements in the diagonal matrix that are greater than the threshold

getRank

default int getRank()

The best (and most expensive) way to get the effective numerical rank is by calculating a SingularValue decomposition and then find the number of nonnegligible singular values.

Specified by:

getRank in interface Provider2D.Rank

Returns:

The effective numerical rank (best estimate)

getRankThreshold

double getRankThreshold()

isFullRank

default boolean isFullRank()

Returns:

true if the rank is equal to the minimum of the row and column dimensions; false if not