Class HermHess
java.lang.Object
org.flag4j.linalg.decompositions.unitary.UnitaryDecomposition<CMatrix,Complex128[]>
org.flag4j.linalg.decompositions.unitary.ComplexUnitaryDecomposition
org.flag4j.linalg.decompositions.hess.ComplexHess
org.flag4j.linalg.decompositions.hess.HermHess
- All Implemented Interfaces:
Decomposition<CMatrix>
Computes the Hessenburg decomposition of a complex dense Hermitian matrix. That is, for a square, Hermitian matrix
A, computes the decomposition A=QHQH where Q is an unitary matrix and
H is a Hermitian matrix in tri-diagonal form (special case of Hessenburg form) which is similar to A
(i.e. has the same eigenvalues).
A matrix H is in tri-diagonal form if it is nearly diagonal except for possibly the first sub/super-diagonal. Specifically, if H has all zeros below the first sub-diagonal and above the first super-diagonal.
For example, the following matrix is in Hermitian tri-diagonal form where each 'x' may hold a different value (provided the matrix is Hermitian):
[[ x x 0 0 0 ] [ x x x 0 0 ] [ 0 x x x 0 ] [ 0 0 x x x ] [ 0 0 0 x x ]]
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Flag indicating if an explicit check should be made that the matrix to be decomposed is Hermitian.Fields inherited from class org.flag4j.linalg.decompositions.unitary.ComplexUnitaryDecomposition
currentFactor, norm, normRe
Fields inherited from class org.flag4j.linalg.decompositions.unitary.UnitaryDecomposition
applyUpdate, householderVector, minAxisSize, numCols, numRows, qFactors, storeReflectors, subDiagonal, transformData, transformMatrix, workArray
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionApplies decomposition to the source matrix.protected double
findMaxAndInit
(int j) Finds the maximum value inUnitaryDecomposition.transformMatrix
at columnj
at or below thej
th row.getH()
Gets the Hessenberg matrix from the decomposition.protected void
Performs basic setup for the decomposition.protected void
updateData
(int j) Updates theUnitaryDecomposition.transformMatrix
matrix using the computed Householder vector fromComplexUnitaryDecomposition.computeHouseholder(int)
.Methods inherited from class org.flag4j.linalg.decompositions.hess.ComplexHess
getUpper, initQ
Methods inherited from class org.flag4j.linalg.decompositions.unitary.ComplexUnitaryDecomposition
computeHouseholder, computePhasedNorm, getQ, getUpper, initWorkArrays
Methods inherited from class org.flag4j.linalg.decompositions.unitary.UnitaryDecomposition
decomposeUnitary
-
Field Details
-
enforceHermitian
protected boolean enforceHermitianFlag indicating if an explicit check should be made that the matrix to be decomposed is Hermitian.
-
-
Constructor Details
-
HermHess
public HermHess()Constructs a Hessenberg decomposer for Hermitian matrices. By default, the Householder vectors used in the decomposition will be stored so that the full unitaryQ
matrix can be formed by callingComplexUnitaryDecomposition.getQ()
. -
HermHess
public HermHess(boolean computeQ) Constructs a Hessenberg decomposer for Hermitian matrices.- Parameters:
computeQ
- Flag indicating if the unitaryQ
matrix from the Hessenberg decomposition should be explicitly computed. If true, then theQ
matrix will be computed explicitly.
-
HermHess
public HermHess(boolean computeQ, boolean enforceHermitian) Constructs a Hessenberg decomposer for Hermitian matrices.- Parameters:
computeQ
- Flag indicating if the unitaryQ
matrix from the Hessenberg decomposition should be explicitly computed. If true, then theQ
matrix will be computed explicitly.enforceHermitian
- Flag indicating if an explicit check should be made to ensure any matrix passed todecompose(CMatrix)
is truly Hermitian. If true, an exception will be thrown if the matrix is not Hermitian. If false, the decomposition will proceed under the assumption that the matrix is Hermitian whether it actually is or not. If the matrix is not Hermitian, then the values in the upper triangular portion of the matrix are taken to be the values.
-
-
Method Details
-
decompose
Applies decomposition to the source matrix.- Specified by:
decompose
in interfaceDecomposition<CMatrix>
- Overrides:
decompose
in classComplexHess
- Parameters:
src
- The source matrix to decompose. (Assumed to be a Hermitian matrix).- Returns:
- A reference to this decomposer.
-
getH
Gets the Hessenberg matrix from the decomposition. The matrix will be Hermitian tri-diagonal.- Overrides:
getH
in classComplexHess
- Returns:
- The Hermitian tri-diagonal (Hessenberg) matrix from this decomposition.
-
findMaxAndInit
protected double findMaxAndInit(int j) Finds the maximum value inUnitaryDecomposition.transformMatrix
at columnj
at or below thej
th row. This method also initializes the firstnumRows-j
data of the storage arrayUnitaryDecomposition.householderVector
to the data of this column.- Overrides:
findMaxAndInit
in classComplexUnitaryDecomposition
- Parameters:
j
- Index of column (and starting row) to compute max of.- Returns:
- The maximum value in
UnitaryDecomposition.transformMatrix
at columnj
at or below thej
th row.
-
setUp
Performs basic setup for the decomposition.- Overrides:
setUp
in classUnitaryDecomposition<CMatrix,
Complex128[]> - Parameters:
src
- The matrix to be decomposed.- Throws:
LinearAlgebraException
- If the matrix is not Hermitian andenforceHermitian
is true or if the matrix is not square regardless of the value ofenforceHermitian
.
-
updateData
protected void updateData(int j) Updates theUnitaryDecomposition.transformMatrix
matrix using the computed Householder vector fromComplexUnitaryDecomposition.computeHouseholder(int)
.- Overrides:
updateData
in classComplexUnitaryDecomposition
- Parameters:
j
- Index of sub-matrix for which the Householder reflector was computed for.
-