diff options
| author | Aaron Meurer <asmeurer@gmail.com> | 2022-04-11 16:03:15 -0600 |
|---|---|---|
| committer | Aaron Meurer <asmeurer@gmail.com> | 2022-04-11 16:03:15 -0600 |
| commit | 14c0a35d68b98e56d75c6b0ee1f7fd45db32c3c9 (patch) | |
| tree | f95e4ee6dc240cb1f2b077b9b8bc1ac86f37b347 /doc/source/reference | |
| parent | 3b3843895150ea1cf15b6fb306b0d0306ca7d999 (diff) | |
| download | numpy-14c0a35d68b98e56d75c6b0ee1f7fd45db32c3c9.tar.gz | |
Small updates to the array_api docs
These items were not clear in the original PR #21260 but have since been
clarified.
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/array_api.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/source/reference/array_api.rst b/doc/source/reference/array_api.rst index 494cbad65..a6a8619da 100644 --- a/doc/source/reference/array_api.rst +++ b/doc/source/reference/array_api.rst @@ -624,11 +624,8 @@ Linear Algebra Differences * - ``cholesky`` includes an ``upper`` keyword argument. - **Compatible** - - * - ``cross`` does not broadcast its arguments. - - ??? - - * - ``cross`` does not allow size 2 vectors (only size 3). - - ??? + - **Breaking** - * - ``diagonal`` operates on the last two axes. - **Breaking** @@ -663,7 +660,9 @@ Linear Algebra Differences <https://data-apis.org/array-api/latest/API_specification/generated/signatures.linear_algebra_functions.matrix_transpose.html#signatures.linear_algebra_functions.matrix_transpose>`__ * - ``outer`` only supports 1-dimensional arrays. - **Breaking** - - + - The spec currently only specifies behavior on 1-D arrays but future + behavior will likely be to broadcast, rather than flatten, which is + what ``np.outer`` does. * - ``pinv`` has an ``rtol`` keyword argument instead of ``rcond`` - **Breaking** - The meaning of ``rtol`` and ``rcond`` is the same, but the default |