mxIsSparse (C and Fortran)

Determine whether input is sparse array

C Syntax

#include "matrix.h"
bool mxIsSparse(const mxArray *pm);

Fortran Syntax

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



Pointer to an mxArray


Logical 1 (true) if pm points to a sparse mxArray, and logical 0 (false) otherwise. A false return value means that pm points to a full mxArray or that pm does not point to a valid mxArray.


Use mxIsSparse to determine whether pm points to a sparse mxArray. Many routines (for example, mxGetIr and mxGetJc) require a sparse mxArray as input.


See these examples in matlabroot/extern/examples/refbook:

See these examples in matlabroot/extern/examples/mx:

Introduced before R2006a