Operator Reference
pow_element_matrix_mod (Operator)
pow_element_matrix_mod
— Compute the power functions of the elements of a matrix.
Signature
pow_element_matrix_mod( : : MatrixID, MatrixExpID : )
Description
The operator pow_element_matrix_mod
computes the power of
all elements of the input Matrix
with the elements of
the input matrix MatrixExp
. The input matrices
Matrix
and MatrixExp
are defined by the matrix
handles MatrixID
and MatrixExpID
. Both matrices
must have identical dimensions. 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 of the base.
MatrixExpID
(input_control) matrix →
(handle)
Matrix handle of the input matrix with exponents.
Result
If the parameters are valid, the operator
pow_element_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
pow_element_matrix
,
pow_scalar_element_matrix
,
pow_scalar_element_matrix_mod
See also
Module
Foundation