clear_matrixT_clear_matrixClearMatrixClearMatrixclear_matrix (Operator)

Name

clear_matrixT_clear_matrixClearMatrixClearMatrixclear_matrix — Free the memory of a matrix.

Signature

clear_matrix( : : MatrixID : )

Herror T_clear_matrix(const Htuple MatrixID)

void ClearMatrix(const HTuple& MatrixID)

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

void HMatrix::ClearMatrix() const

static void HOperatorSet.ClearMatrix(HTuple matrixID)

static void HMatrix.ClearMatrix(HMatrix[] matrixID)

void HMatrix.ClearMatrix()

def clear_matrix(matrix_id: MaybeSequence[HHandle]) -> None

Description

The operator clear_matrixclear_matrixClearMatrixClearMatrixClearMatrixclear_matrix frees the memory of the matrix MatrixMatrixMatrixMatrixmatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. After calling clear_matrixclear_matrixClearMatrixClearMatrixClearMatrixclear_matrix, the MatrixMatrixMatrixMatrixmatrixmatrix can no longer be used. The matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id becomes invalid.

Execution Information

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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_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_matrixClearMatrixClearMatrixClearMatrixclear_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Module

Foundation