scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixMod (Operator)

Name

scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixMod — Scale a matrix.

Signature

scale_matrix_mod( : : MatrixID, Factor : )

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

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix.

FactorFactorFactorFactorfactor (input_control) number → (real / integer)

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_modscale_matrix_modScaleMatrixModScaleMatrixModScaleMatrixMod returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.