Skip to content

Commit 48199cf

Browse files
committed
DOC: searchsorted: document relationship to array API standard 'searchsorted'
1 parent d1d526b commit 48199cf

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

src/array_api_extra/_delegation.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,11 @@ def searchsorted(
647647
Find the indices into a sorted array ``x1`` such that if the elements in ``x2``
648648
were inserted before the indices, the resulting array would remain sorted.
649649
650+
The behavior of this function is similar to that of the homonymous function in the
651+
array API standard, but it relaxes the requirement that `x1` must be
652+
one-dimensional. The function is vectorized, treating slices along the last axis
653+
as elements and preceding axes as batch (or "loop") dimensions.
654+
650655
Parameters
651656
----------
652657
x1 : Array

0 commit comments

Comments
 (0)