scale_matrixscale_matrixScaleMatrixscale_matrixScaleMatrixScaleMatrix (Operator)

Name

scale_matrixscale_matrixScaleMatrixscale_matrixScaleMatrixScaleMatrix — Scale a matrix.

Signature

scale_matrix( : : MatrixID, Factor : MatrixScaledID)

The operator scale_matrixscale_matrixScaleMatrixscale_matrixScaleMatrixScaleMatrix scales the MatrixMatrixMatrixMatrixMatrixmatrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixScaledMatrixScaledMatrixScaledMatrixScaledMatrixScaledmatrixScaled is generated with the result. The operator returns the matrix handle MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledID. 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:

  MatrixScaled   = 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  \
  ->   MatrixScaled = |  -3.0   9.0   3.0  |
                      \  -7.5  -6.0   1.5  /

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

FactorFactorFactorFactorFactorfactor (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

MatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDMatrixScaledIDmatrixScaledID (output_control) matrix → (integer)

Matrix handle with the scaled elements.

Result

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