Skip to content

Commit

Permalink
Add note clarifying behavior for out-of-bounds indices in take
Browse files Browse the repository at this point in the history
PR-URL: 	#701
  • Loading branch information
kgryte authored Dec 14, 2023
1 parent 1fd3429 commit bda9c48
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/array_api_stubs/_draft/indexing_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
input array.
indices: array
array indices. The array must be one-dimensional and have an integer data type.
.. note::
This specification does not require bounds checking. The behavior for out-of-bounds indices is left unspecified.
axis: int
axis over which to select values. If ``axis`` is negative, the function must determine the axis along which to select values by counting from the last dimension.
Expand Down

0 comments on commit bda9c48

Please sign in to comment.