# HG changeset patch # User Carlo de Falco # Date 1264169627 -3600 # Node ID 353f747316828c84646fbef92dd74a8ebfd359ce # Parent 095a1e670e68d0496d751fcfafcd39419b336c33 fixed help for chol.cc diff -r 095a1e670e68 -r 353f74731682 src/DLD-FUNCTIONS/chol.cc --- a/src/DLD-FUNCTIONS/chol.cc Fri Jan 22 07:30:44 2010 -0500 +++ b/src/DLD-FUNCTIONS/chol.cc Fri Jan 22 15:13:47 2010 +0100 @@ -84,8 +84,18 @@ Called with one output argument @code{chol} fails if @var{a} or @var{s} is\n\ not positive definite. With two or more output arguments @var{p} flags\n\ whether the matrix was positive definite and @code{chol} does not fail. A\n\ -zero value indicated that the matrix was positive definite and the @var{r}\n\ -gives the factorization, and @var{p} will have a positive value otherwise.\n\ +zero value indicates that the matrix was positive definite and, in such case, @var{r}\n\ +gives the factorization. A non-zero value of @var{p} indicates that the factorization\n\ +was not possible and, in this case\n\ address@hidden +$ R^T R \neq A $.\n\ address@hidden tex\n\ address@hidden +\n\ address@hidden address@hidden' * @var{r} != @var{a}.\n\ address@hidden example\n\ address@hidden ifnottex\n\ \n\ If called with 3 outputs then a sparsity preserving row/column permutation\n\ is applied to @var{a} prior to the factorization. That is @var{r}\n\