Operator Reference
sqrt_matrix_mod (Operator)
sqrt_matrix_mod
— Compute the square root values of the elements of a matrix.
Signature
sqrt_matrix_mod( : : MatrixID : )
Description
The operator sqrt_matrix_mod
computes the square root
values of all elements of the input Matrix
given by the
matrix handle MatrixID
. The input matrix is overwritten
with the result. Access to the elements of the matrix is possible
e.g., with the operator get_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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
MatrixID
(input_control, state is modified) matrix →
(handle)
Matrix handle of the input matrix.
Result
If the parameters are valid, the operator sqrt_matrix_mod
returns
the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
Possible Successors
get_full_matrix
,
get_value_matrix
Alternatives
Module
Foundation