mxGetPi (Fortran)

(Not recommended) Imaginary data elements in mxDOUBLE_CLASS array

mxGetPi is not available in the interleaved complex API. Use mxGetComplexDoubles instead. For more information, see Version History.

Fortran Syntax

#include "fintrf.h"
mwPointer mxGetPi(pm)
mwPointer pm

Description

When building MEX files using the separate complex API, call mxGetPi to get the contents of the pi field. pi is an array containing the imaginary data of the mxArray. Use mxGetPi on arrays of type mxDOUBLE_CLASS only. For other numeric mxArray types, use mxGetImagData.

Call mxIsDouble to validate the mxArray type. Call mxIsComplex to determine whether the data is complex.

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

Input Arguments

pm — Pointer to MATLAB array

mwPointer

Pointer to a MATLAB array of type mxDOUBLE_CLASS, specified as mwPointer.

Complex Number Support: Yes

Output Arguments

pi — Pointer to data array

mwPointer | 0

Pointer to the first mxDouble element of the imaginary part of the data array within an mxArray, specified as mwPointer. The function returns 0 if no imaginary data exists or if an error occurs.

Complex Number Support: Yes

Version History

Introduced before R2006a

R2018b: Do not use separate complex API

Use the mxGetComplexDoubles function in the interleaved complex API instead of the mxGetPr and mxGetPi functions. This function verifies that the input array is complex and of type mxDOUBLE_CLASS.

MathWorks recommends that you create MEX files and update existing MEX files to use the typed, data-access functions in the interleaved complex API. For more information, see:

• Typed Data Access in C MEX Files

• MATLAB Support for Interleaved Complex API in MEX Functions

• Upgrade MEX Files to Use Interleaved Complex API

• Example convec.F

To build the MEX file, call mex with the -R2018a option.

R2018b: Error building mxGetPi with interleaved complex API

The mxGetPi function is only available in the separate complex API. To build myMexFile.F using this function, type:

mex -R2017b myMexFile.F

Existing MEX files built with this function continue to run.