DenseMatrix<T, TSlice, TStorage2D>.ExtractSymmetric Method

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

Overload List

ExtractSymmetric(Int32, Int32, Int32, MatrixTriangle, Boolean)

Creates a SymmetricMatrix<T> from a part of a DenseMatrix<T>.
C# 
public override SymmetricMatrix<T> ExtractSymmetric(
	int dimension,
	int startRow,
	int startColumn,
	MatrixTriangle storedTriangle,
	bool reuseValuesArray
)

Parameters

dimension  Int32
The number of rows and columns of the new matrix.
startRow  Int32
The row in the matrix of the first element of the new matrix.
startColumn  Int32
The column in the 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.
reuseValuesArray  Boolean
A boolean value that indicates whether the storage array used by the matrix should be copied or reused for internal storage.

Return Value

SymmetricMatrix<T>
A SymmetricMatrix<T>.

Exceptions

ArgumentNullException

the 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 the matrix.

-or-

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

ArgumentException

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

-or-

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

See Also