summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2019-05-08 11:36:29 -0600
committerGitHub <noreply@github.com>2019-05-08 11:36:29 -0600
commit634d66d5c5461c6c1480e97c1d3fbc4c4ea96a00 (patch)
treed2706f78583b8a587bb1656adedd03460235ce5b
parent62694bdc9bdfc29838b1f538068a83cc78d95b1f (diff)
parent3f22c3e0565561874298be33e129397c32c7e8a1 (diff)
downloadnumpy-634d66d5c5461c6c1480e97c1d3fbc4c4ea96a00.tar.gz
Merge pull request #13498 from arvoelke/pinv-doc
DOC: Clarify rcond normalization in linalg.pinv
-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.