mxIsEmpty (MATLAB Application Program Interface)

True if mxArray is empty

C Syntax

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

Arguments

array_ptr
Pointer to an array.

Returns

true if the mxArray is empty; otherwise, returns false.

Description

Use mxIsEmpty to determine if an mxArray is empty. An mxArray is empty if the size of any of its dimensions is 0.

Attempts to access empty mxArray cause undesirable behavior. To avoid accessing empty arrays, test them by calling mxIsEmpty.

Note that mxIsEmpty is not the opposite of mxIsFull.

Example

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