Mercurial > octave-antonio

comparison libinterp/dldfcn/chol.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 17d647821d61
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
68 @deftypefnx {Loadable Function} {[@var{R}, @var{p}, @var{Q}] =} chol (@var{S}, \"vector\")\n\ 68 @deftypefnx {Loadable Function} {[@var{R}, @var{p}, @var{Q}] =} chol (@var{S}, \"vector\")\n\
69 @deftypefnx {Loadable Function} {[@var{L}, @dots{}] =} chol (@dots{}, \"lower\")\n\ 69 @deftypefnx {Loadable Function} {[@var{L}, @dots{}] =} chol (@dots{}, \"lower\")\n\
70 @deftypefnx {Loadable Function} {[@var{L}, @dots{}] =} chol (@dots{}, \"upper\")\n\ 70 @deftypefnx {Loadable Function} {[@var{L}, @dots{}] =} chol (@dots{}, \"upper\")\n\
71 @cindex Cholesky factorization\n\ 71 @cindex Cholesky factorization\n\
72 Compute the Cholesky@tie{}factor, @var{R}, of the symmetric positive definite\n\ 72 Compute the Cholesky@tie{}factor, @var{R}, of the symmetric positive definite\n\
73 matrix @var{A}, where\n\ 73 matrix @var{A}.\n\
74 \n\
75 The Cholesky@tie{}factor is defined by\n\
74 @tex\n\ 76 @tex\n\
75 $ R^T R = A $.\n\ 77 $ R^T R = A $.\n\
76 @end tex\n\ 78 @end tex\n\
77 @ifnottex\n\ 79 @ifnottex\n\
78 \n\ 80 \n\
87 whether the matrix was positive definite and @code{chol} does not fail. A\n\ 89 whether the matrix was positive definite and @code{chol} does not fail. A\n\
88 zero value indicated that the matrix was positive definite and the @var{R}\n\ 90 zero value indicated that the matrix was positive definite and the @var{R}\n\
89 gives the factorization, and @var{p} will have a positive value otherwise.\n\ 91 gives the factorization, and @var{p} will have a positive value otherwise.\n\
90 \n\ 92 \n\
91 If called with 3 outputs then a sparsity preserving row/column permutation\n\ 93 If called with 3 outputs then a sparsity preserving row/column permutation\n\
92 is applied to @var{A} prior to the factorization. That is @var{R}\n\ 94 is applied to @var{A} prior to the factorization. That is @var{R} is the\n\
93 is the factorization of @code{@var{A}(@var{Q},@var{Q})} such that\n\ 95 factorization of @code{@var{A}(@var{Q},@var{Q})} such that\n\
94 @tex\n\ 96 @tex\n\
95 $ R^T R = Q^T A Q$.\n\ 97 $ R^T R = Q^T A Q$.\n\
96 @end tex\n\ 98 @end tex\n\
97 @ifnottex\n\ 99 @ifnottex\n\
98 \n\ 100 \n\
388 */ 390 */
389 391
390 DEFUN_DLD (cholinv, args, , 392 DEFUN_DLD (cholinv, args, ,
391 "-*- texinfo -*-\n\ 393 "-*- texinfo -*-\n\
392 @deftypefn {Loadable Function} {} cholinv (@var{A})\n\ 394 @deftypefn {Loadable Function} {} cholinv (@var{A})\n\
393 Use the Cholesky@tie{}factorization to compute the inverse of the\n\ 395 Compute the inverse of the symmetric positive definite matrix @var{A} using\n\
394 symmetric positive definite matrix @var{A}.\n\ 396 the Cholesky@tie{}factorization.\n\
395 @seealso{chol, chol2inv, inv}\n\ 397 @seealso{chol, chol2inv, inv}\n\
396 @end deftypefn") 398 @end deftypefn")
397 { 399 {
398 octave_value retval; 400 octave_value retval;
399 401
536 538
537 DEFUN_DLD (chol2inv, args, , 539 DEFUN_DLD (chol2inv, args, ,
538 "-*- texinfo -*-\n\ 540 "-*- texinfo -*-\n\
539 @deftypefn {Loadable Function} {} chol2inv (@var{U})\n\ 541 @deftypefn {Loadable Function} {} chol2inv (@var{U})\n\
540 Invert a symmetric, positive definite square matrix from its Cholesky\n\ 542 Invert a symmetric, positive definite square matrix from its Cholesky\n\
541 decomposition, @var{U}. Note that @var{U} should be an upper-triangular\n\ 543 decomposition, @var{U}.\n\
542 matrix with positive diagonal elements. @code{chol2inv (@var{U})}\n\ 544 \n\
543 provides @code{inv (@var{U}'*@var{U})} but it is much faster than\n\ 545 Note that @var{U} should be an upper-triangular matrix with positive\n\
544 using @code{inv}.\n\ 546 diagonal elements. @code{chol2inv (@var{U})} provides\n\
547 @code{inv (@var{U}'*@var{U})} but it is much faster than using @code{inv}.\n\
545 @seealso{chol, cholinv, inv}\n\ 548 @seealso{chol, cholinv, inv}\n\
546 @end deftypefn") 549 @end deftypefn")
547 { 550 {
548 octave_value retval; 551 octave_value retval;
549 552
627 } 630 }
628 631
629 DEFUN_DLD (cholupdate, args, nargout, 632 DEFUN_DLD (cholupdate, args, nargout,
630 "-*- texinfo -*-\n\ 633 "-*- texinfo -*-\n\
631 @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholupdate (@var{R}, @var{u}, @var{op})\n\ 634 @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholupdate (@var{R}, @var{u}, @var{op})\n\
632 Update or downdate a Cholesky@tie{}factorization. Given an upper triangular\n\ 635 Update or downdate a Cholesky@tie{}factorization.\n\
633 matrix @var{R} and a column vector @var{u}, attempt to determine another\n\ 636 \n\
634 upper triangular matrix @var{R1} such that\n\ 637 Given an upper triangular matrix @var{R} and a column vector @var{u},\n\
638 attempt to determine another upper triangular matrix @var{R1} such that\n\
635 \n\ 639 \n\
636 @itemize @bullet\n\ 640 @itemize @bullet\n\
637 @item\n\ 641 @item\n\
638 @var{R1}'*@var{R1} = @var{R}'*@var{R} + @var{u}*@var{u}'\n\ 642 @var{R1}'*@var{R1} = @var{R}'*@var{R} + @var{u}*@var{u}'\n\
639 if @var{op} is @qcode{\"+\"}\n\ 643 if @var{op} is @qcode{\"+\"}\n\
842 Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian\n\ 846 Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian\n\
843 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper\n\ 847 positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper\n\
844 triangular, return the Cholesky@tie{}factorization of\n\ 848 triangular, return the Cholesky@tie{}factorization of\n\
845 @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ 849 @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\
846 @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ 850 @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\
851 \n\
847 On return, @var{info} is set to\n\ 852 On return, @var{info} is set to\n\
848 \n\ 853 \n\
849 @itemize\n\ 854 @itemize\n\
850 @item 0 if the insertion was successful,\n\ 855 @item 0 if the insertion was successful,\n\
851 \n\ 856 \n\