sqrt_matrixT_sqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix (Operator)

Name

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_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix computes the square root values of all elements of the input MatrixMatrixMatrixMatrixmatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrtmatrix_sqrt is generated with the result. The operator returns the matrix handle MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtIDmatrix_sqrt_id of the matrix MatrixSqrtMatrixSqrtMatrixSqrtMatrixSqrtmatrixSqrtmatrix_sqrt. 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

Parameters

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

Matrix handle of the input matrix.

MatrixSqrtIDMatrixSqrtIDMatrixSqrtIDMatrixSqrtIDmatrixSqrtIDmatrix_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_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix returns the value 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

sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

See also

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix, pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod

Module

Foundation