MATLAB®

mxIsSparse (C and Fortran) - Determine whether input is sparse mxArray

C Syntax

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

Fortran Syntax

integer*4 mxIsSparse(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

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 legal mxArray.

Description

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

C Examples

See phonebook.c in the refbook subdirectory of the examples directory.

For additional examples, see mxgetnzmax.c, mxsetdimensions.c, and mxsetnzmax.c in the mx subdirectory of the examples directory.

See Also

mxGetIr, mxGetJc, mxCreateSparse

mxIsSingle (C and Fortran)

mxIsStruct (C and Fortran)