External Interfaces/API Reference

mxCreateSparseLogicalMatrix

Create unpopulated two-dimensional, sparse, logical mxArray

C Syntax

• #include "matrix.h"
  mxArray *mxCreateSparseLogicalMatrix(int m, int n);
  

Arguments

m
   The desired number of rows.

n
   The desired number of columns.

Returns

A pointer to the created mxArray, if successful. If unsuccessful in a stand-alone (nonMEX-file) application, mxCreateSparseLogicalMatrix returns NULL. If unsuccessful in a MEX-file, the MEX-file terminates and control returns to the MATLAB prompt. mxCreateSparseLogicalMatrix is unsuccessful when there is not enough free heap space to create the mxArray.

Description

Use mxCreateSparseLogicalMatrix to create an m-by-n mxArray of logical (true and false) elements. mxCreateSparseLogicalMatrix initializes each element in the array to false.

Call mxDestroyArray when you finish using the mxArray. mxDestroyArray deallocates the mxArray and its elements.

See Also

mxCreateLogicalMatrix, mxCreateLogicalArray, mxCreateLogicalScalar, mxCreateSparse, mxIsLogical

mxCreateSparse

mxCreateString