mxIsLogical (C and Fortran)

Determine whether array is of type mxLogical

C Syntax

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

Fortran Syntax

#include "fintrf.h"
integer*4 mxIsLogical(pm)
mwPointer pm

Arguments

pm

Pointer to an mxArray

Returns

Logical 1 (true) if pm points to a logical mxArray. Otherwise, it returns logical 0 (false).

Description

Use mxIsLogical to determine whether MATLAB^® software treats the data in the mxArray as Boolean (logical). If an mxArray is logical, then MATLAB treats all zeros as meaning false and all nonzero values as meaning true.

Examples

See these examples in matlabroot/extern/examples/mx:

• mxislogical.c