Matrix<T>.AsHermitianMatrix Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

AsHermitianMatrix() Returns a matrix as a HermitianMatrix<T>, or null if the matrix is not hermitian.
AsHermitianMatrix(MatrixTriangle) Returns a HermitianMatrix<T> extracted from a part of the matrix.

AsHermitianMatrix

Returns a matrix as a HermitianMatrix<T>, or null if the matrix is not hermitian.
C#
public HermitianMatrix<T>? AsHermitianMatrix()

Return Value

HermitianMatrix<T>
A HermitianMatrix<T>.

Remarks

If the matrix is already a HermitianMatrix<T>, then the same instance is returned. If the matrix is a dense matrix, then the storage is reused for the Hermitian matrix.

AsHermitianMatrix(MatrixTriangle)

Returns a HermitianMatrix<T> extracted from a part of the matrix.
C#
public HermitianMatrix<T>? AsHermitianMatrix(
	MatrixTriangle storedTriangle = MatrixTriangle.Upper
)

Parameters

storedTriangle  MatrixTriangle  (Optional)
A MatrixTriangle value that indicates whether the elements of the Hermitian matrix are stored in the upper or lower triangular portion of the matrix.

Return Value

HermitianMatrix<T>
A HermitianMatrix<T>.

Remarks

If the matrix is already a HermitianMatrix<T>, then the same instance is returned. If the matrix is a dense matrix, then the storage is reused for the Hermitian matrix.

See Also