Learn more about MATLAB

mxIsComplex (C and Fortran) - Determine whether data is complex

C Syntax

#include "matrix.h"
bool mxIsComplex(const mxArray *pm);

Fortran Syntax

integer*4 mxIsComplex(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Logical 1 (true) if pm is a numeric array containing complex data, and logical 0 (false) otherwise. If pm points to a cell array or a structure array, mxIsComplex returns false.

Description

Use mxIsComplex to determine whether an imaginary part is allocated for an mxArray. The imaginary pointer pi is NULL in C (0 in Fortran) if an mxArray is purely real and does not have any imaginary data. If an mxArray is complex, pi points to an array of numbers.

Examples

See the following examples in matlabroot/extern/examples/mx.

• mxisfinite.c

• mxgetinf.c

See the following examples in matlabroot/extern/examples/refbook.

• convec.c

• convec.F

• fulltosparse.F

• phonebook.c

See the following examples in matlabroot/extern/examples/mex.

• explore.c

• yprime.c

• mexlock.c

See Also

mxIsNumeric

© 1984-2010- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS