Documentation Center

  • Trial Software
  • Product Updates

mxGetM (C and Fortran)

Number of rows in array

C Syntax

#include "matrix.h"
size_t mxGetM(const mxArray *pm);

Fortran Syntax

mwPointer mxGetM(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Number of rows in the mxArray to which pm points.

Description

mxGetM returns the number of rows in the specified array. The term rows always means the first dimension of the array, no matter how many dimensions the array has. For example, if pm points to a four-dimensional array having dimensions 8-by-9-by-5-by-3, mxGetM returns 8.

    Note:   Fortran does not have an equivalent of size_t. mwPointer is a preprocessor macro that provides the appropriate Fortran type. The value returned by this function, however, is not a pointer.

See Also

mxGetN, mxSetM, mxSetN

Was this topic helpful?