Operator Reference

sqrt_matrixT_sqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix (Operator)

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

Signature

sqrt_matrix( : : MatrixID : MatrixSqrtID)

Herror T_sqrt_matrix(const Htuple MatrixID, Htuple* MatrixSqrtID)

void SqrtMatrix(const HTuple& MatrixID, HTuple* MatrixSqrtID)

HMatrix HMatrix::SqrtMatrix() const

static void HOperatorSet.SqrtMatrix(HTuple matrixID, out HTuple matrixSqrtID)

HMatrix HMatrix.SqrtMatrix()

def sqrt_matrix(matrix_id: HHandle) -> HHandle

Description

The operator sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix computes the square root values of all elements of the input Matrix given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixSqrt is generated with the result. The operator returns the matrix handle MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtIDmatrix_sqrt_id of the matrix MatrixSqrt. 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.

Parameters

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtIDmatrix_sqrt_id (output_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle with the square root values of the input matrix.

Result

If the parameters are valid, the operator sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix 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_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

See also

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix, pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod

Module

Foundation