clear_matrixT_clear_matrixClearMatrixClearMatrixclear_matrix (Operator)
Name
clear_matrixT_clear_matrixClearMatrixClearMatrixclear_matrix — Free the memory of a matrix.
Signature
Herror T_clear_matrix(const Htuple MatrixID)
def clear_matrix(matrix_id: MaybeSequence[HHandle]) -> None
Description
The operator clear_matrixclear_matrixClearMatrixClearMatrixclear_matrix frees the memory of the matrix
Matrix given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id.
After calling clear_matrixclear_matrixClearMatrixClearMatrixclear_matrix, the Matrix can no
longer be used. The matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id becomes
invalid.
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(-array) → HMatrix, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Matrix handle.
Result
If the parameters are valid, the operator clear_matrixclear_matrixClearMatrixClearMatrixclear_matrix
returns the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix
Module
Foundation