Skip to content

abs_matrix_modAbsMatrixModAbsMatrixModabs_matrix_modT_abs_matrix_mod🔗

Short description🔗

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

Signature🔗

abs_matrix_mod( matrix MatrixID )void AbsMatrixMod( const HTuple& MatrixID )static void HOperatorSet.AbsMatrixMod( HTuple matrixID )def abs_matrix_mod( matrix_id: HHandle ) -> None

Herror T_abs_matrix_mod( const Htuple MatrixID )

void HMatrix::AbsMatrixMod( ) const

void HMatrix.AbsMatrixMod( )

Description🔗

The operator abs_matrix_modAbsMatrixMod computes the absolute values of all elements of the input Matrix given by the matrix handle MatrixIDmatrixIDmatrix_id. The input matrix is overwritten with the result. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixGetFullMatrix. The formula for the calculation of the result is:

\[\begin{eqnarray*} \texttt{Matrix}_{ij} \quad = \quad |\,\texttt{Matrix}_{ij}\,|. \end{eqnarray*}\]

Example:

\[\begin{eqnarray*} \texttt{Matrix} = \left[ \begin{array}{rrr} 3.0 & 1.0 & -2.0 \\ -5.0 & 7.0 & 2.0 \\ -9.0 & -4.0 & 1.0 \end{array} \right] \qquad \to \qquad \texttt{Matrix} = \left[ \begin{array}{rrr} 3.0 & 1.0 & 2.0 \\ 5.0 & 7.0 & 2.0 \\ 9.0 & 4.0 & 1.0 \end{array} \right] \end{eqnarray*}\]

Execution information🔗

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:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

MatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Possible successors

get_full_matrixGetFullMatrix, get_value_matrixGetValueMatrix

Alternatives

abs_matrixAbsMatrix

Module🔗

Foundation