Skip to content

clear_matrixClearMatrixClearMatrixclear_matrixT_clear_matrix🔗

Short description🔗

clear_matrixClearMatrixClearMatrixclear_matrixT_clear_matrix — Free the memory of a matrix.

Signature🔗

clear_matrix( matrix MatrixID )void ClearMatrix( const HTuple& MatrixID )static void HOperatorSet.ClearMatrix( HTuple matrixID )def clear_matrix( matrix_id: MaybeSequence[HHandle] ) -> None

Herror T_clear_matrix( const Htuple MatrixID )

static void HMatrix::ClearMatrix( const HMatrixArray& MatrixID )

void HMatrix::ClearMatrix( ) const

static void HMatrix.ClearMatrix( HMatrix[] matrixID )

void HMatrix.ClearMatrix( )

Description🔗

The operator clear_matrixClearMatrix frees the memory of the matrix Matrix given by the matrix handle MatrixIDmatrixIDmatrix_id. After calling clear_matrixClearMatrix, the Matrix can no longer be used. The matrix handle MatrixIDmatrixIDmatrix_id becomes invalid.

Execution information🔗

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🔗

MatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix(-array) → (handle)HTuple (HHandle)HMatrix, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Matrix handle.

Result🔗

If the parameters are valid, the operator clear_matrixClearMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_matrixCreateMatrix

Module🔗

Foundation