matGetFull (MATLAB Application Program Interface)

Reads full mxArrays from MAT-files

Fortran Syntax

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

Arguments

mfp

Pointer to MAT-file information.

name

Name of mxArray to get or put to MAT-file.

Row dimension.

Column dimension.

pr

Pointer to real part.

pi

Pointer to imaginary part.

Description

Most MATLAB applications work only with full (nonsparse) mxArrays. This routine provides an easy way to copy a full mxArray out of a MAT-file. It offers an alternative to matGetMatrix, which does not require use of the mxArray structure.

matGetFull reads the named mxArray from the MAT-file pointed to by mfp 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.

matGetFull returns 0 if successful, and 1 if the named variable can't be found, the named variable is not a full mxArray, or there is a file read error.

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

If the mxArray is pure real, the imaginary pointer is 0.

Note: This routine will become obsolete in a future version. Use matGetMatrix, mxGetPr, mxGetPi, mxGetM, and mxGetN instead.

[ Previous | Help Desk | Next ]