MATLAB Application Program Interface
  Go to function:
    Search    Help Desk 
mxIsLogical    Examples   See Also

True if mxArray is Boolean

C Syntax

Arguments

array_ptr
  Pointer to an mxArray.

Returns

true if the mxArray's logical flag is on; otherwise, returns false. If an mxArray does not hold numerical 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.

Example

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

See Also

mxIsClass, mxSetLogical


[ Previous | Help Desk | Next ]