summaryrefslogtreecommitdiff
path: root/doc/source/reference/routines.linalg.rst
diff options
context:
space:
mode:
authormelissawm <melissawm@gmail.com>2021-02-05 14:05:34 -0300
committermelissawm <melissawm@gmail.com>2021-02-05 14:17:42 -0300
commit46b5b0d428bbe3216140e799ca4aaa2507b8293e (patch)
tree8f0cb39882a0f3d4ed2ad887bd2c627dd432bb54 /doc/source/reference/routines.linalg.rst
parent0a1bd4ead41b1fdfb53142097b5e08555f280545 (diff)
downloadnumpy-46b5b0d428bbe3216140e799ca4aaa2507b8293e.tar.gz
DOC: Discussion on the @ operator and the matrix class
Diffstat (limited to 'doc/source/reference/routines.linalg.rst')
-rw-r--r--doc/source/reference/routines.linalg.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/reference/routines.linalg.rst b/doc/source/reference/routines.linalg.rst
index 86e168b26..97bdf3974 100644
--- a/doc/source/reference/routines.linalg.rst
+++ b/doc/source/reference/routines.linalg.rst
@@ -30,10 +30,26 @@ 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.
+.. note::
+
+ The term *matrix* as it is used on this page indicates a 2d `numpy.array`
+ object, and *not* a `numpy.matrix` object. The latter is no longer
+ recommended, even for linear algebra. See
+ :ref:`the matrix object documentation<matrix-objects>` for
+ more information.
+
+The ``@`` operator
+------------------
+
+Introduced in NumPy 1.10.0, the ``@`` and ``@=`` operators are preferable to
+other methods when computing the matrix product between 2d arrays. The
+:func:`numpy.matmul` function implements the semantics of the ``@`` operator.
+
.. currentmodule:: numpy
Matrix and vector products
--------------------------
+
.. autosummary::
:toctree: generated/