iscategory

Test for categorical array categories

Syntax

tf = iscategory(A,catnames)

Description

tf = iscategory(A,catnames) returns an array containing logical 1 (true) where the data in catnames is a category of A. Otherwise, iscategory returns logical 0 (false).

tf is the same size as catnames.

Examples

Test for Categories

Create an ordinal categorical array, A.

A = categorical({'shirt' 'pants'; 'pants' 'hat'; 'shirt' 'pants'})

A = 3x2 categorical
     shirt      pants 
     pants      hat   
     shirt      pants 

A is a 3-by-2 categorical array.

Test if the articles of clothing, shirt, pants, socks, and shoes, are categories of A.

catnames = {'shirt' 'pants' 'socks' 'shoes'};
tf = iscategory(A,catnames)

tf = 1x4 logical array

   1   1   0   0

shirt and pants are categories of A, but socks and shoes are not.

iscategory does not tell us anything about the category, hat, which we did not include in catnames.

Test for Category with No Corresponding Data

Create a categorical array, A.

A = categorical({'plane' 'car' 'train' 'car' 'plane'},...
    {'boat' 'car' 'plane' 'train'})

A = 1x5 categorical
     plane      car      train      car      plane 

A is a 1-by-5 categorical array.

Test to see if boat is a category in A.

tf = iscategory(A,'boat')

tf = logical
   1

iscategory returns true, even though A does not contain any values from the category boat.

Input Arguments

A — Categorical array

vector | matrix | multidimensional array

Categorical array, specified as a vector, matrix, or multidimensional array.

catnames — Category names

character vector | cell array of character vectors | string array | categorical array

Category names, specified as a character vector, cell array of character vectors, string array, or categorical array.

Extended Capabilities

Tall Arrays

Calculate with arrays that have more rows than fit in memory.

This function fully supports tall arrays. For more information, see Tall Arrays.

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

This function fully supports code generation. For more information, see Code Generation for Categorical Arrays (MATLAB Coder).

Distributed Arrays

Partition large arrays across the combined memory of your cluster using Parallel Computing Toolbox™.

This function fully supports distributed arrays. For more information, see Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox).