Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/chol.cc @ 8284:4ceffd54031a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix docs for cholinsert, choldelete, cholshift
author Jaroslav Hajek <highegg@gmail.com>
date Wed, 29 Oct 2008 12:41:10 +0100
parents 366821c0c01c
children 2176f2b4599e
comparison
equal deleted inserted replaced
8283:54c25dc5b17d 8284:4ceffd54031a
797 DEFUN_DLD (cholinsert, args, nargout, 797 DEFUN_DLD (cholinsert, args, nargout,
798 "-*- texinfo -*-\n\ 798 "-*- texinfo -*-\n\
799 @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholinsert (@var{R}, @var{j}, @var{u})\n\ 799 @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholinsert (@var{R}, @var{j}, @var{u})\n\
800 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ 800 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
801 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ 801 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
802 return the QR@tie{}factorization of\n\ 802 return the Cholesky@tie{}factorization of\n\
803 @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ 803 @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\
804 @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ 804 @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\
805 On return, @var{info} is set to\n\ 805 On return, @var{info} is set to\n\
806 @itemize\n\ 806 @itemize\n\
807 @item 0 if the insertion was successful,\n\ 807 @item 0 if the insertion was successful,\n\
991 DEFUN_DLD (choldelete, args, , 991 DEFUN_DLD (choldelete, args, ,
992 "-*- texinfo -*-\n\ 992 "-*- texinfo -*-\n\
993 @deftypefn {Loadable Function} {@var{R1} =} choldelete (@var{R}, @var{j})\n\ 993 @deftypefn {Loadable Function} {@var{R1} =} choldelete (@var{R}, @var{j})\n\
994 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ 994 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
995 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ 995 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
996 return the QR@tie{}factorization of @w{A(p,p)}, where @w{p = [1:j-1,j+1:n+1]}.\n\ 996 return the Cholesky@tie{}factorization of @w{A(p,p)}, where @w{p = [1:j-1,j+1:n+1]}.\n\
997 @seealso{chol, cholupdate, cholinsert}\n\ 997 @seealso{chol, cholupdate, cholinsert}\n\
998 @end deftypefn") 998 @end deftypefn")
999 { 999 {
1000 octave_idx_type nargin = args.length (); 1000 octave_idx_type nargin = args.length ();
1001 1001
1123 DEFUN_DLD (cholshift, args, , 1123 DEFUN_DLD (cholshift, args, ,
1124 "-*- texinfo -*-\n\ 1124 "-*- texinfo -*-\n\
1125 @deftypefn {Loadable Function} {@var{R1} =} cholshift (@var{R}, @var{i}, @var{j})\n\ 1125 @deftypefn {Loadable Function} {@var{R1} =} cholshift (@var{R}, @var{i}, @var{j})\n\
1126 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\ 1126 Given a Cholesky@tie{}factorization of a real symmetric or complex hermitian\n\
1127 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\ 1127 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper triangular,\n\
1128 return the QR@tie{}factorization of\n\ 1128 return the Cholesky@tie{}factorization of\n\
1129 @w{@var{A}(p,p)}, where @w{p} is the permutation @*\n\ 1129 @w{@var{A}(p,p)}, where @w{p} is the permutation @*\n\
1130 @code{p = [1:i-1, shift(i:j, 1), j+1:n]} if @w{@var{i} < @var{j}} @*\n\ 1130 @code{p = [1:i-1, shift(i:j, 1), j+1:n]} if @w{@var{i} < @var{j}} @*\n\
1131 or @*\n\ 1131 or @*\n\
1132 @code{p = [1:j-1, shift(j:i,-1), i+1:n]} if @w{@var{j} < @var{i}}. @*\n\ 1132 @code{p = [1:j-1, shift(j:i,-1), i+1:n]} if @w{@var{j} < @var{i}}. @*\n\
1133 \n\ 1133 \n\