scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixMod (Operator)

Name

scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixMod — Scale a matrix.

Signature

Description

The operator scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrix scales the MatrixMatrixMatrixMatrixmatrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

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:

• MatrixIDMatrixIDMatrixIDMatrixIDmatrixID

Parameters

Result

If the parameters are valid, the operator scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixMod returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrix

See also

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixMultElementMatrix, mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModMultElementMatrixMod, div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixDivElementMatrix, div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModDivElementMatrixMod

Module

Foundation