sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrix (Operator)

Name

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

Signature

sqrt_matrix( : : MatrixID : MatrixSqrtID)

The operator sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix computes the square root values of all elements of the input MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. A new matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrt is generated with the result. The operator returns the matrix handle MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtID of the matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrt. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

Example:

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtID (output_control) matrix → (integer)

Matrix handle with the square root values of the input matrix.

Result

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