get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix (Operator)

Name

get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix — Gibt die Diagonalelemente einer Matrix zurück.

Signatur

get_diagonal_matrix( : : MatrixID, Diagonal : VectorID)

Beschreibung

Der Operator get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix 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 MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. Die Matrix VectorVectorVectorVectorvectorvector hat eine Spalte und n Zeilen mit n = Anzahl der Diagonalelemente. Der Operator gibt das Matrix Handle VectorIDVectorIDVectorIDVectorIDvectorIDvector_id der Matrix VectorVectorVectorVectorvectorvector zurück. Zugriff auf die Elemente der Matrix ist z.B. mit dem Operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix 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.

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

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

VectorIDVectorIDVectorIDVectorIDvectorIDvector_id (output_control) matrix → (handle)

Matrix Handle mit den Diagonalelementen.

Ergebnis

Sind die Parameterwerte korrekt, dann liefert get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix den Wert TRUE. Gegebenenfalls wird eine Fehlerbehandlung durchgeführt.

Vorgänger

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Nachfolger

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Siehe auch

set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix

Modul

Foundation

Operatoren