DiagonalMatrix<T>.GetDiagonal Method

Definition

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

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.

public override Vector<T> GetDiagonal(
	int index,
	Intent intent
)

Visual Basic

Public Overrides Function GetDiagonal ( 
	index As Integer,
	intent As Intent
) As Vector(Of T)

C++/CLI

public:
virtual Vector<T>^ GetDiagonal(
	int index, 
	Intent intent
) override

abstract GetDiagonal : 
        index : int * 
        intent : Intent -> Vector<'T> 
override GetDiagonal : 
        index : int * 
        intent : Intent -> Vector<'T>

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

ArgumentOutOfRangeException

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