mxCreateLogicalArray (C) - Create N-D logical mxArray initialized to false
C Syntax
#include "matrix.h"
mxArray *mxCreateLogicalArray(mwSize ndim, const mwSize *dims);
Arguments
- ndim
Number of dimensions. If you specify a value for ndim that
is less than 2, mxCreateLogicalArray automatically
sets the number of dimensions to 2.
- dims
Dimensions array. Each element in the dimensions array contains
the size of the array in that dimension. For example, setting dims[0] to 5 and dims[1] to 7 establishes
a 5-by-7 mxArray.
There should be ndim elements in the dims array.
Returns
Pointer to the created mxArray,
if successful. If unsuccessful in a stand alone (non-MEX-file) application, mxCreateLogicalArray returns NULL.
If unsuccessful in a MEX-file, the MEX-file terminates and control
returns to the MATLAB prompt. mxCreateLogicalArray is
unsuccessful when there is not enough free heap space to create the mxArray.
Description
Call mxCreateLogicalArray to create an
N-dimensional mxArray of mxLogical elements.
After creating the mxArray, mxCreateLogicalArray initializes
all its elements to logical 0. mxCreateLogicalArray differs
from mxCreateLogicalMatrix in that the latter
can create two-dimensional arrays only.
mxCreateLogicalArray allocates dynamic
memory to store the created mxArray. When you finish
with the created mxArray, call mxDestroyArray to
deallocate its memory.
Any trailing singleton dimensions specified in the dims argument
are automatically removed from the resulting array. For example, if ndim equals 5 and dims equals [4
1 7 1 1], the resulting array is given the dimensions 4-by-1-by-7.
See Also
mxCreateLogicalMatrix, mxCreateSparseLogicalMatrix, mxCreateLogicalScalar
 | mxCreateDoubleScalar (C and Fortran) | | mxCreateLogicalMatrix (C) |  |
Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.
Get the Interactive Kit
Store 
