Accelerating the pace of engineering and science

• Trials

# isordinal

Determine whether input is ordinal categorical array

## Description

example

tf = isordinal(A) returns logical 1 (true) if A 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 and less than, in addition to tests for equality.

## Examples

expand all

### Determine Whether Categorical Array Is 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 =

medium
large
small
small
medium
large
medium
large
medium
small
```

Determine if the categories of A have a mathematical ordering.

`isordinal(A)`
```ans =

0```

A is not ordinal. You must use the 'Ordinal',true name-value pair argument in the function categorical to create an ordinal categorical array.

## Input Arguments

expand all

### A — Categorical arrayvector | matrix | multidimensional array

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