TriangularMatrix<T>.ExtractSymmetric Method

Creates a SymmetricMatrix<T> from a part of a matrix.

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.5.0
C# 
public static SymmetricMatrix<T> ExtractSymmetric(
	Matrix<T> matrix,
	int dimension,
	int startRow,
	int startColumn,
	MatrixTriangle storedTriangle
)

Parameters

matrix  Matrix<T>
The matrix that contains the elements of the new matrix.
dimension  Int32
The number of rows and columns of the new matrix.
startRow  Int32
The row in matrix of the first element of the new matrix.
startColumn  Int32
The column in matrix of the first element of the new matrix.
storedTriangle  MatrixTriangle
A MatrixTriangle value that indicates whether the elements of the symmetric matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.

Return Value

SymmetricMatrix<T>
A SymmetricMatrix<T>.

Exceptions

ArgumentNullException

matrix is null.

ArgumentOutOfRangeException

dimension is less than zero

-or-

startRow is less than zero or greater than or equal to the number of rows in matrix.

-or-

startColumn is less than zero or greater than or equal to the number of columns in matrix.

ArgumentException

startRow plus dimension is greater than or equal to the number of rows in matrix.

-or-

startColumn plus dimension is greater than or equal to the number of columns in matrix.

See Also