mxGetDimensions (MATLAB Application Program Interface)

Get a pointer to the dimensions array

C Syntax

#include "matrix.h"
const int *mxGetDimensions(const mxArray *array_ptr);

Arguments

array_ptr
Pointer to an mxArray.

Returns

The address of the first element in a dimension array. Each integer in the dimensions array represents the number of elements in a particular dimension. The array is not NULL-terminated.

Description

Use mxGetDimensions to determine how many elements are in each dimension of the mxArray that array_ptr points to. Call mxGetNumberOfDimensions to get the number of dimensions in the mxArray.

Examples

See mxcalcsinglesubscript.c in the mx subdirectory of the examples directory.

For additional examples, see findnz.c and phonebook.c in the refbook subdirectory of the examples directory; see explore.c in the mex subdirectory of the examples directory; see mxgeteps.c and mxisfinite.c in the mx subdirectory of the examples directory.