Skip to content

add Column.is_in #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 10, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions spec/API_specification/dataframe_api/column_object.py
Original file line number Diff line number Diff line change
Expand Up @@ -384,3 +384,22 @@ def isnan(self) -> Column:
Does *not* include 'missing' or 'null' entries.
In particular, does not check for `np.timedelta64('NaT')`.
"""

def is_in(self, values: Column) -> Column[bool]:
"""
Indicate whether the value at each row matches any value in `values`.

Parameters
----------
values : Column
Contains values to compare against. May include ``float('nan')`` and
``namespace.null``, which which case ``'nan'`` and ``null`` will
respectively return ``True`` even though ``float('nan') == float('nan')``
isn't ``True``.
The dtype of `values` must match the current column's dtype.

Returns
-------
Column[bool]
"""
...