From 91e8cd29c93ec310b0665e6c3a823c3f095fc516 Mon Sep 17 00:00:00 2001 From: Charles Harris Date: Sat, 30 May 2015 16:24:49 -0600 Subject: DOC: Document '@' and matmul. Document the matmul function and add '@' to the operator section of the reference manual. --- doc/source/reference/arrays.ndarray.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) (limited to 'doc/source/reference/arrays.ndarray.rst') 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 ` 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 =============== -- cgit v1.2.1