mxIsSparse (MATLAB Application Program Interface)

True if a sparse mxArray

C Syntax

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

Arguments

array_ptr
Pointer to an mxArray.

Returns

1 if array_ptr points to a sparse mxArray; otherwise, returns 0. A return value of 0 means that array_ptr points to a full mxArray or that array_ptr does not point to a legal mxArray.

Description

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

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.