Operator Reference

HALCON Operator Reference / Matrix / Arithmetic
ClassesClasses | | Operators

pow_matrixT_pow_matrixPowMatrixPowMatrixpow_matrix (Operator)

pow_matrixT_pow_matrixPowMatrixPowMatrixpow_matrix — Compute the power functions of a matrix.

Signature

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

Description

The operator pow_matrixpow_matrixPowMatrixPowMatrixpow_matrix computes the power of the input Matrix by a constant value. The input Matrix is given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The power value is given by the parameter PowerPowerPowerpowerpower. A new matrix MatrixPow is generated with the result. The operator returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDmatrixPowIDmatrix_pow_id of the matrix MatrixPow. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix.

The type of the Matrix can be selected via MatrixTypeMatrixTypeMatrixTypematrixTypematrix_type. 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:

Example:

PowerPowerPowerpowerpower = [2.0], MatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'general'"general""general""general""general"

Attention

For MatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = '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 Matrix must contain the relevant information of the matrix. The strictly lower triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = '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.

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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixTypeMatrixTypeMatrixTypematrixTypematrix_type (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

The type of the input matrix.

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

List of values: 'general'"general""general""general""general", '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_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite", 'symmetric'"symmetric""symmetric""symmetric""symmetric", 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular"

PowerPowerPowerpowerpower (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

MatrixPowIDMatrixPowIDMatrixPowIDmatrixPowIDmatrix_pow_id (output_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the raised powered matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModpow_matrix_mod, eigenvalues_symmetric_matrixeigenvalues_symmetric_matrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrixeigenvalues_symmetric_matrix, eigenvalues_general_matrixeigenvalues_general_matrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrixeigenvalues_general_matrix

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

Module

Foundation

ClassesClasses | | Operators