Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/chol.cc @ 14620:cd375519eab0
doc: Periodic grammar check of documentation
* get_unsatisfied_deps.m, print.m, shrinkfaces.m, polyfit.m, splinefit.m,
chol.cc, rand.cc, sparse.cc: Improve docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 10 May 2012 22:08:18 -0700 |
parents | 60e5cf354d80 |
children | 460a3c6d8bf1 |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/chol.cc Thu May 10 21:48:52 2012 -0700 +++ b/src/DLD-FUNCTIONS/chol.cc Thu May 10 22:08:18 2012 -0700 @@ -129,9 +129,9 @@ \n\ @end ifnottex\n\ \n\ -For full matrices, if the \"lower\" flag is set only the lower triangular part\n\ -of the matrix is used for the factorization, otherwise the upper triangular\n\ -part is used.\n\ +For full matrices, if the \"lower\" flag is set only the lower triangular\n\ +part of the matrix is used for the factorization, otherwise the upper\n\ +triangular part is used.\n\ \n\ In general the lower triangular factorization is significantly faster for\n\ sparse matrices.\n\ @@ -623,6 +623,7 @@ Update or downdate a Cholesky@tie{}factorization. Given an upper triangular\n\ matrix @var{R} and a column vector @var{u}, attempt to determine another\n\ upper triangular matrix @var{R1} such that\n\ +\n\ @itemize @bullet\n\ @item\n\ @var{R1}'*@var{R1} = @var{R}'*@var{R} + @var{u}*@var{u}'\n\ @@ -634,6 +635,7 @@ @end itemize\n\ \n\ If @var{op} is \"-\", @var{info} is set to\n\ +\n\ @itemize\n\ @item 0 if the downdate was successful,\n\ \n\ @@ -833,6 +835,7 @@ @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ On return, @var{info} is set to\n\ +\n\ @itemize\n\ @item 0 if the insertion was successful,\n\ \n\