pandas.CategoricalIndex.ordered#

property CategoricalIndex.ordered[source]#

Whether the categories have an ordered relationship.

Examples

For pandas.Series:

>>> ser = pd.Series(["a", "b", "c", "a"], dtype="category")
>>> ser.cat.ordered
False
>>> raw_cat = pd.Categorical(["a", "b", "c", "a"], ordered=True)
>>> ser = pd.Series(raw_cat)
>>> ser.cat.ordered
True

For pandas.Categorical:

>>> cat = pd.Categorical(["a", "b"], ordered=True)
>>> cat.ordered
True
>>> cat = pd.Categorical(["a", "b"], ordered=False)
>>> cat.ordered
False

For pandas.CategoricalIndex:

>>> ci = pd.CategoricalIndex(["a", "b"], ordered=True)
>>> ci.ordered
True
>>> ci = pd.CategoricalIndex(["a", "b"], ordered=False)
>>> ci.ordered
False