mxGetNumberOfDimensions (C)

Number of dimensions in mxArray

C Syntax

#include "matrix.h"
mwSize mxGetNumberOfDimensions(const mxArray *pm);

Description

mxGetNumberOfDimensions returns the number of dimensions in the specified mxArray. The returned value is always 2 or greater.

To determine how many elements are in each dimension, call mxGetDimensions.

Input Arguments

pm — MATLAB array

const mxArray*

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

Examples

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

• explore.c

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

• findnz.c

• fulltosparse.c

• phonebook.c

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

• mxcalcsinglesubscript.c

• mxgeteps.c

• mxisfinite.c

Version History

Introduced before R2006a