diff options
| author | Tyler Reddy <tyler.je.reddy@gmail.com> | 2019-12-23 17:34:17 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-23 17:34:17 -0700 |
| commit | eba2597383a6299ca58823ca8e12175bb87e40f7 (patch) | |
| tree | 8f362a46d3311e20f8fd907160c9f943380ce85a | |
| parent | 42bd6db6ecfdb0b91e5d08ff587ad9af6d5f42d4 (diff) | |
| parent | 2d289f097b4e1762b01eddbebe4e613e942d2ef7 (diff) | |
| download | numpy-eba2597383a6299ca58823ca8e12175bb87e40f7.tar.gz | |
Merge pull request #15153 from mirca/patch-2
DOC: update cholesky docstring regarding input checking
| -rw-r--r-- | numpy/linalg/linalg.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py index 3d2d17057..072670d5c 100644 --- a/numpy/linalg/linalg.py +++ b/numpy/linalg/linalg.py @@ -687,8 +687,10 @@ def cholesky(a): Return the Cholesky decomposition, `L * L.H`, of the square matrix `a`, where `L` is lower-triangular and .H is the conjugate transpose operator (which is the ordinary transpose if `a` is real-valued). `a` must be - Hermitian (symmetric if real-valued) and positive-definite. Only `L` is - actually returned. + Hermitian (symmetric if real-valued) and positive-definite. No + checking is performed to verify whether `a` is Hermitian or not. + In addition, only the lower-triangular and diagonal elements of `a` + are used. Only `L` is actually returned. Parameters ---------- |