mxSetPi (C and Fortran) - Set new imaginary data for mxArray
C Syntax
#include "matrix.h"
void mxSetPi(mxArray *pm, double *pi);
Fortran Syntax
mxSetPi(pm, pi)
mwPointer pm, pi
Arguments
- pm
Pointer to a full (nonsparse) mxArray
- pi
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. If pi points to static memory,
memory leaks and other memory errors may result.
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 mxCOMPLEX in
C (1 in Fortran) or by setting pi to
a non-NULL value in C (a nonzero value in Fortran)—you
do not ordinarily use mxSetPi to initialize the
created mxArray's imaginary elements. Rather, you
call mxSetPi to replace the initial imaginary
values with new ones.
This function does not free any memory allocated for existing
data that it displaces. To free existing memory, call mxFree on
the pointer returned by mxGetPi before you call mxSetPi.
C Examples
See mxisfinite.c and mxsetnzmax.c
in the matlabroot/extern/examples/mx folder
.
See Also
mxGetPi, mxGetPr, mxSetImagData, mxSetPr, mxFree
 | mxSetNzmax (C and Fortran) | | mxSetPr (C and Fortran) |  |
Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.
Get the Interactive Kit
Store 
