-
Notifications
You must be signed in to change notification settings - Fork 52
PR: Transform searching functions md to rst #368
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 1 commit
Commits
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 was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
.. _searching-functions: | ||
|
||
Searching Functions | ||
=================== | ||
|
||
Array API specification for functions for searching arrays. | ||
|
||
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions. | ||
|
||
- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order. | ||
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments. | ||
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`. | ||
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`. | ||
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`. | ||
|
||
Objects in API | ||
-------------- | ||
|
||
.. currentmodule:: signatures.searching_functions | ||
|
||
.. | ||
NOTE: please keep the functions in alphabetical order | ||
|
||
.. autosummary:: | ||
:toctree: generated | ||
|
||
argmax | ||
argmin | ||
nonzero | ||
where |
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 |
---|---|---|
@@ -0,0 +1,80 @@ | ||
from ._types import Optional, Tuple, array | ||
|
||
def argmax(x: array, /, *, axis: Optional[int] = None, keepdims: bool = False) -> array: | ||
""" | ||
Returns the indices of the maximum values along a specified axis. When the maximum value occurs multiple times, only the indices corresponding to the first occurrence are returned. | ||
|
||
Parameters | ||
---------- | ||
x: array | ||
input array. Should have a numeric data type. | ||
axis: Optional[int] | ||
axis along which to search. If ``None``, the function must return the index of the maximum value of the flattened array. Default: ``None``. | ||
keepdims: bool | ||
If ``True``, the reduced axes (dimensions) must be included in the result as singleton dimensions, and, accordingly, the result must be compatible with the input array (see :ref:`broadcasting`). Otherwise, if ``False``, the reduced axes (dimensions) must not be included in the result. Default: ``False``. | ||
|
||
Returns | ||
------- | ||
out: array | ||
if ``axis`` is ``None``, a zero-dimensional array containing the index of the first occurrence of the maximum value; otherwise, a non-zero-dimensional array containing the indices of the maximum values. The returned array must have be the default array index data type. | ||
""" | ||
|
||
def argmin(x: array, /, *, axis: Optional[int] = None, keepdims: bool = False) -> array: | ||
""" | ||
Returns the indices of the minimum values along a specified axis. When the minimum value occurs multiple times, only the indices corresponding to the first occurrence are returned. | ||
|
||
Parameters | ||
---------- | ||
x: array | ||
input array. Should have a numeric data type. | ||
axis: Optional[int] | ||
axis along which to search. If ``None``, the function must return the index of the minimum value of the flattened array. Default: ``None``. | ||
keepdims: bool | ||
If ``True``, the reduced axes (dimensions) must be included in the result as singleton dimensions, and, accordingly, the result must be compatible with the input array (see :ref:`broadcasting`). Otherwise, if ``False``, the reduced axes (dimensions) must not be included in the result. Default: ``False``. | ||
kgryte marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Returns | ||
------- | ||
out: array | ||
if ``axis`` is ``None``, a zero-dimensional array containing the index of the first occurrence of the minimum value; otherwise, a non-zero-dimensional array containing the indices of the minimum values. The returned array must have the default array index data type. | ||
""" | ||
|
||
def nonzero(x: array, /) -> Tuple[array, ...]: | ||
""" | ||
Returns the indices of the array elements which are non-zero. | ||
|
||
.. admonition:: Future extension | ||
steff456 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:class: admonition important | ||
|
||
The shape of the output array for this function depends on the data values in the input array; hence, array libraries which build computation graphs (e.g., JAX, Dask, etc.) may find this function difficult to implement without knowing array values. Accordingly, such libraries may choose to omit this function. See :ref:`data-dependent-output-shapes` section for more details. | ||
|
||
Parameters | ||
---------- | ||
x: array | ||
input array. Must have a positive rank. If ``x`` is zero-dimensional, the function must raise an exception. | ||
|
||
Returns | ||
------- | ||
out: Typle[array, ...] | ||
a tuple of ``k`` arrays, one for each dimension of ``x`` and each of size ``n`` (where ``n`` is the total number of non-zero elements), containing the indices of the non-zero elements in that dimension. The indices must be returned in row-major, C-style order. The returned array must have the default array index data type. | ||
""" | ||
|
||
def where(condition: array, x1: array, x2: array, /) -> array: | ||
""" | ||
Returns elements chosen from ``x1`` or ``x2`` depending on ``condition``. | ||
|
||
Parameters | ||
---------- | ||
condition: array | ||
when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`). | ||
x1: array | ||
first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`). | ||
x2: array | ||
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``. | ||
""" | ||
|
||
__all__ = ['argmax', 'argmin', 'nonzero', 'where'] |
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.