Skip to content

Remove out keyword support #44

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.

Sign up for GitHub

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 1 commit into from
Sep 16, 2020
Merged

Remove out keyword support #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions spec/API_specification/searching_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A conforming implementation of the array API standard must provide and support t

<!-- NOTE: please keep the functions in alphabetical order -->

### <a name="argmax" href="#argmax">#</a> argmax(x, /, *, axis=None, keepdims=False, out=None)
### <a name="argmax" href="#argmax">#</a> argmax(x, /, *, axis=None, keepdims=False)

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.

Expand All @@ -31,17 +31,13 @@ Returns the indices of the maximum values along a specified axis. When the maxim

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- 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.

### <a name="argmin" href="#argmin">#</a> argmin(x, /, *, axis=None, keepdims=False, out=None)
### <a name="argmin" href="#argmin">#</a> argmin(x, /, *, axis=None, keepdims=False)

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.

Expand All @@ -59,10 +55,6 @@ Returns the indices of the minimum values along a specified axis. When the minim

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_
Expand Down
43 changes: 7 additions & 36 deletions spec/API_specification/statistical_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ A conforming implementation of the array API standard must provide and support t

- 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.
- The `out` keyword argument must follow the conventions defined in :ref:`out-keyword`.
- 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`.
- Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.

<!-- NOTE: please keep the functions in alphabetical order -->

### <a name="max" href="#max">#</a> max(x, /, *, axis=None, keepdims=False, out=None)
### <a name="max" href="#max">#</a> max(x, /, *, axis=None, keepdims=False)

Calculates the maximum value of the input array `x`.

Expand All @@ -32,17 +31,13 @@ Calculates the maximum value of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the maximum value was computed over the entire array, a zero-dimensional array containing the maximum value; otherwise, a non-zero-dimensional array containing the maximum values.

### <a name="mean" href="#mean">#</a> mean(x, /, *, axis=None, keepdims=False, out=None)
### <a name="mean" href="#mean">#</a> mean(x, /, *, axis=None, keepdims=False)

Calculates the arithmetic mean of the input array `x`.

Expand All @@ -60,17 +55,13 @@ Calculates the arithmetic mean of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the arithmetic mean was computed over the entire array, a zero-dimensional array containing the arithmetic mean; otherwise, a non-zero-dimensional array containing the arithmetic means.

### <a name="min" href="#min">#</a> min(x, /, *, axis=None, keepdims=False, out=None)
### <a name="min" href="#min">#</a> min(x, /, *, axis=None, keepdims=False)

Calculates the minimum value of the input array `x`.

Expand All @@ -88,17 +79,13 @@ Calculates the minimum value of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the minimum value was computed over the entire array, a zero-dimensional array containing the minimum value; otherwise, a non-zero-dimensional array containing the minimum values.

### <a name="prod" href="#prod">#</a> prod(x, /, *, axis=None, keepdims=False, out=None)
### <a name="prod" href="#prod">#</a> prod(x, /, *, axis=None, keepdims=False)

Calculates the product of input array `x` elements.

Expand All @@ -116,17 +103,13 @@ Calculates the product of input array `x` elements.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the product was computed over the entire array, a zero-dimensional array containing the product; otherwise, a non-zero-dimensional array containing the products.

### <a name="std" href="#std">#</a> std(x, /, *, axis=None, correction=0.0, keepdims=False, out=None)
### <a name="std" href="#std">#</a> std(x, /, *, axis=None, correction=0.0, keepdims=False)

Calculates the standard deviation of the input array `x`.

Expand All @@ -148,17 +131,13 @@ Calculates the standard deviation of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the standard deviation was computed over the entire array, a zero-dimensional array containing the standard deviation; otherwise, a non-zero-dimensional array containing the standard deviations.

### <a name="sum" href="#sum">#</a> sum(x, /, *, axis=None, keepdims=False, out=None)
### <a name="sum" href="#sum">#</a> sum(x, /, *, axis=None, keepdims=False)

Calculates the sum of the input array `x`.

Expand All @@ -176,17 +155,13 @@ Calculates the sum of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_

- if the sum was computed over the entire array, a zero-dimensional array containing the sum; otherwise, an array containing the sums.

### <a name="var" href="#var">#</a> var(x, /, *, axis=None, correction=0.0, keepdims=False, out=None)
### <a name="var" href="#var">#</a> var(x, /, *, axis=None, correction=0.0, keepdims=False)

Calculates the variance of the input array `x`.

Expand All @@ -208,10 +183,6 @@ Calculates the variance of the input array `x`.

- 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`.

- **out**: _Optional\[ &lt;array&gt; ]_

- output array. If provided, the output array must have the expected output shape. If not provided or is `None`, an uninitialized return array must be created and then filled with the result of each computation. Default: `None`.

#### Returns

- **out**: _&lt;array&gt;_
Expand Down