CategoricalIndex

class CategoricalIndex

Index based on an underlying Categorical.

Example

import pandasCore as pd

# Create CategoricalIndex
idx = pd.CategoricalIndex([1, 2, 3], name='my_index')
print(len(idx))  # 3

Attributes

Attribute	Description	Example
categories
codes
dtype
empty
name
ordered
size

Construction

Method	Description	Example
__init__() (data: object = None, categories: object = None, ordered: object = None, dtype: object = None, copy: bool = False, name: object = None)		View

Statistics

Method	Description	Example
max() ()
min() ()
nunique() ()

Comparison

Method	Description	Example
__eq__() (value: str)
__ge__() (value: str)
__gt__() (value: str)
__le__() (value: str)
__lt__() (value: str)
__ne__() (value: str)
equals() (other: pandasCore.CategoricalIndex)

I/O

Method	Description	Example
tolist() ()

Conversion

Method	Description	Example
copy() ()

Iteration

Method	Description	Example
__len__() ()

Set Operations

Method	Description	Example
unique() ()

Categorical Methods

Method	Description	Example
add_categories() (new_categories: collections.abc.Sequence[str])
as_ordered() ()
as_unordered() ()
remove_categories() (removals: collections.abc.Sequence[str])
rename_categories() (new_categories: object)
reorder_categories() (new_categories: collections.abc.Sequence[str])
set_categories() (new_categories: collections.abc.Sequence[str], rename: bool = False)

Other Methods

Method	Description	Example
__hash__() ()
__repr__() ()
__str__() ()

Code Examples

The following examples are extracted from the test suite.

__init__ (test_categoricalindex_comp.py:39)

ctx = TestContext()


# ==================== Test Functions ====================

def test_categoricalindex_construction():
    """Test CategoricalIndex construction with various parameters"""
    f_print_header("Test: CategoricalIndex Construction")

    # Basic construction with no arguments
    pc_idx = pandasCore.CategoricalIndex()
    ctx.assert_equal(0, len(pc_idx), "CategoricalIndex() - empty")

    # Construction with data
    try:
        pc_idx2 = pandasCore.CategoricalIndex(data=['a', 'b', 'c', 'a', 'b'])
        pd_idx2 = pd.CategoricalIndex(['a', 'b', 'c', 'a', 'b'])
        ctx.assert_equal(len(pd_idx2), len(pc_idx2), "CategoricalIndex with data - length")
    except Exception as e:
        f_print_warning(f"CategoricalIndex data construction not fully supported: {e}")
        # Test passes if construction works even without data