Skip to content

Commit d3d48c1

Browse files
committed
Update the docstring with more details on possible values of p keyword in dpnp.linalg.cond
1 parent 58975a9 commit d3d48c1

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

dpnp/linalg/dpnp_iface_linalg.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,18 @@ def cond(x, p=None):
180180
x : {dpnp.ndarray, usm_ndarray}
181181
The matrix whose condition number is sought.
182182
p : {None, 1, -1, 2, -2, inf, -inf, "fro"}, optional
183-
Order of the norm used in the condition number computation.
184-
``inf`` means the `dpnp.inf` object, and the Frobenius norm is
183+
Order of the norm used in the condition number computation:
184+
185+
- None: 2-norm.
186+
- "fro": Frobenius norm.
187+
- inf: max(sum(abs(x), axis=1)).
188+
- -inf: min(sum(abs(x), axis=1)).
189+
- 1: max(sum(abs(x), axis=0)).
190+
- -1: min(sum(abs(x), axis=0)).
191+
- 2: 2-norm (largest singular value).
192+
- -2: smallest singular value.
193+
194+
``inf`` means the :obj:`dpnp.inf` object, and the Frobenius norm is
185195
the root-of-sum-of-squares norm.
186196
187197
Default: ``None``.

0 commit comments

Comments
 (0)