Skip to content

Commit

Permalink
Update docs for new chol() behavior
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
jdlangs committed Apr 27, 2015
1 parent 0398bb2 commit 4f804cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/stdlib/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f

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

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``.
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}``.

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

Expand Down

0 comments on commit 4f804cf

Please sign in to comment.