isordinal

Determine if input is ordinal categorical array

Syntax

tf = isordinal(A)

Description

tf = isordinal(A) returns logical 1 (true) if the input is an ordinal categorical array. Otherwise, isordinal returns logical 0 (false).

If a categorical array is ordinal, you can use relational operations for inequality comparisons, such as greater than and less than, in addition to tests for equality.

Examples

Determine if Categorical Arrays Are Ordinal

Create a categorical array containing the sizes of 10 objects. Use the names small, medium, and large for the values S, M, and L.

A = categorical(["M";"L";"S";"S";"M";"L";"M";"L";"M";"S"], ...
                ["S" "M" "L"], ...
                ["small" "medium" "large"])

A = 10x1 categorical
     medium 
     large 
     small 
     small 
     medium 
     large 
     medium 
     large 
     medium 
     small 

Determine if the categories of A have a mathematical ordering.

tf = isordinal(A)

tf = logical
   0

A is not ordinal. To create an ordinal categorical array, use the Ordinal=true name-value argument when you call the categorical function.

Convert A to an ordinal categorical array.

ordinalA = categorical(A,Ordinal=true);
tf = isordinal(ordinalA)

tf = logical
   1

Input Arguments

A — Input array

array

Input array.

Tips

• To convert a categorical array, A, from nonordinal to ordinal, use A = categorical(A,Ordinal=true).

• To convert a categorical array, A, from ordinal to nonordinal, use A = categorical(A,Ordinal=false).

Extended Capabilities

Tall Arrays

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

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

Thread-Based Environment

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

This 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™.

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

Version History

Introduced in R2013b

R2021b: isordinal accepts input argument having any data type

The isordinal function accepts an input argument having any data type. In previous releases, isordinal raised an error if the input argument was not a categorical array.