Skip to content

Documented wrapping behavior of out of bound values of sorter #1601

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.

Sign up for GitHub

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 2 commits into from
Mar 21, 2024
Merged

Documented wrapping behavior of out of bound values of sorter #1601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9962dd2
Made explicit wrapping behavior of out of bound values of sorter
oleksandr-pavlyk Mar 20, 2024
dd36894
Added test for out of bounds indices in sorter
oleksandr-pavlyk Mar 20, 2024
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
4 changes: 3 additions & 1 deletion dpctl/tensor/_searchsorted.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def searchsorted(
*,
side: Literal["left", "right"] = "left",
sorter: Union[usm_ndarray, None] = None,
):
) -> usm_ndarray:
"""searchsorted(x1, x2, side='left', sorter=None)

Finds the indices into `x1` such that, if the corresponding elements
Expand Down Expand Up @@ -50,6 +50,8 @@ def searchsorted(
sorter (Optional[usm_ndarray]):
array of indices that sort `x1` in ascending order. The array must
have the same shape as `x1` and have an integral data type.
Out of bound index values of `sorter` array are treated using
`"wrap"` mode documented in :py:func:`dpctl.tensor.take`.
Default: `None`.
"""
if not isinstance(x1, usm_ndarray):
Expand Down
15 changes: 15 additions & 0 deletions dpctl/tests/test_usm_ndarray_searchsorted.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,3 +340,18 @@ def test_pw_linear_interpolation_example():
exp = dpt.vecdot(vals[1:] + vals[:-1], bins[1:] - bins[:-1]) / 2

assert dpt.abs(av - exp) < 0.1


def test_out_of_bound_sorter_values():
get_queue_or_skip()

x = dpt.asarray([1, 2, 0], dtype="i4")
n = x.shape[0]

# use out-of-bounds indices in sorter
sorter = dpt.asarray([2, 0 - n, 1 - n], dtype="i8")

x2 = dpt.arange(3, dtype=x.dtype)
p = dpt.searchsorted(x, x2, sorter=sorter)
# verify that they were applied with mode="wrap"
assert dpt.all(p == dpt.arange(3, dtype=p.dtype))