scale_matrixscale_matrixScaleMatrixScaleMatrix (Operator)

Name

scale_matrixscale_matrixScaleMatrixScaleMatrix — Scale a matrix.

Signature

scale_matrix( : : MatrixID, Factor : MatrixScaledID)

The operator scale_matrixscale_matrixScaleMatrixScaleMatrixScaleMatrix scales the MatrixMatrixMatrixMatrixmatrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixScaledMatrixScaledMatrixScaledMatrixScaledmatrixScaled is generated with the result. The operator returns the matrix handle MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledID. 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.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

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

MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledID (output_control) matrix → (integer)

Matrix handle with the scaled elements.

Result

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