mxIsComplex (Fortran)

Determine whether data is complex

Fortran Syntax

#include "fintrf.h"
integer*4 mxIsComplex(pm)
mwPointer pm

Description

mxIsComplex returns 1 if an imaginary part is allocated for an mxArray. If an mxArray does not have any imaginary data, then the function returns 0. If an mxArray is complex, then pi points to an array of numbers.

Input Arguments

pm — MATLAB array

mwPointer

Pointer to an mxArray array, specified as mwPointer.

Examples

See these examples in matlabroot/extern/examples/refbook:

• convec.F

• fulltosparse.F

Version History

Introduced before R2006a