summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authormelissawm <melissawm.github@gmail.com>2021-10-22 12:11:18 -0300
committermelissawm <melissawm.github@gmail.com>2021-10-22 12:11:18 -0300
commitadea1d4fd4e1638f74bf1c8bc48b06992d569c7b (patch)
tree317f72c0bde98bcb8423e826c384b9389ed30ca0 /numpy
parent7d0a0db15ae9b02da5001b40b82e377812acf50e (diff)
downloadnumpy-adea1d4fd4e1638f74bf1c8bc48b06992d569c7b.tar.gz
DOC: Clarify table contents in cond docstring
Diffstat (limited to 'numpy')
-rw-r--r--numpy/linalg/linalg.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py
index d5bcb1cb4..e7196524e 100644
--- a/numpy/linalg/linalg.py
+++ b/numpy/linalg/linalg.py
@@ -1680,7 +1680,7 @@ def cond(x, p=None):
x : (..., M, N) array_like
The matrix whose condition number is sought.
p : {None, 1, -1, 2, -2, inf, -inf, 'fro'}, optional
- Order of the norm:
+ Order of the norm used in the condition number computation:
===== ============================
p norm for matrices
@@ -1691,11 +1691,11 @@ def cond(x, p=None):
-inf min(sum(abs(x), axis=1))
1 max(sum(abs(x), axis=0))
-1 min(sum(abs(x), axis=0))
- 2 (largest sing. value)/(smallest sing. value)
- -2 (smallest sing. value)/(largest sing. value)
+ 2 2-norm (largest sing. value)
+ -2 smallest singular value
===== ============================
- inf means the numpy.inf object, and the Frobenius norm is
+ inf means the `numpy.inf` object, and the Frobenius norm is
the root-of-sum-of-squares norm.
Returns