ConstantMatrix<T>.GetDiagonal Method

Definition

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

GetDiagonal() Gets a vector view of the diagonal elements of this instance.
GetDiagonal(Int32) Gets a vector view of the specified diagonal of this instance.
GetDiagonal(Int32, Intent) Gets a vector view of the specified diagonal of this instance.

GetDiagonal(Int32, Intent)

Gets a vector view of the specified diagonal of this instance.
C#
public override Vector<T> GetDiagonal(
	int index,
	Intent intent
)

Parameters

index  Int32
The index of the diagonal. A value of zero indicates the main diagonal. A value greater than zero indicates a super-diagonal. A value less than zero indicates a sub-diagonal.
intent  Intent
An Intent value that specifies the intended use of the diagonal vector.

Return Value

Vector<T>
A Vector<T> containing the diagonal components if index equals the index of the nonzero diagonal; otherwise a ConstantVector<T> with value zero.

Exceptions

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

See Also