abs_matrixabs_matrixAbsMatrixAbsMatrix (Operator)

Name

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

Signature

abs_matrix( : : MatrixID : MatrixAbsID)

The operator abs_matrixabs_matrixAbsMatrixAbsMatrixAbsMatrix computes the absolute values of all elements of the input MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixAbsMatrixAbsMatrixAbsMatrixAbsmatrixAbs is generated with the result. The operator returns the matrix handle MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsID of the matrix MatrixAbsMatrixAbsMatrixAbsMatrixAbsmatrixAbs. 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.

MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsID (output_control) matrix → (integer)

Matrix handle with the absolute values of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

abs_matrix_modabs_matrix_modAbsMatrixModAbsMatrixModAbsMatrixMod

Module

Foundation

Operators