summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2023-05-17 15:02:06 -0600
committerGitHub <noreply@github.com>2023-05-17 15:02:06 -0600
commit126b46c7abdd7970d6deb78349de4b6bf6525e44 (patch)
tree363273c29d27efc89984983cf5b7a3b152aba0b3 /doc
parentd9b38d687cd513aa6688f7fba805a908c0ac3979 (diff)
parenta4c249653ec9d063a67a6cde8123dca2defb8f8b (diff)
downloadnumpy-main.tar.gz
Merge pull request #22786 from asmeurer/linalg-namedtuplesHEADmain
ENH: Add namedtuple return types to linalg functions that return tuples
Diffstat (limited to 'doc')
-rw-r--r--doc/release/upcoming_changes/22786.new_feature.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/release/upcoming_changes/22786.new_feature.rst b/doc/release/upcoming_changes/22786.new_feature.rst
new file mode 100644
index 000000000..ccfd3cd5e
--- /dev/null
+++ b/doc/release/upcoming_changes/22786.new_feature.rst
@@ -0,0 +1,8 @@
+
+``np.linalg`` functions return namedtuples
+------------------------------------------
+
+``np.linalg`` functions that return tuples now return namedtuples. These
+functions are ``eig()``, ``eigh()``, ``qr()``, ``slogdet()``, and ``svd()``.
+The return type is unchanged in instances where these functions return
+non-tuples with certain keyword arguments (like ``svd(compute_uv=False)``).