diff options
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/arrays.ndarray.rst | 20 | ||||
| -rw-r--r-- | doc/source/reference/routines.linalg.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/routines.statistics.rst | 2 | ||||
| -rw-r--r-- | doc/source/reference/swig.interface-file.rst | 11 | ||||
| -rw-r--r-- | doc/source/reference/swig.testing.rst | 1 |
5 files changed, 32 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 =============== diff --git a/doc/source/reference/routines.linalg.rst b/doc/source/reference/routines.linalg.rst index 94533aaa9..bb2ad90a2 100644 --- a/doc/source/reference/routines.linalg.rst +++ b/doc/source/reference/routines.linalg.rst @@ -14,6 +14,7 @@ Matrix and vector products vdot inner outer + matmul tensordot einsum linalg.matrix_power diff --git a/doc/source/reference/routines.statistics.rst b/doc/source/reference/routines.statistics.rst index 64745ff0c..d359541aa 100644 --- a/doc/source/reference/routines.statistics.rst +++ b/doc/source/reference/routines.statistics.rst @@ -16,6 +16,7 @@ Order statistics nanmax ptp percentile + nanpercentile Averages and variances ---------------------- @@ -28,6 +29,7 @@ Averages and variances mean std var + nanmedian nanmean nanstd nanvar diff --git a/doc/source/reference/swig.interface-file.rst b/doc/source/reference/swig.interface-file.rst index c381feb85..e5d369d0e 100644 --- a/doc/source/reference/swig.interface-file.rst +++ b/doc/source/reference/swig.interface-file.rst @@ -320,6 +320,17 @@ signatures are These typemaps now check to make sure that the ``INPLACE_ARRAY`` arguments use native byte ordering. If not, an exception is raised. +There is also a "flat" in-place array for situations in which +you would like to modify or process each element, regardless of the +number of dimensions. One example is a "quantization" function that +quantizes each element of an array in-place, be it 1D, 2D or whatever. +This form checks for continuity but allows either C or Fortran ordering. + +ND: + + * ``(DATA_TYPE* INPLACE_ARRAY_FLAT, DIM_TYPE DIM_FLAT)`` + + Argout Arrays ````````````` diff --git a/doc/source/reference/swig.testing.rst b/doc/source/reference/swig.testing.rst index c0daaec66..13642a52e 100644 --- a/doc/source/reference/swig.testing.rst +++ b/doc/source/reference/swig.testing.rst @@ -57,6 +57,7 @@ Two-dimensional arrays are tested in exactly the same manner. The above description applies, but with ``Matrix`` substituted for ``Vector``. For three-dimensional tests, substitute ``Tensor`` for ``Vector``. For four-dimensional tests, substitute ``SuperTensor`` +for ``Vector``. For flat in-place array tests, substitute ``Flat`` for ``Vector``. For the descriptions that follow, we will reference the ``Vector`` tests, but the same information applies to ``Matrix``, |