clear_matrixclear_matrixClearMatrixClearMatrix (Operator)

Name

clear_matrixclear_matrixClearMatrixClearMatrix — Free the memory of a matrix.

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:

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified) matrix(-array) → (integer)

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

Operators