Add searchsorted to the specification #699
Merged
Conversation
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
17 tasks
emcastillo reviewed Nov 17, 2023
7 tasks
| @rgommers This PR should be ready for final sign off. |
rgommers approved these changes Jan 11, 2024
Shouldn't the language be "x1 should be a one-dimensional array" instead of "x1 must be a one-dimensional array"? |
asmeurer reviewed Apr 24, 2024
| Default: ``'left'``. | ||
| sorter: Optional[array] | ||
| array of indices that sort ``x1`` in ascending order. The array must have the same shape as ``x1`` and have an integer data type. Default: ``None``. |
There was a problem hiding this comment.
Should we only require this to be the default array index type?
There was a problem hiding this comment.
Why would that be necessary?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 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.
This PR
searchsortedto the specification #688 by adding a specification forsearchsortedto the Array API specification.x1be a one-dimensional array. PyTorch and TensorFlow allowx1to be multi-dimensional; however, NumPy et al do not. In this PR, I've chosen to restrictx1to a one-dimensional array, as this is the lowest common denominator. The specification can be extended in the future to accommodate multi-dimensionalx1(stacking) in the future.x2be an array. CuPy and TensorFlow require thatx2be an array, while NumPy, PyTorch, and others allowx2to be a scalar. In this PR, I've chosen to restrictx2to be an array. For the scalar use case, downstream consumers can wrap scalar values as zero-dimensional arrays.