pow_matrix_modpow_matrix_modpow_matrix_modPowMatrixModPowMatrixMod (Operator)

Name

pow_matrix_modpow_matrix_modpow_matrix_modPowMatrixModPowMatrixMod — Compute the power functions of a matrix.

Signature

Description

The operator pow_matrix_modpow_matrix_modpow_matrix_modPowMatrixModPowMatrixMod computes the power 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_matrixget_full_matrixGetFullMatrixGetFullMatrix.

The type of the MatrixMatrixMatrixMatrixmatrix can be selected via MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixType. The following values are supported: 'general'"general""general""general""general" for general, 'symmetric'"symmetric""symmetric""symmetric""symmetric" for symmetric, 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite" for symmetric positive definite, 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular" for upper triangular, 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular" for permuted upper triangular, 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular" for lower triangular, and 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular" for permuted lower triangular matrices. The formula for the calculation of the result is:

                       MatrixPower
  Matrix   =   Matrix             .

Example:

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

                 / 32.0  18.0  10.0 \
  ->    Matrix = | 68.0  62.0  26.0 |
                 \ 56.0  41.0  27.0 /

Attention

For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixType = 'symmetric'"symmetric""symmetric""symmetric""symmetric", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite", or 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular" the upper triangular part of the input MatrixMatrixMatrixMatrixmatrix must contain the relevant information of the matrix. The strictly lower triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixType = 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular" the lower triangular part of the input MatrixMatrixMatrixMatrixmatrix must contain the relevant information of the matrix. The strictly upper triangular part of the matrix is not referenced. If the referenced part of the input MatrixMatrixMatrixMatrixmatrix is not of the specified type, an exception is raised.

pow_matrix_modpow_matrix_modpow_matrix_modPowMatrixModPowMatrixMod modifies the content of an already existing matrix.

Parallelization

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

Parameters

Result

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

Possible Predecessors

create_matrixcreate_matrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixget_full_matrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixget_value_matrixGetValueMatrixGetValueMatrix

Alternatives

pow_matrixpow_matrixpow_matrixPowMatrixPowMatrix, eigenvalues_symmetric_matrixeigenvalues_symmetric_matrixeigenvalues_symmetric_matrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrix, eigenvalues_general_matrixeigenvalues_general_matrixeigenvalues_general_matrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrix

See also

sqrt_matrixsqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrix, sqrt_matrix_modsqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixMod

Module

Foundation