External Interfaces/API Reference

mxIsLogicalScalarTrue

True if scalar mxArray of class mxLOGICAL is true

C Syntax

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

Arguments

array_ptr
   Pointer to an mxArray.

Returns

true if the value of the mxArray's logical, scalar element is true, and false otherwise.

Description

Use mxIsLogicalScalarTrue to determine whether the value of a scalar mxArray is true or false. For additional information on the use of logical variables in MATLAB, type help logical at the MATLAB prompt.

mxIsLogicalScalarTrue(pa) is equivalent to

• mxIsLogical(pa) && mxGetNumberOfElements(pa) == 1 &&
  mxGetLogicals(pa)[0] == true
  

See Also

mxIsLogicalScalar, mxIsLogical, mxGetLogicals, mxGetScalar

mxIsLogicalScalar

mxIsNaN