diff --git a/spec/API_specification/searching_functions.md b/spec/API_specification/searching_functions.md index 58a3286d6..5e70e993d 100644 --- a/spec/API_specification/searching_functions.md +++ b/spec/API_specification/searching_functions.md @@ -13,7 +13,7 @@ A conforming implementation of the array API standard must provide and support t -### # argmax(x, /, *, axis=None, keepdims=False, out=None) +### # 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. @@ -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\[ <array> ]_ - - - 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**: _<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. -### # argmin(x, /, *, axis=None, keepdims=False, out=None) +### # 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. @@ -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\[ <array> ]_ - - - 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**: _<array>_ diff --git a/spec/API_specification/statistical_functions.md b/spec/API_specification/statistical_functions.md index f3cfee5a0..6578a4e70 100644 --- a/spec/API_specification/statistical_functions.md +++ b/spec/API_specification/statistical_functions.md @@ -6,7 +6,6 @@ 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`. @@ -14,7 +13,7 @@ A conforming implementation of the array API standard must provide and support t -### # max(x, /, *, axis=None, keepdims=False, out=None) +### # max(x, /, *, axis=None, keepdims=False) Calculates the maximum value of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - 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. -### # mean(x, /, *, axis=None, keepdims=False, out=None) +### # mean(x, /, *, axis=None, keepdims=False) Calculates the arithmetic mean of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - 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. -### # min(x, /, *, axis=None, keepdims=False, out=None) +### # min(x, /, *, axis=None, keepdims=False) Calculates the minimum value of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - 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. -### # prod(x, /, *, axis=None, keepdims=False, out=None) +### # prod(x, /, *, axis=None, keepdims=False) Calculates the product of input array `x` elements. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - 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. -### # std(x, /, *, axis=None, correction=0.0, keepdims=False, out=None) +### # std(x, /, *, axis=None, correction=0.0, keepdims=False) Calculates the standard deviation of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - 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. -### # sum(x, /, *, axis=None, keepdims=False, out=None) +### # sum(x, /, *, axis=None, keepdims=False) Calculates the sum of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_ - if the sum was computed over the entire array, a zero-dimensional array containing the sum; otherwise, an array containing the sums. -### # var(x, /, *, axis=None, correction=0.0, keepdims=False, out=None) +### # var(x, /, *, axis=None, correction=0.0, keepdims=False) Calculates the variance of the input array `x`. @@ -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\[ <array> ]_ - - - 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**: _<array>_