diff options
author | Pauli Virtanen <pav@iki.fi> | 2013-04-08 23:56:05 +0300 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2013-04-10 22:47:44 +0300 |
commit | f0a78c76e1fffdc222e527423871d8adfe7433f6 (patch) | |
tree | 1f9bedcec34eb3fe422f213c76b4d40f90fc9cf4 | |
parent | 35f4b174ff4fd2ea02052a697e5354408aa99e81 (diff) | |
download | numpy-f0a78c76e1fffdc222e527423871d8adfe7433f6.tar.gz |
DOC: document the behavior of generalized N-dim linear algebra functions
-rw-r--r-- | doc/source/reference/routines.linalg.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/source/reference/routines.linalg.rst b/doc/source/reference/routines.linalg.rst index 173a6ad53..00620347a 100644 --- a/doc/source/reference/routines.linalg.rst +++ b/doc/source/reference/routines.linalg.rst @@ -67,3 +67,21 @@ Exceptions :toctree: generated/ linalg.LinAlgError + +Linear algebra on several matrices at once +------------------------------------------ + +Several of the linear algebra routines listed above are able to +compute results for several matrices at once, if they are stacked into +the same array. + +This is indicated in the documentation via input parameter +specifications such as ``a : (..., M, M) array_like``. This means that +if for instance given an input array ``a.shape == (N, M, M)``, it is +interpreted as a "stack" of N matrices, each of size M-by-M. Similar +specification applies to return values, for instance the determinant +has ``det : (...)`` and will in this case return an array of shape +``det(a).shape == (N,)``. This generalizes to linear algebra +operations on higher-dimensional arrays: the last 1 or 2 dimensions of +a multidimensional array are interpreted as vectors or matrices, as +appropriate for each operation. |