ClassesClasses | | Operators

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrix (Operator)

Name

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

Signature

pow_scalar_element_matrix( : : MatrixID, Power : MatrixPowID)

Herror pow_scalar_element_matrix(const Hlong MatrixID, double Power, Hlong* 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)

Description

The operator pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix computes the power of all elements 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. A new matrix MatrixPowMatrixPowMatrixPowMatrixPowmatrixPow is generated with the result. The operator returns the matrix handle MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID of the matrix MatrixPowMatrixPowMatrixPowMatrixPowmatrixPow. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

Example:

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix.

PowerPowerPowerPowerpower (input_control)  number HTupleHTupleHtuple (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

MatrixPowIDMatrixPowIDMatrixPowIDMatrixPowIDmatrixPowID (output_control)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle with the raised power of the input matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix

Alternatives

pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod, pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixPowElementMatrix, pow_element_matrix_modpow_element_matrix_modPowElementMatrixModPowElementMatrixModPowElementMatrixMod

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixMod

Module

Foundation


ClassesClasses | | Operators