Name
scale_matrix_modscale_matrix_modScaleMatrixModscale_matrix_modScaleMatrixModScaleMatrixMod — Scale a matrix.
The operator scale_matrixscale_matrixScaleMatrixscale_matrixScaleMatrixScaleMatrix scales the MatrixMatrixMatrixMatrixMatrixmatrix by a
constant factor. The matrix is defined by the matrix handle
MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The input matrix is overwritten with the
result. Access to the elements of the matrix is possible e.g. with
the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the
calculation of the result is:
Matrix = Factor * Matrix .
ij ij
Example:
/ 3.0 1.0 -2.0 \
Matrix = | -2.0 6.0 2.0 | Factor = 1.5
\ -5.0 -4.0 1.0 /
/ 4.5 1.5 -3.0 \
-> Matrix = | -3.0 9.0 3.0 |
\ -7.5 -6.0 1.5 /
scale_matrix_modscale_matrix_modScaleMatrixModscale_matrix_modScaleMatrixModScaleMatrixMod modifies the content of an already existing
matrix.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Matrix handle of the input matrix.
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
If the parameters are valid, the operator scale_matrix_modscale_matrix_modScaleMatrixModscale_matrix_modScaleMatrixModScaleMatrixMod
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix
get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix,
get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix
scale_matrixscale_matrixScaleMatrixscale_matrixScaleMatrixScaleMatrix
mult_element_matrixmult_element_matrixMultElementMatrixmult_element_matrixMultElementMatrixMultElementMatrix,
mult_element_matrix_modmult_element_matrix_modMultElementMatrixModmult_element_matrix_modMultElementMatrixModMultElementMatrixMod,
div_element_matrixdiv_element_matrixDivElementMatrixdiv_element_matrixDivElementMatrixDivElementMatrix,
div_element_matrix_moddiv_element_matrix_modDivElementMatrixModdiv_element_matrix_modDivElementMatrixModDivElementMatrixMod
Foundation