Operator Reference

sqrt_matrix_modT_sqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod (Operator)

sqrt_matrix_modT_sqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod — Compute the square root values of the elements of a matrix.

Signature

sqrt_matrix_mod( : : MatrixID : )

Herror T_sqrt_matrix_mod(const Htuple MatrixID)

void SqrtMatrixMod(const HTuple& MatrixID)

void HMatrix::SqrtMatrixMod() const

static void HOperatorSet.SqrtMatrixMod(HTuple matrixID)

void HMatrix.SqrtMatrixMod()

def sqrt_matrix_mod(matrix_id: HHandle) -> None

Description

The operator sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod computes the square root values of all elements of the input Matrix given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_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_matrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

Execution Information

  • 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:

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

Parameters

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_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 sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix

Module

Foundation