Skip to content

Commit 4f804cf

Browse files
committed
Update docs for new chol() behavior
[ci skip]
1 parent 0398bb2 commit 4f804cf

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/stdlib/linalg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
8989

9090
.. function:: chol(A, [LU]) -> F
9191

92-
Compute the Cholesky factorization of a symmetric positive definite matrix ``A`` and return the matrix ``F``. If ``LU`` is ``:L`` (Lower), ``A = L*L'``. If ``LU`` is ``:U`` (Upper), ``A = R'*R``.
92+
Compute the Cholesky factorization of a symmetric positive definite matrix ``A`` and return the matrix ``F``. If ``LU`` is ``Val{:U}`` (Upper), ``F`` is of type ``UpperTriangular`` and ``A = F'*F``. If ``LU`` is ``Val{:L}`` (Lower), ``F`` is of type ``LowerTriangular`` and ``A = F*F'``. ``LU`` defaults to ``Val{:U}``.
9393

9494
.. function:: cholfact(A, [LU=:U[,pivot=Val{false}]][;tol=-1.0]) -> Cholesky
9595

0 commit comments

Comments
 (0)