Skip to content

abs_matrixAbsMatrixAbsMatrixabs_matrixT_abs_matrix🔗

Short description🔗

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

Signature🔗

abs_matrix( matrix MatrixID, out matrix MatrixAbsID )void AbsMatrix( const HTuple& MatrixID, HTuple* MatrixAbsID )static void HOperatorSet.AbsMatrix( HTuple matrixID, out HTuple matrixAbsID )def abs_matrix( matrix_id: HHandle ) -> HHandle

Herror T_abs_matrix( const Htuple MatrixID, Htuple* MatrixAbsID )

HMatrix HMatrix::AbsMatrix( ) const

HMatrix HMatrix.AbsMatrix( )

Description🔗

The operator abs_matrixAbsMatrix computes the absolute values of all elements of the input Matrix given by the matrix handle MatrixIDmatrixIDmatrix_id. A new matrix MatrixAbs is generated with the result. The operator returns the matrix handle MatrixAbsIDmatrixAbsIDmatrix_abs_id of the matrix MatrixAbs. 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{MatrixAbs}_{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{MatrixAbs} = \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.

Parameters🔗

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

Matrix handle of the input matrix.

MatrixAbsIDmatrixAbsIDmatrix_abs_id (output_control) matrix → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle with the absolute values of the input matrix.

Result🔗

If the parameters are valid, the operator abs_matrixAbsMatrix 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_matrix_modAbsMatrixMod

Module🔗

Foundation