scale_matrix_mod T_scale_matrix_mod ScaleMatrixMod ScaleMatrixMod scale_matrix_mod (Operator)
Name
scale_matrix_mod T_scale_matrix_mod ScaleMatrixMod ScaleMatrixMod scale_matrix_mod
Signature
def scale_matrix_mod (matrix_id factor
Description
The operator scale_matrix scale_matrix ScaleMatrix ScaleMatrix ScaleMatrix scale_matrix Matrix by a
constant factor. The matrix is defined by the matrix handle
MatrixID MatrixID MatrixID MatrixID matrixID matrix_id get_full_matrix get_full_matrix GetFullMatrix GetFullMatrix GetFullMatrix get_full_matrix
Example:
Execution Information
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.
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.
Parameters
MatrixID MatrixID MatrixID MatrixID matrixID matrix_id matrix → HMatrix , HTuple HHandle HTuple Htuple (handle) (IntPtr ) (HHandle ) (handle )
Matrix handle of the input matrix.
Factor Factor Factor Factor factor factor number → HTuple Union[int, float] HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Scale factor.
Default value: 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
Result
If the parameters are valid, the operator scale_matrix_mod scale_matrix_mod ScaleMatrixMod ScaleMatrixMod ScaleMatrixMod scale_matrix_mod 2 (H_MSG_TRUE ). If necessary, an exception is raised.
Possible Predecessors
create_matrix create_matrix CreateMatrix CreateMatrix CreateMatrix create_matrix
Possible Successors
get_full_matrix get_full_matrix GetFullMatrix GetFullMatrix GetFullMatrix get_full_matrix get_value_matrix get_value_matrix GetValueMatrix GetValueMatrix GetValueMatrix get_value_matrix
Alternatives
scale_matrix scale_matrix ScaleMatrix ScaleMatrix ScaleMatrix scale_matrix
See also
mult_element_matrix mult_element_matrix MultElementMatrix MultElementMatrix MultElementMatrix mult_element_matrix mult_element_matrix_mod mult_element_matrix_mod MultElementMatrixMod MultElementMatrixMod MultElementMatrixMod mult_element_matrix_mod div_element_matrix div_element_matrix DivElementMatrix DivElementMatrix DivElementMatrix div_element_matrix div_element_matrix_mod div_element_matrix_mod DivElementMatrixMod DivElementMatrixMod DivElementMatrixMod div_element_matrix_mod
Module
Foundation