Mercurial > octave-nkf

comparison libinterp/corefcn/lu.cc @ 20207:4f45eaf83908 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 libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 17d647821d61
children 00cf2847355d
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
69 @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}, @var{R}] =} lu (@var{S})\n\ 69 @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}, @var{R}] =} lu (@var{S})\n\
70 @deftypefnx {Built-in Function} {[@dots{}] =} lu (@var{S}, @var{thres})\n\ 70 @deftypefnx {Built-in Function} {[@dots{}] =} lu (@var{S}, @var{thres})\n\
71 @deftypefnx {Built-in Function} {@var{y} =} lu (@dots{})\n\ 71 @deftypefnx {Built-in Function} {@var{y} =} lu (@dots{})\n\
72 @deftypefnx {Built-in Function} {[@dots{}] =} lu (@dots{}, \"vector\")\n\ 72 @deftypefnx {Built-in Function} {[@dots{}] =} lu (@dots{}, \"vector\")\n\
73 @cindex LU decomposition\n\ 73 @cindex LU decomposition\n\
74 Compute the LU@tie{}decomposition of @var{A}. If @var{A} is full\n\ 74 Compute the LU@tie{}decomposition of @var{A}.\n\
75 subroutines from\n\ 75 \n\
76 @sc{lapack} are used and if @var{A} is sparse then @sc{umfpack} is used. The\n\ 76 If @var{A} is full subroutines from @sc{lapack} are used and if @var{A} is\n\
77 result is returned in a permuted form, according to the optional return\n\ 77 sparse then @sc{umfpack} is used.\n\
78 \n\
79 The result is returned in a permuted form, according to the optional return\n\
78 value @var{P}. For example, given the matrix @code{a = [1, 2; 3, 4]},\n\ 80 value @var{P}. For example, given the matrix @code{a = [1, 2; 3, 4]},\n\
79 \n\ 81 \n\
80 @example\n\ 82 @example\n\
81 [l, u, p] = lu (@var{a})\n\ 83 [l, u, p] = lu (@var{a})\n\
82 @end example\n\ 84 @end example\n\
605 @w{@var{A} = @var{L}*@var{U}}, @var{L}@tie{}lower unit trapezoidal and\n\ 607 @w{@var{A} = @var{L}*@var{U}}, @var{L}@tie{}lower unit trapezoidal and\n\
606 @var{U}@tie{}upper trapezoidal, return the LU@tie{}factorization\n\ 608 @var{U}@tie{}upper trapezoidal, return the LU@tie{}factorization\n\
607 of @w{@var{A} + @var{x}*@var{y}.'}, where @var{x} and @var{y} are\n\ 609 of @w{@var{A} + @var{x}*@var{y}.'}, where @var{x} and @var{y} are\n\
608 column vectors (rank-1 update) or matrices with equal number of columns\n\ 610 column vectors (rank-1 update) or matrices with equal number of columns\n\
609 (rank-k update).\n\ 611 (rank-k update).\n\
610 Optionally, row-pivoted updating can be used by supplying\n\ 612 \n\
611 a row permutation (pivoting) matrix @var{P};\n\ 613 Optionally, row-pivoted updating can be used by supplying a row permutation\n\
612 in that case, an updated permutation matrix is returned.\n\ 614 (pivoting) matrix @var{P}; in that case, an updated permutation matrix is\n\
613 Note that if @var{L}, @var{U}, @var{P} is a pivoted LU@tie{}factorization\n\ 615 returned. Note that if @var{L}, @var{U}, @var{P} is a pivoted\n\
614 as obtained by @code{lu}:\n\ 616 LU@tie{}factorization as obtained by @code{lu}:\n\
615 \n\ 617 \n\
616 @example\n\ 618 @example\n\
617 [@var{L}, @var{U}, @var{P}] = lu (@var{A});\n\ 619 [@var{L}, @var{U}, @var{P}] = lu (@var{A});\n\
618 @end example\n\ 620 @end example\n\
619 \n\ 621 \n\
634 \n\ 636 \n\
635 The first form uses the unpivoted algorithm, which is faster, but less\n\ 637 The first form uses the unpivoted algorithm, which is faster, but less\n\
636 stable. The second form uses a slower pivoted algorithm, which is more\n\ 638 stable. The second form uses a slower pivoted algorithm, which is more\n\
637 stable.\n\ 639 stable.\n\
638 \n\ 640 \n\
639 The matrix case is done as a sequence of rank-1 updates;\n\ 641 The matrix case is done as a sequence of rank-1 updates; thus, for large\n\
640 thus, for large enough k, it will be both faster and more accurate to\n\ 642 enough k, it will be both faster and more accurate to recompute the\n\
641 recompute the factorization from scratch.\n\ 643 factorization from scratch.\n\
642 @seealso{lu, cholupdate, qrupdate}\n\ 644 @seealso{lu, cholupdate, qrupdate}\n\
643 @end deftypefn") 645 @end deftypefn")
644 { 646 {
645 octave_idx_type nargin = args.length (); 647 octave_idx_type nargin = args.length ();
646 octave_value_list retval; 648 octave_value_list retval;