External Interfaces Reference |
Create unpopulated N-dimensional numeric mxArray
C Syntax
#include "matrix.h" mxArray *mxCreateNumericArray(int ndim, const int *dims, mxClassID class, mxComplexity ComplexFlag);
Arguments
ndim
Number of dimensions. If you specify a value for ndim
that is less than 2, mxCreateNumericArray
automatically sets the number of dimensions to 2.
dims
The 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
. In most cases, there should be ndim
elements in the dims
array.
class
The way in which the numerical data is to be represented in memory. For example, specifying mxINT16_CLASS
causes each piece of numerical data in the mxArray
to be represented as a 16-bit signed integer. You can specify any class except for mxNUMERIC_CLASS
, mxSTRUCT_CLASS
, or mxCELL_CLASS
.
ComplexFlag
Specify either mxREAL
or mxCOMPLEX
. If the data you plan to put into the mxArray
has no imaginary components, specify mxREAL
. If the data will have some imaginary components, specify mxCOMPLEX
.
Returns
A pointer to the created mxArray
, if successful. If unsuccessful in a stand-alone (nonMEX-file) application, mxCreateNumericArray
returns NULL
. If unsuccessful in a MEX-file, the MEX-file terminates and control returns to the MATLAB prompt. mxCreateNumericArray
is unsuccessful when there is not enough free heap space to create the mxArray
.
Description
Call mxCreateNumericArray
to create an N-dimensional mxArray
in which all data elements have the numeric data type specified by class
. After creating the mxArray
, mxCreateNumericArray
initializes all its real data elements to 0. If ComplexFlag
equals mxCOMPLEX
, mxCreateNumericArray
also initializes all its imaginary data elements to 0. mxCreateNumericArray
differs from mxCreateDoubleMatrix
in two important respects:
mxCreateDoubleMatrix
are double-precision, floating-point numbers. The data elements in mxCreateNumericArray
could be any numerical type, including different integer precisions.
mxCreateDoubleMatrix
can create two-dimensional arrays only; mxCreateNumericArray
can create arrays of two or more dimensions.
mxCreateNumericArray
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.
Examples
See phonebook.c
and doubleelement.c
in the refbook
subdirectory of the examples
directory. For an additional example, see mxisfinite.c
in the mx
subdirectory of the examples directory.
See Also
mxClassID
, mxCreateDoubleMatrix
, mxCreateSparse
, mxCreateString
, mxComplexity
mxCreateLogicalScalar | mxCreateNumericMatrix |
© 1994-2005 The MathWorks, Inc.