diff options
| author | Zé Vinícius <jvmirca@gmail.com> | 2019-12-23 13:50:01 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-23 13:50:01 +0800 |
| commit | 2d289f097b4e1762b01eddbebe4e613e942d2ef7 (patch) | |
| tree | 13d95197a54c8deb4bff49a01db17e4366a11342 /numpy/linalg/linalg.py | |
| parent | 0ed32251e0b67002a0f6da894db2080f4ecdd4e1 (diff) | |
| download | numpy-2d289f097b4e1762b01eddbebe4e613e942d2ef7.tar.gz | |
DOC: update cholesky docstring regarding input checking
Diffstat (limited to 'numpy/linalg/linalg.py')
| -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 ---------- |