mxIsSparse (Fortran)

Determine whether input is sparse mxArray

Fortran Syntax

#include "fintrf.h"
integer*4 mxIsSparse(pm)
mwPointer pm

Description

mxIsSparse returns 1 if pm points to a sparse mxArray. Otherwise, it returns 0. Many routines (for example, mxGetIr and mxGetJc) require a sparse mxArray as input.

Input Arguments

pm — MATLAB array

mwPointer

Pointer to an mxArray array, specified as mwPointer.

Examples

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","mx","filename")]);

where filename is:

• mxsetdimensionsf.F

Version History

Introduced before R2006a