clear_matrixT_clear_matrixClearMatrixClearMatrix (Operator)
Name
clear_matrixT_clear_matrixClearMatrixClearMatrix — Free the memory of a matrix.
Signature
Herror T_clear_matrix(const Htuple MatrixID)
Description
The operator clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix frees the memory of the matrix
MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID.
After calling clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix, the MatrixMatrixMatrixMatrixmatrix can no
longer be used. The matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID 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
MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified) matrix(-array) → HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Matrix handle.
Result
If the parameters are valid, the operator clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Possible Predecessors
create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix
Module
Foundation