Main Content

mxGetComplexSingles (C)

Complex data elements in mxSINGLE_CLASS array

C Syntax

#include "matrix.h"
mxComplexSingle *mxGetComplexSingles(const mxArray *pa);

Input Arguments

expand all

Pointer to an mxSINGLE_CLASS array.

Output Arguments

expand all

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

If mxArray is not an mxSINGLE_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 mxSINGLE_CLASS array.

Examples

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

API Version

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

mex -R2018a myMexFile.c
Introduced in R2018a