ClassesClasses | | Operators

clear_matrixT_clear_matrixClearMatrixClearMatrix (Operator)

Name

clear_matrixT_clear_matrixClearMatrixClearMatrix — 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()

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

This operator modifies the state of the following input parameter:

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

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


ClassesClasses | | Operators