pow_scalar_element_matrixT_pow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix (Operator)

Name

pow_scalar_element_matrixT_pow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix — Compute the power functions of the elements of a matrix.

Signature

pow_scalar_element_matrix( : : MatrixID, Power : MatrixPowID)

Herror T_pow_scalar_element_matrix(const Htuple MatrixID, const Htuple Power, Htuple* MatrixPowID)

void PowScalarElementMatrix(const HTuple& MatrixID, const HTuple& Power, HTuple* MatrixPowID)

HMatrix HMatrix::PowScalarElementMatrix(const HTuple& Power) const

HMatrix HMatrix::PowScalarElementMatrix(double Power) const

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

HMatrix HMatrix.PowScalarElementMatrix(HTuple power)

HMatrix HMatrix.PowScalarElementMatrix(double power)

def pow_scalar_element_matrix(matrix_id: HHandle, power: Union[int, float]) -> HHandle

Description

The operator pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix computes the power of all elements of the input Matrix by a constant value. The input Matrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The power value Power is given by the parameter PowerPowerPowerPowerpowerpower. A new matrix MatrixPow is generated with the result. The operator returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowIDmatrix_pow_id of the matrix MatrixPow. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

PowerPowerPowerPowerpowerpower = [2.0]

Execution Information

Parameters

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

Matrix handle of the input matrix.

PowerPowerPowerPowerpowerpower (input_control)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The power.

Default value: 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 power of the input matrix.

Result

If the parameters are valid, the operator pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod, pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixPowElementMatrixpow_element_matrix, pow_element_matrix_modpow_element_matrix_modPowElementMatrixModPowElementMatrixModPowElementMatrixModpow_element_matrix_mod

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

Module

Foundation