Skip to content
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

docs: clarify behavior when providing a zero-dimensional array to take #876

Merged
merged 2 commits into from
Jan 9, 2025
Merged

docs: clarify behavior when providing a zero-dimensional array to take #876

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f30307
doc: leave `take` undefined for 0-d
lucascolley Dec 23, 2024
a4bb9a9
docs: update language to match `cumulative_sum`
kgryte Jan 9, 2025
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 src/array_api_stubs/_draft/indexing_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
Parameters
----------
x: array
input array.
input array. Should have one or more dimensions (axes).
indices: array
array indices. The array must be one-dimensional and have an integer data type.

Expand All @@ -33,6 +33,8 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
Notes
-----

- When ``x`` is a zero-dimensional array, behavior is unspecified and thus implementation-defined.

.. versionadded:: 2022.12

.. versionchanged:: 2023.12
Expand Down
Loading