pow_scalar_element_matrix_modT_pow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod (Operator)

Name

pow_scalar_element_matrix_modT_pow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod — Compute the power functions of the elements of a matrix.

Signature

Description

The operator pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod computes the power of all elements of the input MatrixMatrixMatrixMatrixmatrix by a constant value. The input MatrixMatrixMatrixMatrixmatrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The power value is given by the parameter PowerPowerPowerPowerpower. 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_matrixGetFullMatrixGetFullMatrixGetFullMatrix. 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:

• MatrixIDMatrixIDMatrixIDMatrixIDmatrixID

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

Parameters

Result

If the parameters are valid, the operator pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix, pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixPowElementMatrix, pow_element_matrix_modpow_element_matrix_modPowElementMatrixModPowElementMatrixModPowElementMatrixMod

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixMod

Module

Foundation