mxIsClass (External Interfaces/API Reference)

True if mxArray is a member of the specified class

C Syntax

#include "matrix.h"
bool mxIsClass(const mxArray *array_ptr, const char *name);

Arguments
array_ptr
Pointer to an array.

name

The array category that you are testing. Specify name as a string (not as an enumerated constant). You can specify any one of the following predefined constants:


Value of Name	Corresponding Class
`double`	`mxDOUBLE_CLASS`
`sparse`	`mxSPARSE_CLASS`
`char`	`mxCHAR_CLASS`
`cell`	`mxCELL_CLASS`
`struct`	`mxSTRUCT_CLASS`
`single`	`mxSINGLE_CLASS`
`int8`	`mxINT8_CLASS`
`uint8`	`mxUINT8_CLASS`
`int16`	`mxINT16_CLASS`
`uint16`	`mxUINT16_CLASS`
`int32`	`mxINT32_CLASS`
`uint32`	`mxUINT32_CLASS`
<`class_name`>	mxOBJECT_`CLASS`
unknown	mxUNKNOWN_`CLASS`

In the table, <class_name> represents the name of a sepcific MATLAB or custom object.

Or, you can specify one of your own class names.

For example,

mxIsClass("double");

is equivalent to calling

mxIsDouble(array_ptr);

which is equivalent to calling

strcmp(mxGetClassName(array_ptr), "double");

Note that it is most efficient to use the mxIsDouble form.

Returns

true if array_ptr points to an array having category name, and false otherwise.

Description

Each mxArray is tagged as being a certain type. Call mxIsClass to determine if the specified mxArray has this type.

Example

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

mxIsChar mxIsComplex