SingleComplexMatrix..::..GetDiagonal Method (Int32)

SingleComplexMatrix Class See Also

Gets a ComplexVector view of the specified diagonal of this instance.

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics.SinglePrecision.Net40 (in Extreme.Numerics.SinglePrecision.Net40.dll) Version: 4.0.10170.0 (4.0.11003.0)

Syntax

C#
public virtual SingleComplexVector GetDiagonal( int index )

Visual Basic (Declaration)
Public Overridable Function GetDiagonal ( _ index As Integer _ ) As SingleComplexVector

Visual C++
public: virtual SingleComplexVector^ GetDiagonal( int index )

F#
abstract GetDiagonal : index:int -> SingleComplexVector override GetDiagonal : index:int -> SingleComplexVector

Parameters

index: Type: System..::..Int32
The index of the diagonal. A value of zero indicates the main diagonal. A value greater than zero indicates a superdiagonal. A value less than zero indicates a subdiagonal.

Return Value

A ComplexVector view of the specified diagonal of this SingleComplexMatrix.

Remarks

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

Exceptions

Exception	Condition
System..::..ArgumentOutOfRangeException	index is less than or equal to -RowCount, or greater than or equal to ColumnCount.