abs_matrixT_abs_matrixAbsMatrixAbsMatrixabs_matrix (Operator)

Name

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

Signature

abs_matrix( : : MatrixID : MatrixAbsID)

Description

The operator abs_matrixabs_matrixAbsMatrixAbsMatrixAbsMatrixabs_matrix computes the absolute values of all elements of the input Matrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixAbs is generated with the result. The operator returns the matrix handle MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsIDmatrix_abs_id of the matrix MatrixAbs. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. 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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

MatrixAbsIDMatrixAbsIDMatrixAbsIDMatrixAbsIDmatrixAbsIDmatrix_abs_id (output_control) matrix → (handle)

Matrix handle with the absolute values of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

abs_matrix_modabs_matrix_modAbsMatrixModAbsMatrixModAbsMatrixModabs_matrix_mod

Module

Foundation

Operators