scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixModscale_matrix_mod (算子名称)
名称
scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixModscale_matrix_mod — Scale a matrix.
参数签名
def scale_matrix_mod(matrix_id: HHandle, factor: Union[int, float]) -> None
描述
该算子 scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrixscale_matrix scales the Matrix by a
constant factor. The matrix is defined by the matrix handle
MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The input matrix is overwritten with the
result. Access to the elements of the matrix is possible e.g., with
该算子 get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the
calculation of the result is:
Example:
FactorFactorFactorFactorfactorfactor = 1.5
运行信息
- 多线程类型:可重入(与非独占操作符并行运行)。
- 多线程作用域:全局(可以从任何线程调用)。
- 未经并行化处理。
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
参数表
MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Matrix handle of the input matrix.
FactorFactorFactorFactorfactorfactor (input_control) number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Scale factor.
Default:
2.0
Suggested values:
0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0
结果
如果参数均有效，算子 scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixModscale_matrix_mod
返回值 2 (
H_MSG_TRUE)
. 如有必要，将引发异常。
可能的前置算子
create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix
可能的后置算子
get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix,
get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix
可替代算子
scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrixscale_matrix
参考其它
mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrixmult_element_matrix,
mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixModmult_element_matrix_mod,
div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrixdiv_element_matrix,
div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod
模块
Foundation