get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix (Operator)

Name

get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix — Gibt die Diagonalelemente einer Matrix zurück.

Signatur

get_diagonal_matrix( : : MatrixID, Diagonal : VectorID)

Der Operator get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix generiert eine neue Matrix VectorVectorVectorVectorVectorvector und kopiert die Diagonalelemente der Matrix MatrixMatrixMatrixMatrixMatrixmatrix in diese neue Matrix. Gegeben ist die Matrix MatrixMatrixMatrixMatrixMatrixmatrix durch das Matrix Handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. Die Matrix VectorVectorVectorVectorVectorvector hat eine Spalte und n Zeilen mit n = Anzahl der Diagonalelemente. Der Operator gibt das Matrix Handle VectorIDVectorIDVectorIDVectorIDVectorIDvectorID der Matrix VectorVectorVectorVectorVectorvector zurück. Zugriff auf die Elemente der Matrix ist z.B. mit dem Operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix möglich.

Wenn DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal = 0, wird in den VectorVectorVectorVectorVectorvector die Hauptdiagonale der MatrixMatrixMatrixMatrixMatrixmatrix kopiert.

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

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

Parallelisierung

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

Parameter

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix Handle der Eingabematrix.

DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal (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

VectorIDVectorIDVectorIDVectorIDVectorIDvectorID (output_control) matrix → (integer)

Matrix Handle mit den Diagonalelementen.

Ergebnis

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

Vorgänger

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Nachfolger

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Siehe auch

set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrix

Modul

Foundation

Operatoren