sqrt_matrix_modT_sqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod (Operator)

Name

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

Signature

sqrt_matrix_mod( : : MatrixID : )

Description

The operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod computes the square root values of all elements of the input MatrixMatrixMatrixMatrixmatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_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_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. 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.

This operator modifies the state of the following input parameter:

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id

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

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix.

Result

If the parameters are valid, the operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix

Module

Foundation

Operators