set_diagonal_matrixT_set_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix (算子名称)

名称

set_diagonal_matrixT_set_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix — Set the diagonal elements of a matrix.

参数签名

描述

该算子 set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix overwrites the diagonal elements of the Matrix with the elements of the matrix Vector. The matrices are defined by their matrix handles MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id and VectorIDVectorIDVectorIDVectorIDvectorIDvector_id. The matrix Vector must have one column and one row, n columns and one row or one column and n rows. n is the number of elements to be set in the Matrix (see below). If the matrix Vector has one column and one row, i.e., the matrix has one value, each element of the diagonal of the Matrix is overwritten by this value. Otherwise, the diagonal is overwritten by the elements of the matrix Vector.

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal = 0, the main diagonal of the Matrix is overwritten. The number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal is positive, the DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal-th super-diagonal of Matrix is overwritten. For the example 1 the number n = min(number of rows of Matrix, parameter DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal). For the example 2 the number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

If DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal is negative, the DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal-th sub-diagonal of Matrix is overwritten. For the example 1 the number n = min(number of columns of Matrix, parameter DiagonalDiagonalDiagonalDiagonaldiagonaldiagonal). For the example 2 the number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

运行信息

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

This operator modifies the state of the following input parameter:

• MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

参数表

结果

如果参数均有效，算子 set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixSetDiagonalMatrixset_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

参考其它

get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix

模块

Foundation

---