mxIsComplex (C)

Determine whether data is complex

C Syntax

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

Description

Use mxIsComplex to determine whether an imaginary part is allocated for an mxArray. If an mxArray does not have any imaginary data, then the imaginary pointer pi is NULL. If an mxArray is complex, then pi points to an array of numbers.

Input Arguments

pm — MATLAB array

const mxArray*

Pointer to an mxArray array, specified as const mxArray*.

Examples

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","mx","filename")]);

where filename is:

• mxisfinite.c

• mxgetinf.c

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","refbook","filename")]);

where filename is:

• convec.c

• phonebook.c

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","mex","filename")]);

where filename is:

• explore.c

• yprime.c

• mexlock.c

Version History

Introduced before R2006a