mexGetFull (MATLAB Application Program Interface)

Routine to get component parts of a double-precision mxArray into a Fortran workspace

integer*4 function mexGetFull(name, m, n, pr, pi)
integer*4 m, n, pr, pi
character*(*) name

Arguments

m
Row dimension.

n
Column dimension.

name
Name of mxArray to get from workspace.

pi
Pointer to imaginary part.

pr
Pointer to real part.

Returns

0 if successful, and 1 otherwise.

Description

mexGetFull provides a way to copy data from a double-precision mxArray from the caller's workspace. It is an alternative to mexGetMatrix, which does not require use of the mxArray structure.

mexGetFull reads the named mxArray from the caller's workspace and places the row dimensions, column dimensions, real array pointer, and imaginary array pointer into the locations specified by m, n, pr, and pi, respectively. You can then use mxCopyPtrToReal8 to copy the data from the pointer into the Fortran workspace.

mexGetFull allocates memory for the real and imaginary arrays using mxCalloc; use mxFree to return it when you are done.

If the mxArray is purely real, the imaginary pointer is given 0.