mxGetComplexDoubles (Fortran)

Complex data elements in mxDOUBLE_CLASS array

Fortran Syntax

#include "fintrf.h"
mwPointer mxGetComplexDoubles(pa)
mwPointer pa

Input Arguments

pa — MATLAB array

mwPointer | 0

Pointer to an mxDOUBLE_CLASS array.

Output Arguments

dt — Data array

mwPointer

Pointer to the first mxComplexDouble element of the data. If pa is 0, then the function returns 0.

If mxArray is not an mxDOUBLE_CLASS array:

• MEX file — Function terminates the MEX file and returns control to the MATLAB^® prompt.

• Standalone (non-MEX file) application — Function returns 0. A 0 return value indicates that pa is either empty or not an mxDOUBLE_CLASS array.

Examples

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

• convec.F

• complexAdd.F

API Version

This function is available in the interleaved complex API. To build myMexFile.F using this function, type:

mex -R2018a myMexFile.F

Version History

Introduced in R2018b