bigframes.pandas.Index.isin#

Index.isin(values) → Index[source]#

Return a boolean array where the index values are in values.

Compute boolean array to check whether each index value is found in the passed set of values. The length of the returned boolean array matches the length of the index.

Examples:

>>> idx = bpd.Index([1,2,3])
>>> idx
Index([1, 2, 3], dtype='Int64')

Check whether each index value in a list of values.

>>> idx.isin([1, 4])
Index([True, False, False], dtype='boolean')

>>> midx = bpd.MultiIndex.from_arrays([[1,2,3],
...                                   ['red', 'blue', 'green']],
...                                   names=('number', 'color'))
>>> midx
MultiIndex([(1,   'red'),
            (2,  'blue'),
            (3, 'green')],
           names=['number', 'color'])

Parameters:

values (set or list-like) Sought values.

Returns:

Series of boolean values.

Return type:

bigframes.pandas.Series

Raises:

TypeError If object passed to isin() is not a list-like