pow_matrixT_pow_matrixPowMatrixPowMatrixpow_matrix (算子名称)

名称

pow_matrixT_pow_matrixPowMatrixPowMatrixpow_matrix — Compute the power functions of a matrix.

参数签名

pow_matrix( : : MatrixID, MatrixType, Power : MatrixPowID)

Herror T_pow_matrix(const Htuple MatrixID, const Htuple MatrixType, const Htuple Power, Htuple* MatrixPowID)

void PowMatrix(const HTuple& MatrixID, const HTuple& MatrixType, const HTuple& Power, HTuple* MatrixPowID)

HMatrix HMatrix::PowMatrix(const HString& MatrixType, const HTuple& Power) const

HMatrix HMatrix::PowMatrix(const HString& MatrixType, double Power) const

HMatrix HMatrix::PowMatrix(const char* MatrixType, double Power) const

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

static void HOperatorSet.PowMatrix(HTuple matrixID, HTuple matrixType, HTuple power, out HTuple matrixPowID)

HMatrix HMatrix.PowMatrix(string matrixType, HTuple power)

HMatrix HMatrix.PowMatrix(string matrixType, double power)

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

描述

该算子 pow_matrixpow_matrixPowMatrixPowMatrixPowMatrixpow_matrix 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. A new matrix MatrixPow is generated with the result. 该算子 returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowIDmatrix_pow_id of the matrix MatrixPow. Access to the elements of the matrix is possible e.g., with 该算子 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. The formula for the calculation of the result is:

Example:

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.

运行信息

参数表

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

The type of the input matrix.

Default: 'general' "general" "general" "general" "general" "general"

List of values: '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 (input_control)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The power.

Default: 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

MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowIDmatrix_pow_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the raised powered matrix.

结果

如果参数均有效,算子 pow_matrixpow_matrixPowMatrixPowMatrixPowMatrixpow_matrix 返回值 2 ( H_MSG_TRUE) . 如有必要,将引发异常。

可能的前置算子

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

可能的后置算子

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

可替代算子

pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod, 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

模块

Foundation