diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2015-05-30 16:24:49 -0600 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2015-06-04 18:00:50 -0600 |
| commit | 91e8cd29c93ec310b0665e6c3a823c3f095fc516 (patch) | |
| tree | 9dda376c4b14eb7f357b8b35daf501314a114f8c /doc/source/reference/arrays.ndarray.rst | |
| parent | c79651d865ca53940f5ec0dc4e9bcbc33c01918b (diff) | |
| download | numpy-91e8cd29c93ec310b0665e6c3a823c3f095fc516.tar.gz | |
DOC: Document '@' and matmul.
Document the matmul function and add '@' to the operator
section of the reference manual.
Diffstat (limited to 'doc/source/reference/arrays.ndarray.rst')
| -rw-r--r-- | doc/source/reference/arrays.ndarray.rst | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst index c8d834d1c..e84b7fdf8 100644 --- a/doc/source/reference/arrays.ndarray.rst +++ b/doc/source/reference/arrays.ndarray.rst @@ -428,10 +428,10 @@ be performed. ndarray.all ndarray.any -Arithmetic and comparison operations -==================================== +Arithmetic, matrix multiplication, and comparison operations +============================================================ -.. index:: comparison, arithmetic, operation, operator +.. index:: comparison, arithmetic, matrix, operation, operator Arithmetic and comparison operations on :class:`ndarrays <ndarray>` are defined as element-wise operations, and generally yield @@ -551,6 +551,20 @@ Arithmetic, in-place: casts the result to fit back in ``a``, whereas ``a = a + 3j`` re-binds the name ``a`` to the result. +Matrix Multiplication: + +.. autosummary:: + :toctree: generated/ + + ndarray.__matmul__ + +.. note:: + + Matrix operators ``@`` and ``@=`` were introduced in Python 3.5 + following PEP465. Numpy 1.10 has a preliminary implementation of ``@`` + for testing purposes. Further documentation can be found in the + :func:`matmul` documentation. + Special methods =============== |