Gets a Vector view of the specified diagonal of this instance.

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Overridable Function GetDiagonal ( _
	index As Integer _
) As Vector
C#
public virtual Vector GetDiagonal (
	int index
)
C++
public:
virtual Vector^ GetDiagonal (
	int index
)

Parameters

index (System.Int32)
The index of the diagonal. A value of zero indicates the main diagonal. A value greater than zero indicates a superdiagonal. A value less than zero indicates a subdiagonal.

Return Value

A Vector view of the diagonal of this Matrix.

Remarks

This property returns a vector view of the diagonal. Changing the elements of this Vector will also change the corresponding elements of the Matrix. If you want the result to be independent of the matrix, use the CloneData() method on the result.

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionindex is less than or equal to -RowCount, or greater than or equal to ColumnCount.