dtoolkit.accessor.index.to_set#

dtoolkit.accessor.index.to_set(index: Index, /, level: Union[int, Hashable] = None) → set[source]#

Return a set of the values.

A sugary syntax wraps set:

set(index)

Parameters

levelint or Hashable, optional: Only return values from specified level (for MultiIndex). If int, gets the level by integer position, else by level name.

Returns

set

See also

pandas.Index.unique
dtoolkit.accessor.series.to_set

Notes

Different to unique(), it returns Index.

Examples

>>> import dtoolkit
>>> import pandas as pd
>>> index = pd.Index([1, 2, 2])
>>> index
Int64Index([1, 2, 2], dtype='int64')
>>> index.to_set()
{1, 2}
>>> index = pd.MultiIndex.from_arrays(
...     [
...         [1, 1, 2, 2],
...         ['red', 'blue', 'red', 'blue'],
...     ],
...     names=['number', 'color'],
... )
>>> index
MultiIndex([(1,  'red'),
            (1, 'blue'),
            (2,  'red'),
            (2, 'blue')],
           names=['number', 'color'])
>>> index.to_set(0)
{1, 2}
>>> index.to_set('number')
{1, 2}