get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix (算子名称)

名称

get_diagonal_matrixT_get_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix — Get the diagonal elements of a matrix.

参数签名

get_diagonal_matrix( : : MatrixID, Diagonal : VectorID)

描述

该算子 get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix generates a new matrix Vector and copies the diagonal elements of the Matrix to this new matrix. The Matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The matrix Vector has one column and n rows, where n = number of diagonal elements. 该算子 returns the matrix handle VectorIDVectorIDVectorIDVectorIDvectorIDvector_id of the matrix Vector. Access to the elements of the matrix is possible e.g., with 该算子 get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal = 0, the output of the Vector is the main diagonal of the Matrix.

Example:

DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal = 0

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal is positive, the output Vector is the DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal-th super-diagonal of the Matrix.

Example:

DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal = 2

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal is negative, the DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal-th sub-diagonal of the Matrix is copied.

Example:

DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal = -1

运行信息

多线程类型:可重入(与非独占操作符并行运行)。
多线程作用域:全局(可以从任何线程调用)。
未经并行化处理。

参数表

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal (input_control) integer → (integer)

Number of the desired diagonal.

Default: 0

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

VectorIDVectorIDVectorIDVectorIDvectorIDvector_id (output_control) matrix → (handle)

Matrix handle containing the diagonal elements.

结果

如果参数均有效，算子 get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix 返回值 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

可能的前置算子

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

可能的后置算子

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

参考其它

set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix

模块

Foundation

算子列表