Operator Reference
abs_matrix (Operator)
abs_matrix
— Compute the absolute values of the elements of a matrix.
Signature
abs_matrix( : : MatrixID : MatrixAbsID)
Description
The operator abs_matrix
computes the absolute values of all
elements of the input Matrix
given by the matrix handle
MatrixID
. A new matrix MatrixAbs
is generated
with the result. The operator returns the matrix handle
MatrixAbsID
of the matrix MatrixAbs
. Access
to the elements of the matrix is possible e.g., with the operator
get_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
MatrixID
(input_control) matrix →
(handle)
Matrix handle of the input matrix.
MatrixAbsID
(output_control) matrix →
(handle)
Matrix handle with the absolute values of the input matrix.
Result
If the parameters are valid, the operator abs_matrix
returns
the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
Possible Successors
get_full_matrix
,
get_value_matrix
Alternatives
Module
Foundation