scale_matrix T_scale_matrix ScaleMatrix ScaleMatrix scale_matrix (Operator)
Name
scale_matrix T_scale_matrix ScaleMatrix ScaleMatrix scale_matrix
Signature
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 MatrixScaled is generated
with the result. The operator returns the matrix handle
MatrixScaledID MatrixScaledID MatrixScaledID MatrixScaledID matrixScaledID matrix_scaled_id get_full_matrix get_full_matrix GetFullMatrix GetFullMatrix GetFullMatrix get_full_matrix
Example:
Factor Factor Factor Factor factor factor 1.5
Execution Information
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.
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:
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
MatrixScaledID MatrixScaledID MatrixScaledID MatrixScaledID matrixScaledID matrix_scaled_id matrix → HMatrix , HTuple HHandle HTuple Htuple (handle) (IntPtr ) (HHandle ) (handle )
Matrix handle with the scaled elements.
Result
If the parameters are valid, the operator scale_matrix scale_matrix ScaleMatrix ScaleMatrix ScaleMatrix scale_matrix 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_mod scale_matrix_mod ScaleMatrixMod ScaleMatrixMod ScaleMatrixMod scale_matrix_mod
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