pow_scalar_element_matrixT_pow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrix (Operator)

Name

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

Signature

pow_scalar_element_matrix( : : MatrixID, Power : MatrixPowID)

The operator pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix 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. A new matrix MatrixPowMatrixPowMatrixPowMatrixPowmatrixPow is generated with the result. The operator returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID of the matrix MatrixPowMatrixPowMatrixPowMatrixPowmatrixPow. 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.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (handle)

Matrix handle of the input matrix.

PowerPowerPowerPowerpower (input_control) number → (real / integer)

The power.

Default value: 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

MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID (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_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.