MATLAB Application Program Interface Reference

Set new imaginary data for an mxArray

subroutine mxSetPi(pm, pi)
integer*4 pm, pi

Arguments

Pointer to a full (nonsparse) mxArray.

Pointer to the first element of an array. Each element in the array contains the imaginary component of a value. The array must be in dynamic memory; call mxCalloc to allocate this dynamic memory.

Description

Use mxSetPi to set the imaginary data of the specified mxArray.

Most mxCreate functions optionally allocate heap space to hold imaginary data. If you tell an mxCreate function to allocate heap space (for example, by setting the ComplexFlag to COMPLEX = 1 or by setting pi to a non-0 value), then you do not ordinarily use mxSetPi to initialize the created mxArray's imaginary elements. Rather, you typically call mxSetPi to replace the initial imaginary values with new ones.