ILMathdiagT Method

public static RetArray<T> diag<T>(
	BaseArray<T> A,
	int d = 0
)

Public Shared Function diag(Of T) ( 
	A As BaseArray(Of T),
	Optional d As Integer = 0
) As RetArray(Of T)

Dim A As BaseArray(Of T)
Dim d As Integer
Dim returnValue As RetArray(Of T)

returnValue = ILMath.diag(A, d)

Parameters

A

Type: ILNumericsBaseArrayT
Input matrix or vector.

d (Optional)

Type: SystemInt32
[Optional] Index of diagonal to extract/ to create. Default: 0.

Type Parameters

T

Return Value

If A is a matrix, diag(A) returns the elements on the d's diagonal as column vector.

If A is vector, a square matrix of size [A.Length - abs(d), A.Length - abs(d)] will be created, having the elements of the d's diagonal of A.

0 for d means: the main diagonal, d > 0 is above the main diagonal, d smaller 0 means below the main diagonal. d must lay in the range of existing rows / columns of A.

In general the equality diag(diag(A))==A holds true on a vector or a matrix A.

[ILNumerics Computing Engine]

Reference