Name
pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod — Compute the power functions of the elements of a matrix.
Herror pow_scalar_element_matrix_mod(const Hlong MatrixID, double Power)
Herror T_pow_scalar_element_matrix_mod(const Htuple MatrixID, const Htuple Power)
Herror pow_scalar_element_matrix_mod(const HTuple& MatrixID, const HTuple& Power)
void HMatrix::PowScalarElementMatrixMod(const HTuple& Power) const
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_modPowScalarElementMatrixModpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod computes the
power of all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix by a constant
value. The input MatrixMatrixMatrixMatrixMatrixmatrix is given by the matrix handle
MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The power value is given by the parameter
PowerPowerPowerPowerPowerpower. 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_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix. 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_modPowScalarElementMatrixModpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixMod returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix
get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix,
get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix
pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrix,
pow_element_matrixpow_element_matrixPowElementMatrixpow_element_matrixPowElementMatrixPowElementMatrix,
pow_element_matrix_modpow_element_matrix_modPowElementMatrixModpow_element_matrix_modPowElementMatrixModPowElementMatrixMod
sqrt_matrixsqrt_matrixSqrtMatrixsqrt_matrixSqrtMatrixSqrtMatrix,
sqrt_matrix_modsqrt_matrix_modSqrtMatrixModsqrt_matrix_modSqrtMatrixModSqrtMatrixMod
Foundation