mxSetComplexDoubles (C)

Set complex data elements in mxDOUBLE_CLASS array

expand all in page

C Syntax

#include "matrix.h"
int mxSetComplexDoubles(mxArray *pa, mxComplexDouble *dt);

Description

Use mxSetComplexDoubles to set mxComplexDouble data in the specified array.

All mxCreate* functions allocate heap space to hold data. Therefore, you do not ordinarily use this function to initialize the elements of an array. Rather, call the function to replace existing values with new values.

Input Arguments

expand all

Pointer to an mxDOUBLE_CLASS array.

Pointer to the first mxComplexDouble element of the data array. dt must be allocated by the functions mxCalloc or mxMalloc.

Output Arguments

expand all

Function status, returned as int. If successful, then the function returns 1.

If pa is NULL, then the function returns 0.

The function is unsuccessful when mxArray is not an unshared mxDOUBLE_CLASS array, or if the data is not allocated with mxCalloc. If the function is unsuccessful, then:

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

  • Standalone (non-MEX file) application — Function returns 0.

Examples

Refer to the arrayFillSetPr.c example in the matlabroot/extern/examples/refbook folder which copies existing data into an mxArray. The data in the example is defined as mxDouble. You can use this example as a pattern for any C numeric type, including complex. Suppose that you have an array with these values.

2.0 + 3.0i
3.0 + 4.0i

To modify this example for complex mxDouble data:

  • Declare data variables

    mxComplexDouble *dynamicData;
const mxComplexDouble data[] = {{2.0, 3.0}, {3.0, 4.0}};

  • Call mxCreateNumericMatrix with the mxCOMPLEX argument

  • Replace mxSetDoubles with mxSetComplexDoubles to put the C array into an mxArray

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

See Also

|