-
Notifications
You must be signed in to change notification settings - Fork 53
feat: add scalar support to where
#860
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
6ebcdd9
Allow scalar arguments to where()
betatim 252331a
Appease formatting gods
betatim c8048d3
Refer to existing "mix scalars and arrays" section
betatim da3395b
Fix syntax
betatim 1344c35
fix: add missing complex dtypes
kgryte 37b577f
docs: update copy
kgryte 114fe06
docs: remove obsolete note now that `condition` must be an array
kgryte 4fa6d98
docs: update copy
kgryte db2f101
Merge branch 'main' into scalar-where
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -168,21 +168,35 @@ def searchsorted( | |
""" | ||
|
||
|
||
def where(condition: array, x1: array, x2: array, /) -> array: | ||
def where( | ||
condition: array, | ||
x1: Union[array, int, float, complex, bool], | ||
x2: Union[array, int, float, complex, bool], | ||
/, | ||
) -> array: | ||
""" | ||
Returns elements chosen from ``x1`` or ``x2`` depending on ``condition``. | ||
|
||
Parameters | ||
---------- | ||
condition: array | ||
when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Should have a boolean data type. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`). | ||
x1: array | ||
x1: Union[array, int, float, complex, bool] | ||
first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We are consistent throughout the spec, atm, in describing input array arguments as arrays. Did not see a reason to deviate here. |
||
x2: array | ||
x2: Union[array, int, float, complex, bool] | ||
second input array. Must be compatible with ``condition`` and ``x1`` (see :ref:`broadcasting`). | ||
|
||
Returns | ||
------- | ||
out: array | ||
an array with elements from ``x1`` where ``condition`` is ``True``, and elements from ``x2`` elsewhere. The returned array must have a data type determined by :ref:`type-promotion` rules with the arrays ``x1`` and ``x2``. | ||
|
||
Notes | ||
----- | ||
|
||
- At least one of ``x1`` and ``x2`` must be an array. | ||
- If either ``x1`` or ``x2`` is a scalar value, the returned array must have a data type determined according to :ref:`mixing-scalars-and-arrays`. | ||
|
||
.. versionchanged:: 2024.12 | ||
Added support for scalar arguments. | ||
""" |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.