Skip to content

Commit 2d289f0

Browse files
authored
DOC: update cholesky docstring regarding input checking
1 parent 0ed3225 commit 2d289f0

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

numpy/linalg/linalg.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -687,8 +687,10 @@ def cholesky(a):
687687
Return the Cholesky decomposition, `L * L.H`, of the square matrix `a`,
688688
where `L` is lower-triangular and .H is the conjugate transpose operator
689689
(which is the ordinary transpose if `a` is real-valued). `a` must be
690-
Hermitian (symmetric if real-valued) and positive-definite. Only `L` is
691-
actually returned.
690+
Hermitian (symmetric if real-valued) and positive-definite. No
691+
checking is performed to verify whether `a` is Hermitian or not.
692+
In addition, only the lower-triangular and diagonal elements of `a`
693+
are used. Only `L` is actually returned.
692694
693695
Parameters
694696
----------

0 commit comments

Comments
 (0)