Matrix<T>.AsSymmetricMatrix Method

Definition

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

Overload List

AsSymmetricMatrix() Returns a matrix as a SymmetricMatrix<T>, or null if the matrix is not symmetrical.
AsSymmetricMatrix(MatrixTriangle) Returns a SymmetricMatrix<T> extracted from a part of the matrix.

AsSymmetricMatrix

Returns a matrix as a SymmetricMatrix<T>, or null if the matrix is not symmetrical.
C#
public virtual SymmetricMatrix<T>? AsSymmetricMatrix()

Return Value

SymmetricMatrix<T>
A SymmetricMatrix<T>.

Remarks

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

AsSymmetricMatrix(MatrixTriangle)

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

Parameters

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

Return Value

SymmetricMatrix<T>
A SymmetricMatrix<T>.

Remarks

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

See Also