BandMatrix<T>.GetDiagonal Method

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

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

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

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.

Reference