This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

mxSetComplexInt8s (C)

Set complex data elements in mxINT8_CLASS array

C Syntax

#include "matrix.h"
int mxSetComplexInt8s(mxArray* pa, mxComplexInt8* dt);

Description

Use mxSetComplexInt8s to set mxComplexInt8 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.

This function does not free memory allocated for existing data. To free existing memory, call mxFree on the pointer returned by mxGetComplexInt8s.

Input Arguments

expand all

Pointer to an mxINT8_CLASS array.

Pointer to the first mxComplexInt8 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 mxINT8_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.

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