Return tuple instead of list from atleast_1d/2d/3d and ogrid#2965
Merged
Conversation
…the affected functions
…mPy still use list for the result from them
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
June 22, 2026 14:32
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
Collaborator
|
coverage: 78.069% (+0.003%) from 78.066% — return-tuple-of-array-acc-to-numpy-2.0 into master |
Contributor
|
Array API standard conformance tests for dpnp=0.21.0dev1=py313h509198e_28 ran successfully. |
github-actions Bot
added a commit
that referenced
this pull request
Jun 23, 2026
NumPy returns a tuple of arrays (not a list) from several functions that yield multiple arrays. This PR aligns dpnp with that behavior. ### What is done - `dpnp.atleast_1d`, `dpnp.atleast_2d`, `dpnp.atleast_3d` and `dpnp.ogrid` now return a tuple of arrays instead of a list. Single-input `atleast_*d` and single-slice `ogrid` still return a bare array, and `mgrid` still returns a single stacked array (matching NumPy). - Added/extended tests to assert the return container type matches NumPy. While here, added the same parity checks for other tuple-returning functions that lacked them (`nonzero`, `where`, `ix_`, `tril_indices`, `triu_indices`, `unravel_index`, `unstack`). The split family (`array_split`, `split`, `hsplit`, `vsplit`, `dsplit`) and `histogramdd` still return lists, matching current NumPy. 3959012
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
NumPy returns a tuple of arrays (not a list) from several functions that yield multiple arrays.
This PR aligns dpnp with that behavior.
What is done
dpnp.atleast_1d,dpnp.atleast_2d,dpnp.atleast_3danddpnp.ogridnow return a tuple of arrays instead of a list. Single-inputatleast_*dand single-sliceogridstill return a bare array, andmgridstill returns a single stacked array (matching NumPy).nonzero,where,ix_,tril_indices,triu_indices,unravel_index,unstack).The split family (
array_split,split,hsplit,vsplit,dsplit) andhistogramddstill return lists, matching current NumPy.