pow_matrix_modT_pow_matrix_modPowMatrixModPowMatrixModpow_matrix_mod (算子)

名称

pow_matrix_modT_pow_matrix_modPowMatrixModPowMatrixModpow_matrix_mod — 计算矩阵的幂函数。

签名

pow_matrix_mod( : : MatrixID, MatrixType, Power : )

Herror T_pow_matrix_mod(const Htuple MatrixID, const Htuple MatrixType, const Htuple Power)

void PowMatrixMod(const HTuple& MatrixID, const HTuple& MatrixType, const HTuple& Power)

void HMatrix::PowMatrixMod(const HString& MatrixType, const HTuple& Power) const

void HMatrix::PowMatrixMod(const HString& MatrixType, double Power) const

void HMatrix::PowMatrixMod(const char* MatrixType, double Power) const

void HMatrix::PowMatrixMod(const wchar_t* MatrixType, double Power) const   ( Windows only)

static void HOperatorSet.PowMatrixMod(HTuple matrixID, HTuple matrixType, HTuple power)

void HMatrix.PowMatrixMod(string matrixType, HTuple power)

void HMatrix.PowMatrixMod(string matrixType, double power)

def pow_matrix_mod(matrix_id: HHandle, matrix_type: str, power: Union[int, float]) -> None

描述

算子 pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod computes the power of the input Matrix by a constant value. The input Matrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The power value is given by the parameter PowerPowerPowerPowerpowerpower. The input matrix is overwritten with the result.可通过算子 get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix 等方式访问该矩阵的元素。

The type of the Matrix can be selected via MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type. The following values are supported: 'general'"general""general""general""general""general" for general, 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric" for symmetric, 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite" for symmetric positive definite, 'upper_triangular'"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""permuted_upper_triangular" for permuted upper triangular, 'lower_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""permuted_lower_triangular" for permuted lower triangular matrices. 结果的计算公式为:

示例:

PowerPowerPowerPowerpowerpower = [2.0], MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'general'"general""general""general""general""general"

注意

For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", or 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular" the upper triangular part of the input Matrix must contain the relevant information of the matrix. The strictly lower triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular" the lower triangular part of the input Matrix 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 Matrix is not of the specified type, an exception is raised.

pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod modifies the content of an already existing matrix.

执行信息

此算子修改后续输入参数的状态:

在执行此算子时,若该参数值需在多个线程间使用,则必须对其访问进行同步。

参数

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (输入控制,状态被修改)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

输入矩阵的矩阵句柄。

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type (输入控制)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

The type of the input matrix.

默认值: 'general' "general" "general" "general" "general" "general"

值列表: 'general'"general""general""general""general""general", 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular", 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular", 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular"

PowerPowerPowerPowerpowerpower (输入控制)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The power.

默认值: 2.0

建议值: 0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0

结果

如果参数有效,算子 pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod 返回值 2 ( H_MSG_TRUE )。如有必要,则抛出异常。

可能的前趋

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

可能的后继

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

替代

pow_matrixpow_matrixPowMatrixPowMatrixPowMatrixpow_matrix, eigenvalues_symmetric_matrixeigenvalues_symmetric_matrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrixeigenvalues_symmetric_matrix, eigenvalues_general_matrixeigenvalues_general_matrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrixeigenvalues_general_matrix

另见

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

模块

基础