Mercurial > octave-antonio

comparison scripts/sparse/gmres.m @ 20164:df437a52bcaf 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 miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 0a3ca546d7fc
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) 20 ## @deftypefn {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0})
21 ## @deftypefnx {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{P}) 21 ## @deftypefnx {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{P})
22 ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} gmres (@dots{}) 22 ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} gmres (@dots{})
23 ## Solve @code{A x = b} using the Preconditioned GMRES iterative method 23 ## Solve @code{A x = b} using the Preconditioned GMRES iterative method with
24 ## with restart, a.k.a. PGMRES(m). 24 ## restart, a.k.a. PGMRES(m).
25 ## 25 ##
26 ## @itemize @minus 26 ## @itemize @minus
27 ## @item @var{rtol} is the relative tolerance, 27 ## @item @var{rtol} is the relative tolerance,
28 ## if not given or set to [] the default value 1e-6 is used. 28 ## if not given or set to [] the default value 1e-6 is used.
29 ## 29 ##
30 ## @item @var{maxit} is the maximum number of outer iterations, 30 ## @item @var{maxit} is the maximum number of outer iterations, if not given or
31 ## if not given or set to [] the default value 31 ## set to [] the default value @code{min (10, numel (b) / restart)} is used.
32 ## @code{min (10, numel (b) / restart)} is used.
33 ## 32 ##
34 ## @item @var{x0} is the initial guess, 33 ## @item @var{x0} is the initial guess,
35 ## if not given or set to [] the default value @code{zeros (size (b))} is used. 34 ## if not given or set to [] the default value @code{zeros (size (b))} is used.
36 ## 35 ##
37 ## @item @var{m} is the restart parameter, 36 ## @item @var{m} is the restart parameter,
38 ## if not given or set to [] the default value @code{numel (b)} is used. 37 ## if not given or set to [] the default value @code{numel (b)} is used.
39 ## @end itemize 38 ## @end itemize
40 ## 39 ##
41 ## Argument @var{A} can be passed as a matrix, function handle, or 40 ## Argument @var{A} can be passed as a matrix, function handle, or inline
42 ## inline function @code{f} such that @code{f(x) = A*x}. 41 ## function @code{f} such that @code{f(x) = A*x}.
43 ## 42 ##
44 ## The preconditioner @var{P} is given as @code{P = M1 * M2}. 43 ## The preconditioner @var{P} is given as @code{P = M1 * M2}. Both @var{M1}
45 ## Both @var{M1} and @var{M2} can be passed as a matrix, function handle, or 44 ## and @var{M2} can be passed as a matrix, function handle, or inline function
46 ## inline function @code{g} such that @code{g(x) = M1\x} or @code{g(x) = M2\x}. 45 ## @code{g} such that @code{g(x) = M1\x} or @code{g(x) = M2\x}.
47 ## 46 ##
48 ## Besides the vector @var{x}, additional outputs are: 47 ## Besides the vector @var{x}, additional outputs are:
49 ## 48 ##
50 ## @itemize @minus 49 ## @itemize @minus
51 ## @item @var{flag} indicates the exit status: 50 ## @item @var{flag} indicates the exit status: