Skip to content

sqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_modT_sqrt_matrix_mod🔗

Short description🔗

sqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_modT_sqrt_matrix_mod — Compute the square root values of the elements of a matrix.

Signature🔗

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

Herror T_sqrt_matrix_mod( const Htuple MatrixID )

void HMatrix::SqrtMatrixMod( ) const

void HMatrix.SqrtMatrixMod( )

Description🔗

The operator sqrt_matrix_modSqrtMatrixMod computes the square root 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 \sqrt{\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} 1.7321 & 1.0000 & 1.4142 \\ 2.2361 & 2.6458 & 1.4142 \\ 3.0000 & 2.0000 & 1.0000 \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 sqrt_matrix_modSqrtMatrixMod 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

sqrt_matrixSqrtMatrix

Module🔗

Foundation