Documentation Center

  • Trial Software
  • Product Updates

mxIsSparse (C and Fortran)

Determine whether input is sparse array

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 valid 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.

Examples

See the following examples in matlabroot/extern/examples/refbook.

See the following examples in matlabroot/extern/examples/mx.

Was this topic helpful?