Operator Reference
sqrt_matrix (Operator)
sqrt_matrix — Compute the square root values of the elements of a matrix.
Signature
sqrt_matrix( : : MatrixID : MatrixSqrtID)
Description
The operator sqrt_matrix computes the square root values of
all elements of the input Matrix given by the matrix handle
MatrixID. A new matrix MatrixSqrt is generated
with the result. The operator returns the matrix handle
MatrixSqrtID of the matrix MatrixSqrt. 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.
Parameters
MatrixID (input_control) matrix → (handle)
Matrix handle of the input matrix.
MatrixSqrtID (output_control) matrix → (handle)
Matrix handle with the square root values of the input matrix.
Result
If the parameters are valid, the operator sqrt_matrix returns
the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
Possible Successors
get_full_matrix,
get_value_matrix
Alternatives
See also
pow_scalar_element_matrix,
pow_scalar_element_matrix_mod
Module
Foundation