Learn more about MATLAB

mxGetPi (C and Fortran) - Get imaginary data elements in mxArray

C Syntax

#include "matrix.h"
double *mxGetPi(const mxArray *pm);

Fortran Syntax

mwPointer mxGetPi(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Pointer to the imaginary data elements of the specified mxArray, on success. Returns NULL in C (0 in Fortran) 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 whether an mxArray is purely real is to call mxIsComplex.

If any of the input matrices to a function are complex, MATLAB allocates the imaginary parts of all input matrices.

C Examples

See convec.c, findnz.c, and fulltosparse.c in the matlabroot/extern/examples/refbook folder .

Additional examples:

• explore.c and mexcallmatlab.c in the matlabroot/extern/examples/mex folder

• mxcalcsinglesubscript.c, mxgetinf.c, mxisfinite.c, and mxsetnzmax.c in the matlabroot/extern/examples/mx folder

See Also

mxGetPr, mxSetPi, mxSetPr

mxGetNzmax (C and Fortran)

mxGetPr (C and Fortran)

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