diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2021-08-23 21:32:20 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-23 21:32:20 -0600 |
commit | 098f874144161b6a49efa5108846a408ca8f39b8 (patch) | |
tree | d618c32a54705d38e5458669774c88d9f6225212 /numpy/array_api/_statistical_functions.py | |
parent | a3ac75c6f92ed158777492f343dc59adeacb745c (diff) | |
parent | 7091e4c48ce7af8a5263b6808a6d7976d4af4c6f (diff) | |
download | numpy-098f874144161b6a49efa5108846a408ca8f39b8.tar.gz |
Merge pull request #18585 from data-apis/array-api
ENH: Implementation of the NEP 47 (adopting the array API standard)
Diffstat (limited to 'numpy/array_api/_statistical_functions.py')
-rw-r--r-- | numpy/array_api/_statistical_functions.py | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/numpy/array_api/_statistical_functions.py b/numpy/array_api/_statistical_functions.py new file mode 100644 index 000000000..63790b447 --- /dev/null +++ b/numpy/array_api/_statistical_functions.py @@ -0,0 +1,81 @@ +from __future__ import annotations + +from ._array_object import Array + +from typing import Optional, Tuple, Union + +import numpy as np + + +def max( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + keepdims: bool = False, +) -> Array: + return Array._new(np.max(x._array, axis=axis, keepdims=keepdims)) + + +def mean( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + keepdims: bool = False, +) -> Array: + return Array._new(np.mean(x._array, axis=axis, keepdims=keepdims)) + + +def min( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + keepdims: bool = False, +) -> Array: + return Array._new(np.min(x._array, axis=axis, keepdims=keepdims)) + + +def prod( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + keepdims: bool = False, +) -> Array: + return Array._new(np.prod(x._array, axis=axis, keepdims=keepdims)) + + +def std( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + correction: Union[int, float] = 0.0, + keepdims: bool = False, +) -> Array: + # Note: the keyword argument correction is different here + return Array._new(np.std(x._array, axis=axis, ddof=correction, keepdims=keepdims)) + + +def sum( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + keepdims: bool = False, +) -> Array: + return Array._new(np.sum(x._array, axis=axis, keepdims=keepdims)) + + +def var( + x: Array, + /, + *, + axis: Optional[Union[int, Tuple[int, ...]]] = None, + correction: Union[int, float] = 0.0, + keepdims: bool = False, +) -> Array: + # Note: the keyword argument correction is different here + return Array._new(np.var(x._array, axis=axis, ddof=correction, keepdims=keepdims)) |