abs_matrix (Operator)

Name

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

Synopsis

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:

  MatrixAbs    =   | Matrix   |.
           ij              ij

Example:

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

Parameters

MatrixID (input_control)	matrix → (integer)
Matrix handle of the input matrix.

MatrixAbsID (output_control)	matrix → (integer)
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.

Parallelization Information

abs_matrix is reentrant and processed without parallelization.

Possible Predecessors

create_matrix

Possible Successors

get_full_matrix, get_value_matrix

Alternatives

abs_matrix_mod

Module

Foundation