External Interfaces Reference

mxIsComplex

Determine if data is complex

C Syntax

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

Returns

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

Description

Use mxIsComplex to determine whether or not an imaginary part is allocated for an mxArray. The imaginary pointer pi is NULL 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 mxisfinite.c in the mx subdirectory of the examples directory.

For additional examples, see convec.c, phonebook.c, timestwo.c, and xtimesy.c in the refbook subdirectory of the examples directory; see explore.c, yprime.c, mexlock.c, and mexsettrapflag.c in the mex subdirectory of the examples directory; see mxcalcsinglesubscript.c, mxgeteps.c, and mxgetinf.c in the mx subdirectory of the examples directory.

See Also

mxIsNumeric

mxIsClass

mxIsDouble

© 1994-2005 The MathWorks, Inc.