abs_matrix_modT_abs_matrix_modAbsMatrixModAbsMatrixModabs_matrix_mod (Operator)

Name

abs_matrix_modT_abs_matrix_modAbsMatrixModAbsMatrixModabs_matrix_mod — Compute the absolute values of the elements of a matrix.

Signature

abs_matrix_mod( : : MatrixID : )

Herror T_abs_matrix_mod(const Htuple MatrixID)

void AbsMatrixMod(const HTuple& MatrixID)

void HMatrix::AbsMatrixMod() const

static void HOperatorSet.AbsMatrixMod(HTuple matrixID)

void HMatrix.AbsMatrixMod()

def abs_matrix_mod(matrix_id: HHandle) -> None

Description

The operator abs_matrix_modabs_matrix_modAbsMatrixModAbsMatrixModAbsMatrixModabs_matrix_mod computes the absolute values of all elements of the input Matrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. 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_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

Execution Information

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

Result

If the parameters are valid, the operator abs_matrix_modabs_matrix_modAbsMatrixModAbsMatrixModAbsMatrixModabs_matrix_mod returns the value 2 (H_MSG_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

abs_matrixabs_matrixAbsMatrixAbsMatrixAbsMatrixabs_matrix

Module

Foundation