summaryrefslogtreecommitdiff
path: root/numpy/linalg/linalg.py
diff options
context:
space:
mode:
authorAaron Voelker <arvoelke@gmail.com>2019-05-07 14:04:31 -0400
committerAaron Voelker <arvoelke@gmail.com>2019-05-08 10:01:28 -0400
commit3f22c3e0565561874298be33e129397c32c7e8a1 (patch)
treea1b6baddcba5c94614ff878db54f2a97654ca991 /numpy/linalg/linalg.py
parent5611663f8e4e41e46fd52daf63a78317ee238581 (diff)
downloadnumpy-3f22c3e0565561874298be33e129397c32c7e8a1.tar.gz
DOC: Clarify rcond normalization in linalg.pinv
Closes #13497.
Diffstat (limited to 'numpy/linalg/linalg.py')
-rw-r--r--numpy/linalg/linalg.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py
index 29da77655..0aa8d5ca9 100644
--- a/numpy/linalg/linalg.py
+++ b/numpy/linalg/linalg.py
@@ -1900,9 +1900,9 @@ def pinv(a, rcond=1e-15, hermitian=False):
Matrix or stack of matrices to be pseudo-inverted.
rcond : (...) array_like of float
Cutoff for small singular values.
- Singular values smaller (in modulus) than
- `rcond` * largest_singular_value (again, in modulus)
- are set to zero. Broadcasts against the stack of matrices
+ Singular values less than or equal to
+ ``rcond * largest_singular_value`` are set to zero.
+ Broadcasts against the stack of matrices.
hermitian : bool, optional
If True, `a` is assumed to be Hermitian (symmetric if real-valued),
enabling a more efficient method for finding singular values.