changeset 8284:4ceffd54031a

fix docs for cholinsert, choldelete, cholshift
author Jaroslav Hajek <highegg@gmail.com>
date Wed, 29 Oct 2008 12:41:10 +0100
parents 54c25dc5b17d
children 26f0e69e9f3a
files src/ChangeLog src/DLD-FUNCTIONS/chol.cc
diffstat 2 files changed, 8 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Tue Oct 28 13:04:32 2008 -0400
+++ b/src/ChangeLog	Wed Oct 29 12:41:10 2008 +0100
@@ -1,3 +1,8 @@
+2008-10-29  Jaroslav Hajek  <highegg@gmail.com>
+
+	* DLD-FUNCTIONS/qr.cc (Fcholinsert, Fcholdelete, Fcholshift): Fix
+	inline docs.
+
 2008-10-28  John W. Eaton  <jwe@octave.org>
 
 	* parse.y (finish_function): Clear local variables in function scope.
--- a/src/DLD-FUNCTIONS/chol.cc	Tue Oct 28 13:04:32 2008 -0400
+++ b/src/DLD-FUNCTIONS/chol.cc	Wed Oct 29 12:41:10 2008 +0100
@@ -799,7 +799,7 @@
 @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholinsert (@var{R}, @var{j}, @var{u})\n\
 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
-return the QR@tie{}factorization of\n\
+return the Cholesky@tie{}factorization of\n\
 @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\
@@ -993,7 +993,7 @@
 @deftypefn {Loadable Function} {@var{R1} =} choldelete (@var{R}, @var{j})\n\
 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
-return the QR@tie{}factorization of @w{A(p,p)}, where @w{p = [1:j-1,j+1:n+1]}.\n\
+return the Cholesky@tie{}factorization of @w{A(p,p)}, where @w{p = [1:j-1,j+1:n+1]}.\n\
 @seealso{chol, cholupdate, cholinsert}\n\
 @end deftypefn")
 {
@@ -1125,7 +1125,7 @@
 @deftypefn {Loadable Function} {@var{R1} =} cholshift (@var{R}, @var{i}, @var{j})\n\
 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
-return the QR@tie{}factorization of\n\
+return the Cholesky@tie{}factorization of\n\
 @w{@var{A}(p,p)}, where @w{p} is the permutation @*\n\
 @code{p = [1:i-1, shift(i:j, 1), j+1:n]} if @w{@var{i} < @var{j}} @*\n\
  or @*\n\