xorbits.pandas.Index.is_categorical#

final Index.is_categorical() → bool[source]#

Check if the Index holds categorical data.

Deprecated since version 2.0.0(pandas): Use isinstance(index.dtype, pd.CategoricalDtype) instead.

Returns: True if the Index is categorical.
Return type: bool

See also

CategoricalIndex: Index for categorical data.
is_boolean: Check if the Index only consists of booleans (deprecated).
is_integer: Check if the Index only consists of integers (deprecated).
is_floating: Check if the Index is a floating type (deprecated).
is_numeric: Check if the Index only consists of numeric data (deprecated).
is_object: Check if the Index is of the object dtype. (deprecated).
is_interval: Check if the Index holds Interval objects (deprecated).

Examples

>>> idx = pd.Index(["Watermelon", "Orange", "Apple",  
...                 "Watermelon"]).astype("category")
>>> idx.is_categorical()  
True

>>> idx = pd.Index([1, 3, 5, 7])  
>>> idx.is_categorical()  
False

>>> s = pd.Series(["Peter", "Victor", "Elisabeth", "Mar"])  
>>> s  
0        Peter
1       Victor
2    Elisabeth
3          Mar
dtype: object
>>> s.index.is_categorical()  
False

Warning

This method has not been implemented yet. Xorbits will try to execute it with pandas.

This docstring was copied from pandas.core.indexes.base.Index.