scale_matrixT_scale_matrixScaleMatrixScaleMatrixscale_matrix (Operator)

Name

scale_matrixT_scale_matrixScaleMatrixScaleMatrixscale_matrix — Scale a matrix.

Signature

scale_matrix( : : MatrixID, Factor : MatrixScaledID)

Description

The operator scale_matrixscale_matrixScaleMatrixScaleMatrixscale_matrix scales the Matrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixScaled is generated with the result. The operator returns the matrix handle MatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledIDmatrix_scaled_id. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

FactorFactorFactorfactorfactor = 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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

FactorFactorFactorfactorfactor (input_control) number → (real / integer)

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

MatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledIDmatrix_scaled_id (output_control) matrix → (handle)

Matrix handle with the scaled elements.

Result

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