get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix (Operator)

Name

get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix — Get the diagonal elements of a matrix.

Signature

get_diagonal_matrix( : : MatrixID, Diagonal : VectorID)

The operator get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix generates a new matrix VectorVectorVectorVectorVectorvector and copies the diagonal elements of the MatrixMatrixMatrixMatrixMatrixmatrix to this new matrix. The MatrixMatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The matrix VectorVectorVectorVectorVectorvector has one column and n rows, where n = number of diagonal elements. The operator returns the matrix handle VectorIDVectorIDVectorIDVectorIDVectorIDvectorID of the matrix VectorVectorVectorVectorVectorvector. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix.

If DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal = 0, the output of the VectorVectorVectorVectorVectorvector is the main diagonal of the MatrixMatrixMatrixMatrixMatrixmatrix.

Example:

If DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal is positive, the output VectorVectorVectorVectorVectorvector is the DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal-th super-diagonal of the MatrixMatrixMatrixMatrixMatrixmatrix.

Example:

If DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal is negative, the DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal-th sub-diagonal of the MatrixMatrixMatrixMatrixMatrixmatrix is copied.

Example:

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

DiagonalDiagonalDiagonalDiagonalDiagonaldiagonal (input_control) integer → (integer)

Number of the desired diagonal.

Default value: 0

Suggested values: -20, -10, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20

VectorIDVectorIDVectorIDVectorIDVectorIDvectorID (output_control) matrix → (integer)

Matrix handle containing the diagonal elements.

Result

If the parameters are valid, the operator get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.