docs: add note that iteration is defined for 1-D arrays #821
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kgryte
reviewed
Sep 19, 2024
kgryte
reviewed
Sep 19, 2024
kgryte
reviewed
Sep 19, 2024
kgryte
changed the title
kgryte
reviewed
Sep 19, 2024
| @@ -627,6 +629,10 @@ def __getitem__( | |||
| ------- | |||
| out: array | |||
| an array containing the accessed value(s). The returned array must have the same data type as ``self``. | |||
|
|
|||
| .. note:: | |||
| When ``__getitem__`` is defined on an object, Python will automatically define iteration (i.e., the behavior from ``iter(x)``) as ``x[0]``, ``x[1]``, ..., ``x[N-1]``. This can also be implemented directly by defining ``__iter__``. Therefore, for a one-dimensional array ``x``, iteration should produce a sequence of zero-dimensional arrays ``x[0]``, ``x[1]``, ..., ``x[N-1]``, where ``N`` is the number of elements in the array. Iteration behavior for arrays having more than one dimension is unspecified and thus implementation-defined. | |||
There was a problem hiding this comment.
@asmeurer What should happen for zero-dimensional arrays?
There was a problem hiding this comment.
On a 0-D array x[i] is an IndexError, so this doesn't really apply (the Python auto-__iter__ would never work). Ideally calling list() on a 0-D should always be an error, but we can also just change this to say "arrays not having one dimension".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #818
I also added a cross-reference to the indexing page to the
__getitem__and__setitem__docs.