summaryrefslogtreecommitdiff
path: root/doc/source/reference/routines.linalg.rst
diff options
context:
space:
mode:
authorWarren Weckesser <warren.weckesser@gmail.com>2019-12-19 04:48:34 -0500
committerMatti Picus <matti.picus@gmail.com>2019-12-19 11:48:34 +0200
commit3cf092bb872257efb47a814ab3fb8e0bfd8f61b4 (patch)
treea88caf224b02403f8bc771c90e448f0c70a3ef43 /doc/source/reference/routines.linalg.rst
parent6d69a9e163858de5d0ea2ae810b8febc7eec1dbc (diff)
downloadnumpy-3cf092bb872257efb47a814ab3fb8e0bfd8f61b4.tar.gz
DOC: linalg: Include information about scipy.linalg. (#14988)
* DOC: Add links to scipy linalg fuctions and compare numpy.linalg vs scipy.linalg.
Diffstat (limited to 'doc/source/reference/routines.linalg.rst')
-rw-r--r--doc/source/reference/routines.linalg.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/reference/routines.linalg.rst b/doc/source/reference/routines.linalg.rst
index d42e77ad8..86e168b26 100644
--- a/doc/source/reference/routines.linalg.rst
+++ b/doc/source/reference/routines.linalg.rst
@@ -18,6 +18,18 @@ or specify the processor architecture.
.. _OpenBLAS: https://www.openblas.net/
.. _threadpoolctl: https://github.com/joblib/threadpoolctl
+The SciPy library also contains a `~scipy.linalg` submodule, and there is
+overlap in the functionality provided by the SciPy and NumPy submodules. SciPy
+contains functions not found in `numpy.linalg`, such as functions related to
+LU decomposition and the Schur decomposition, multiple ways of calculating the
+pseudoinverse, and matrix transcendentals such as the matrix logarithm. Some
+functions that exist in both have augmented functionality in `scipy.linalg`.
+For example, `scipy.linalg.eig` can take a second matrix argument for solving
+generalized eigenvalue problems. Some functions in NumPy, however, have more
+flexible broadcasting options. For example, `numpy.linalg.solve` can handle
+"stacked" arrays, while `scipy.linalg.solve` accepts only a single square
+array as its first argument.
+
.. currentmodule:: numpy
Matrix and vector products