pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrix (Operator)

Name

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

Signature

pow_scalar_element_matrix( : : MatrixID, Power : MatrixPowID)

Description

The operator pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrix computes the power of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix by a constant value. The input MatrixMatrixMatrixMatrixMatrixmatrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The power value is given by the parameter PowerPowerPowerPowerPowerpower. A new matrix MatrixPowMatrixPowMatrixPowMatrixPowMatrixPowmatrixPow is generated with the result. The operator returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID of the matrix MatrixPowMatrixPowMatrixPowMatrixPowMatrixPowmatrixPow. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:


                          MatrixPower
  MatrixPow   =   Matrix             .
           ij           ij

Example:


           / 3.0  1.0  2.0 \
  Matrix = | 5.0  7.0  2.0 |      Power = [ 2.0 ]
           \ 9.0  4.0  1.0 /

                    /  9.0   1.0   4.0 \
  ->    MatrixPow = | 25.0  49.0   4.0 |
                    \ 81.0  16.0   1.0 /

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

PowerPowerPowerPowerPowerpower (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

MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID (output_control) matrix → (integer)

Matrix handle with the raised power of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Alternatives

pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod, pow_element_matrixpow_element_matrixPowElementMatrixpow_element_matrixPowElementMatrixPowElementMatrix, pow_element_matrix_modpow_element_matrix_modPowElementMatrixModpow_element_matrix_modPowElementMatrixModPowElementMatrixMod

Module

Foundation

Operators