Operator Reference
pow_scalar_element_matrix (Operator)
pow_scalar_element_matrix — Compute the power functions of the elements of a matrix.
Signature
pow_scalar_element_matrix( : : MatrixID, Power : MatrixPowID)
Description
The operator pow_scalar_element_matrix computes the power of all
elements of the input Matrix by a constant value. The
input Matrix is given by the matrix handle
MatrixID. The power value Power is given by the parameter
Power. A new matrix MatrixPow is generated
with the result. The operator returns the matrix handle
MatrixPowID of the matrix MatrixPow. 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:
Power = [2.0]
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.
Power (input_control) number → (real / integer)
The power.
Default: 2.0
Suggested values: 0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0
MatrixPowID (output_control) matrix → (handle)
Matrix handle with the raised power of the input matrix.
Result
If the parameters are valid, the operator
pow_scalar_element_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
pow_scalar_element_matrix_mod,
pow_element_matrix,
pow_element_matrix_mod
See also
Module
Foundation