Merge pull request JuliaLang#10963 from phobon/chol_method

Additional chol() method for compatibility
pwl · Apr 28, 2015 · b0b7e59 · b0b7e59
2 parents e213430 + 4f804cf
commit b0b7e59
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst
@@ -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