diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2016-01-09 10:14:48 -0700 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2016-01-09 10:16:49 -0700 |
commit | bacce4d2031b7e360bff8c7577e2b1e413caa217 (patch) | |
tree | 24f195cf515af9fdd8c21ba16de198f05760013d /numpy/matrixlib/defmatrix.py | |
parent | a8b10bb18c1810efa3b63891e28250d931525c5f (diff) | |
download | numpy-bacce4d2031b7e360bff8c7577e2b1e413caa217.tar.gz |
DOC: Clarify the docstrings of matrix.argmin and matrix.argmax.
[ci skip]
Diffstat (limited to 'numpy/matrixlib/defmatrix.py')
-rw-r--r-- | numpy/matrixlib/defmatrix.py | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/numpy/matrixlib/defmatrix.py b/numpy/matrixlib/defmatrix.py index 22855772a..1a29fb67b 100644 --- a/numpy/matrixlib/defmatrix.py +++ b/numpy/matrixlib/defmatrix.py @@ -783,7 +783,11 @@ class matrix(N.ndarray): def argmax(self, axis=None, out=None): """ - Index of the maximum value along an axis, if multiple returns the first one + Indexes of the maximum values along an axis. + + Return the indexes of the first occurrences of the maximum values + along the specified axis. If axis is None, the index is for the + flattened matrix. Parameters ---------- @@ -853,7 +857,11 @@ class matrix(N.ndarray): def argmin(self, axis=None, out=None): """ - Return the indices of the minimum values along an axis. + Indexes of the minimum values along an axis. + + Return the indexes of the first occurrences of the minimum values + along the specified axis. If axis is None, the index is for the + flattened matrix. Parameters ---------- |