get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix (Operator)

Name

get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix — Gibt die Diagonalelemente einer Matrix zurück.

Signatur

get_diagonal_matrix( : : MatrixID, Diagonal : VectorID)

Beschreibung

Der Operator get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrix generiert eine neue Matrix VectorVectorVectorVectorvector und kopiert die Diagonalelemente der Matrix MatrixMatrixMatrixMatrixmatrix in diese neue Matrix. Gegeben ist die Matrix MatrixMatrixMatrixMatrixmatrix durch das Matrix Handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. Die Matrix VectorVectorVectorVectorvector hat eine Spalte und n Zeilen mit n = Anzahl der Diagonalelemente. Der Operator gibt das Matrix Handle VectorIDVectorIDVectorIDVectorIDvectorID der Matrix VectorVectorVectorVectorvector zurück. Zugriff auf die Elemente der Matrix ist z.B. mit dem Operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix möglich.

Wenn DiagonalDiagonalDiagonalDiagonaldiagonal = 0, wird in den VectorVectorVectorVectorvector die Hauptdiagonale der MatrixMatrixMatrixMatrixmatrix kopiert.

Die obere DiagonalDiagonalDiagonalDiagonaldiagonal-te Nebendiagonale der Eingabematrix MatrixMatrixMatrixMatrixmatrix wird kopiert, wenn DiagonalDiagonalDiagonalDiagonaldiagonal eine positive Zahl ist.

Die untere DiagonalDiagonalDiagonalDiagonaldiagonal-te Nebendiagonale der Eingabematrix MatrixMatrixMatrixMatrixmatrix wird kopiert, wenn DiagonalDiagonalDiagonalDiagonaldiagonal eine negative Zahl ist.

Ausführungsinformationen

Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
Wird ohne Parallelisierung verarbeitet.

Parameter

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (handle)

Matrix Handle der Eingabematrix.

DiagonalDiagonalDiagonalDiagonaldiagonal (input_control) integer → (integer)

Nummer der gewünschten Diagonale.

Defaultwert: 0

Wertevorschläge: -20, -10, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20

VectorIDVectorIDVectorIDVectorIDvectorID (output_control) matrix → (handle)

Matrix Handle mit den Diagonalelementen.

Ergebnis

Sind die Parameterwerte korrekt, dann liefert get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrix den Wert 2 (H_MSG_TRUE). Gegebenenfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Nachfolger

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Siehe auch

set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrix

Modul

Foundation

Operatoren