Name
pow_scalar_element_matrix_modT_pow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod — Compute the power functions of the elements of a matrix.
Herror T_pow_scalar_element_matrix_mod(const Htuple MatrixID, const Htuple Power)
void PowScalarElementMatrixMod(const HTuple& MatrixID, const HTuple& Power)
void HMatrix::PowScalarElementMatrixMod(const HTuple& Power) const
void HMatrix::PowScalarElementMatrixMod(double Power) const
The operator pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod 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. The input matrix is overwritten with the result.
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:
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator modifies the state of the following input parameter:
The value of this parameter may not be shared across multiple threads without external synchronization.
Matrix handle of the input matrix.
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
If the parameters are valid, the operator
pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixMod returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix
get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix,
get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix
pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrix,
pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixPowElementMatrix,
pow_element_matrix_modpow_element_matrix_modPowElementMatrixModPowElementMatrixModPowElementMatrixMod
sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrix,
sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixMod
Foundation