External Interfaces Reference |
Get imaginary data elements in mxArray
C Syntax
Arguments
array_ptr
Pointer to an mxArray
.
Returns
The imaginary data elements of the specified mxArray
, on success. Returns NULL
if there is no imaginary data or if there is an error.
Description
The pi
field points to an array containing the imaginary data of the mxArray
. Call mxGetPi
to get the contents of the pi
field; that is, to get the starting address of this imaginary data.
The best way to determine if an mxArray
is purely real is to call mxIsComplex
.
The imaginary parts of all input matrices to a MATLAB function are allocated if any of the input matrices are complex.
Examples
See convec.c
, findnz.c
, and fulltosparse.c
in the refbook
subdirectory of the examples
directory.
For additional examples, see explore.c
and mexcallmatlab.c
in the mex
subdirectory of the examples
directory; see mxcalcsinglesubscript.c
, mxgetinf.c
, mxisfinite.c
, and mxsetnzmax.c
in the mx
subdirectory of the examples
directory.
See Also
mxGetNzmax | mxGetPr |
© 1994-2005 The MathWorks, Inc.