abs_matrix_modT_abs_matrix_modAbsMatrixModAbsMatrixMod (Operator)

Name

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

The operator abs_matrix_modabs_matrix_modAbsMatrixModAbsMatrixModAbsMatrixMod computes the absolute values of all elements of the input MatrixMatrixMatrixMatrixmatrix given 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.

Result

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