mxIsSparse (C)

Determine whether input is sparse mxArray

C Syntax

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

Description

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

Input Arguments

pm — MATLAB array

const mxArray*

Pointer to an mxArray array, specified as const mxArray*.

Examples

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

• phonebook.c

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

• mxgetnzmax.c

• mxsetdimensions.c

• mxsetnzmax.c

Version History

Introduced before R2006a