abs_matrix_modabs_matrix_modAbsMatrixModabs_matrix_modAbsMatrixModAbsMatrixMod (Operator)

Name

abs_matrix_modabs_matrix_modAbsMatrixModabs_matrix_modAbsMatrixModAbsMatrixMod — Compute the absolute values of the elements of a matrix.

The operator abs_matrix_modabs_matrix_modAbsMatrixModabs_matrix_modAbsMatrixModAbsMatrixMod computes the absolute values of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

  Matrix    =   | Matrix   |.
        ij              ij

Example:


           /   3.0   1.0  -2.0  \               /  3.0  1.0  2.0  \
  Matrix = |  -5.0   7.0   2.0  |  ->  Matrix = |  5.0  7.0  2.0  |
           \  -9.0  -4.0   1.0  /               \  9.0  4.0  1.0  /

Attention

abs_matrix_modabs_matrix_modAbsMatrixModabs_matrix_modAbsMatrixModAbsMatrixMod modifies the content of an already existing matrix.

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.

Result

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