BandMatrix<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 diagonal elements of this instance.

GetDiagonal(Int32, Intent)

Gets a vector view of the diagonal elements 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> view of the diagonal of this instance.

Remarks

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

If the diagonal contains only zeros, then a ConstantVector<T> is returned. Otherwise, a DenseVector<T> is returned.

See Also