MATLAB®

mxCreateSparseLogicalMatrix (C) - Create unpopulated 2-D, sparse, logical mxArray

C Syntax

#include "matrix.h"
mxArray *mxCreateSparseLogicalMatrix(mwSize m, mwSize n, 
  mwSize nzmax);

Arguments

m

The desired number of rows

n

The desired number of columns

nzmax

The number of elements that mxCreateSparseLogicalMatrix should allocate to hold the data. Set the value of nzmax to be greater than or equal to the number of nonzero elements you plan to put into the mxArray, but make sure that nzmax is less than or equal to m*n.

Returns

A pointer to the created mxArray, if successful. If unsuccessful in a stand alone (non-MEX-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 mxLogical elements. mxCreateSparseLogicalMatrix initializes each element in the array to logical 0.

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

See Also

mxCreateLogicalArray, mxCreateLogicalMatrix, mxCreateLogicalScalar, mxCreateSparse, mxIsLogical

mxCreateSparse (C and Fortran)

mxCreateString (C and Fortran)