Skip to content

pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_modT_pow_scalar_element_matrix_mod🔗

Short description🔗

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

Signature🔗

pow_scalar_element_matrix_mod( matrix MatrixID, number Power )pow_scalar_element_matrix_mod( : : MatrixID, Power : )void PowScalarElementMatrixMod( const HTuple& MatrixID, const HTuple& Power )static void HOperatorSet.PowScalarElementMatrixMod( HTuple matrixID, HTuple power )def pow_scalar_element_matrix_mod( matrix_id: HHandle, power: Union[int, float] ) -> None

Herror T_pow_scalar_element_matrix_mod( const Htuple MatrixID, const Htuple Power )

void HMatrix::PowScalarElementMatrixMod( const HTuple& Power ) const

void HMatrix::PowScalarElementMatrixMod( double Power ) const

void HMatrix.PowScalarElementMatrixMod( HTuple power )

void HMatrix.PowScalarElementMatrixMod( double power )

Description🔗

The operator pow_scalar_element_matrix_modPowScalarElementMatrixMod computes the power of all elements of the input Matrix by a constant value. The input Matrix is given by the matrix handle MatrixIDmatrixIDmatrix_id. The power value is given by the parameter Powerpowerpower. The input matrix is overwritten with the result. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixGetFullMatrix. The formula for the calculation of the result is:

\[\begin{eqnarray*} \texttt{Matrix}_{ij} \quad = \quad {\texttt{Matrix}_{ij}}^{\textrm{Power}}. \end{eqnarray*}\]

Example:

Powerpowerpower = [2.0][2.0]

\[\begin{eqnarray*} \texttt{Matrix} = \left[ \begin{array}{rrr} 3.0 & 1.0 & 2.0 \\ 5.0 & 7.0 & 2.0 \\ 9.0 & 4.0 & 1.0 \end{array} \right] \end{eqnarray*}\]
\[\begin{eqnarray*} \to \qquad \texttt{Matrix} = \left[ \begin{array}{rrr} 9.0 & 1.0 & 4.0 \\ 25.0 & 49.0 & 4.0 \\ 81.0 & 16.0 & 1.0 \end{array} \right] \end{eqnarray*}\]

Execution information🔗

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🔗

MatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix → (handle)(handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)

Matrix handle of the input matrix.

Powerpowerpower (input_control) number → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

The power.

Default: 2.02.0
Suggested values: 0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.00.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Possible successors

get_full_matrixGetFullMatrix, get_value_matrixGetValueMatrix

Alternatives

pow_scalar_element_matrixPowScalarElementMatrix, pow_element_matrixPowElementMatrix, pow_element_matrix_modPowElementMatrixMod

See also

sqrt_matrixSqrtMatrix, sqrt_matrix_modSqrtMatrixMod

Module🔗

Foundation