sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod (Operator)

Name

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

The operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod computes the square root values of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The input matrix is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

                ___________
               |
  Matrix =   \ |  Matrix    .
        ij    \|        ij

Example:


           / 3.0  1.0  2.0 \               / 1.7321   1.0000   1.4142 \
  Matrix = | 5.0  7.0  2.0 |  ->  Matrix = | 2.2361   2.6458   1.4142 |
           \ 9.0  4.0  1.0 /               \ 3.0000   2.0000   1.0000 /

Attention

sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod modifies the content of an already existing matrix.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

Result

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