pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixpow_element_matrixT_pow_element_matrix
Short description
pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixpow_element_matrixT_pow_element_matrix — Compute the power functions of the elements of a matrix.
Signature
pow_element_matrix( matrix MatrixID, matrix MatrixExpID, out matrix MatrixPowID )pow_element_matrix( : : MatrixID, MatrixExpID : MatrixPowID )void PowElementMatrix( const HTuple& MatrixID, const HTuple& MatrixExpID, HTuple* MatrixPowID )static void HOperatorSet.PowElementMatrix( HTuple matrixID, HTuple matrixExpID, out HTuple matrixPowID )def pow_element_matrix( matrix_id: HHandle, matrix_exp_id: HHandle ) -> HHandle
Herror T_pow_element_matrix( const Htuple MatrixID, const Htuple MatrixExpID, Htuple* MatrixPowID )
HMatrix HMatrix::PowElementMatrix( const HMatrix& MatrixExpID ) const
HMatrix HMatrix.PowElementMatrix( HMatrix matrixExpID )
Description
The operator pow_element_matrixPowElementMatrix computes the power
of all elements of the input Matrix with the elements of
the input matrix MatrixExp. The input matrices
Matrix and MatrixExp are defined by the matrix
handles MatrixIDmatrixIDmatrix_id and MatrixExpIDmatrixExpIDmatrix_exp_id. Both matrices
must have identical dimensions. A new matrix
MatrixPow is generated with the result. The operator
returns the matrix handle MatrixPowIDmatrixPowIDmatrix_pow_id of the matrix
MatrixPow. 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{MatrixPow}_{ij} \quad = \quad {\texttt{Matrix}_{ij}}
^{\texttt{MatrixExp}_{ij}}.
\end{eqnarray*}\]
Example:
\[\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]
\qquad
\texttt{MatrixExp} =
\left[ \begin{array}{rrr}
1.0 & 2.0 & 2.0 \\
2.0 & 0.0 & 3.0 \\
0.5 & 3.0 & 1.0
\end{array} \right]
\end{eqnarray*}\]
\[\begin{eqnarray*}
\to \qquad
\texttt{MatrixPow} =
\left[ \begin{array}{rrr}
3.0 & 1.0 & 4.0 \\
25.0 & 1.0 & 8.0 \\
3.0 & 64.0 & 1.0
\end{array} \right]
\end{eqnarray*}\]
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
MatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)(handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)
Matrix handle of the input matrix of the base.
MatrixExpIDmatrixExpIDmatrix_exp_id (input_control) matrix → (handle)(handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)
Matrix handle of the input matrix with exponents.
MatrixPowIDmatrixPowIDmatrix_pow_id (output_control) matrix → (handle)(handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)HHandleHtuple (handle)
Matrix handle with the raised power of the input
matrix.
Result
If the parameters are valid, the operator pow_element_matrixPowElementMatrix
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_element_matrix_modPowElementMatrixMod, pow_scalar_element_matrixPowScalarElementMatrix, pow_scalar_element_matrix_modPowScalarElementMatrixMod
See also
sqrt_matrixSqrtMatrix, sqrt_matrix_modSqrtMatrixMod
Module
Foundation