mxGetComplexDoubles (C)

Complex data elements in mxDOUBLE_CLASS array

C Syntax

#include "matrix.h"
mxComplexDouble *mxGetComplexDoubles(const mxArray *pa);

Input Arguments

pa — MATLAB array

const mxArray *

Pointer to an mxDOUBLE_CLASS array.

Output Arguments

dt — Data array

mxComplexDouble *

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

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 NULL. A NULL return value indicates that pa is either empty or not an mxDOUBLE_CLASS array.

Examples

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

• explore.c

API Version

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

mex -R2018a myMexFile.c

Version History

Introduced in R2018a