summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-06-19 21:58:05 -0400
committerCharles Harris <charlesr.harris@gmail.com>2015-06-19 21:58:05 -0400
commit52c8285f2603da718fa00d76de528d035c624dc9 (patch)
treeeea0ae3a4f7f1deb80e485a83ec53ef49f9f6afc
parent0514d31299318bfa4c87abbfea6424eebaeec188 (diff)
parent5035da745cff7b7a5c40e7801c4e17b8355ee36d (diff)
downloadnumpy-52c8285f2603da718fa00d76de528d035c624dc9.tar.gz
Merge pull request #5988 from argriffing/eigvalsh-ordering-update
MAINT: notice that eigvalsh returns a sorted array
-rw-r--r--numpy/linalg/linalg.py2
-rw-r--r--numpy/linalg/tests/test_linalg.py10
2 files changed, 4 insertions, 8 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py
index 3a1a78940..9fd70d14d 100644
--- a/numpy/linalg/linalg.py
+++ b/numpy/linalg/linalg.py
@@ -929,7 +929,7 @@ def eigvalsh(a, UPLO='L'):
Returns
-------
w : (..., M,) ndarray
- The eigenvalues, not necessarily ordered, each repeated according to
+ The eigenvalues in ascending order, each repeated according to
its multiplicity.
Raises
diff --git a/numpy/linalg/tests/test_linalg.py b/numpy/linalg/tests/test_linalg.py
index ca59aa566..c6d84706a 100644
--- a/numpy/linalg/tests/test_linalg.py
+++ b/numpy/linalg/tests/test_linalg.py
@@ -686,19 +686,15 @@ class TestBoolPower(object):
class TestEigvalsh(HermitianTestCase, HermitianGeneralizedTestCase):
def do(self, a, b):
- # note that eigenvalue arrays must be sorted since
+ # note that eigenvalue arrays returned by eig must be sorted since
# their order isn't guaranteed.
ev = linalg.eigvalsh(a, 'L')
evalues, evectors = linalg.eig(a)
- ev.sort(axis=-1)
evalues.sort(axis=-1)
- assert_allclose(ev, evalues,
- rtol=get_rtol(ev.dtype))
+ assert_allclose(ev, evalues, rtol=get_rtol(ev.dtype))
ev2 = linalg.eigvalsh(a, 'U')
- ev2.sort(axis=-1)
- assert_allclose(ev2, evalues,
- rtol=get_rtol(ev.dtype))
+ assert_allclose(ev2, evalues, rtol=get_rtol(ev.dtype))
def test_types(self):
def check(dtype):