DenseMatrix<T>.GetSymmetricView Method

Returns a SymmetricMatrix<T> view over a square block of this matrix.

Definition

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

Parameters

dimension  Int32
The number of rows and columns of the returned 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.

Return Value

SymmetricMatrix<T>
A SymmetricMatrix<T> view whose stored triangle is backed by the specified square block of this matrix.

Remarks

The returned matrix shares storage with this matrix. Only the triangle specified by storedTriangle is used as the stored part of the symmetric matrix.

Exceptions

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