MATLAB Application Program Interface Reference Help Desk

matGetFull

Purpose

Reads full mxArrays from MAT-files

Fortran Syntax

Arguments

mfp

Pointer to MAT-file information.

m

Row dimension.

n

Column dimension.

name

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

pi

Pointer to imaginary part.

pr

Pointer to real part.

Description

Most MATLAB applications work only with full (non-sparse) 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.

Examples

Read the mxArray A from one MAT-file and write it out to another.

Write a simple real mxArray into a MAT-file. Name the mxArray A and the MAT-file foo.mat.

To test, run the second example; then go to MATLAB and enter:

Note: Fortran MAT-file routines are not available on Windows.



[ Previous | Help Desk | Next ]