isprotected

R2026b

Determine if categories of categorical array are protected

Syntax

tf = isprotected(A)

Description

tf = isprotected(A) returns logical 1 (true) if the categories of a categorical array are protected. Otherwise, isprotected returns logical 0 (false).

• 1 (true) — When you assign new values to B, the values must belong to one of the existing categories. Therefore, you only can combine arrays that have the same categories. To add new categories to B, you must use the addcats function.

• 0 (false) — When you assign new values to B, the categories update automatically. Therefore, you can combine (nonordinal) categorical arrays that have different categories. The categories can update to include the categories from both arrays.

Examples

Input Arguments

A — Input array

categorical array

Input array, specified as a categorical array.

The categories of ordinal categorical arrays are always protected.

Output Arguments

tf — True or false result

1 | 0

True or false result, returned as a 1 or 0 of data type logical.

Extended Capabilities

Tall Arrays

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

The isprotected 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).

GPU Code Generation
Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The isprotected function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Distributed Arrays

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

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

Version History

Introduced in R2013b