diff options
| author | Stephan Hoyer <shoyer@google.com> | 2022-02-17 14:48:52 -0800 |
|---|---|---|
| committer | Stephan Hoyer <shoyer@google.com> | 2022-02-17 14:48:55 -0800 |
| commit | 89fe839db5a478401d27875c6b3cc566ae8bd131 (patch) | |
| tree | c121a8a622415a1b3cd774e5191491632af3f621 | |
| parent | 1168868df63678e5704acd866fafcf40dc849481 (diff) | |
| download | numpy-89fe839db5a478401d27875c6b3cc566ae8bd131.tar.gz | |
DOC: clarify the return value of linalg.cholesky
It is in fact always lower-triangular. The errorenous note might
date to when function was forked from SciPy?
| -rw-r--r-- | numpy/linalg/linalg.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py index d831886c0..6b0294659 100644 --- a/numpy/linalg/linalg.py +++ b/numpy/linalg/linalg.py @@ -697,8 +697,8 @@ def cholesky(a): Returns ------- L : (..., M, M) array_like - Upper or lower-triangular Cholesky factor of `a`. Returns a - matrix object if `a` is a matrix object. + Lower-triangular Cholesky factor of `a`. Returns a matrix object if + `a` is a matrix object. Raises ------ |