Matrix<T>.GetDiagonal Method

public Vector<T> GetDiagonal()

Public Function GetDiagonal As Vector(Of T)

public:
Vector<T>^ GetDiagonal()

member GetDiagonal : unit -> Vector<'T> 

Return Value

The default inherited intent returns a writable live vector for a mutable matrix, a read-only live vector for a live read-only matrix, and an immutable vector for an immutable matrix.

The main diagonal of a matrix with zero rows or zero columns is a valid length-zero vector.

public Vector<T> GetDiagonal(
	int index
)

Public Function GetDiagonal ( 
	index As Integer
) As Vector(Of T)

public:
Vector<T>^ GetDiagonal(
	int index
)

member GetDiagonal : 
        index : int -> 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.

Return Value

The default inherited intent returns a live vector unless the source is immutable. Use the overload that accepts Intent to request an explicit live view or detached copy.

Index zero is valid for every matrix shape. A positive index is valid when it is less than ColumnCount; a negative index is valid when its magnitude is less than RowCount.

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

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

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

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

View intents return vectors backed by this matrix. Copy intents return detached vectors. Inherit follows the mutability and live-sharing state of this matrix.

Index zero is valid for every matrix shape, including matrices with a zero dimension. A positive index is valid when it is less than ColumnCount; a negative index is valid when its magnitude is less than RowCount.

Reference