External Interfaces/API Reference

mxIsLogical

True if mxArray is of class mxLOGICAL

C Syntax

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

Arguments

array_ptr
   Pointer to an mxArray.

Returns

true if the mxArray's logical flag is on, and false otherwise. If an mxArray does not hold numeric data (for instance, if array_ptr points to a structure mxArray or a cell mxArray), then mxIsLogical automatically returns False.

Description

Use mxIsLogical to determine whether MATLAB treats the data in the mxArray as Boolean (logical) or numerical (not logical).

If an mxArray is logical, then MATLAB treats all zeros as meaning false and all nonzero values as meaning true. For additional information on the use of logical variables in MATLAB, type help logical at the MATLAB prompt.

Examples

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

See Also

mxIsClass, mxSetLogical (Obsolete)

mxIsInt32

mxIsLogicalScalar