Mercurial > octave-antonio

comparison scripts/sparse/bicg.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
21 ## @deftypefnx {Function File} {@var{x} =} bicg (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{P}) 21 ## @deftypefnx {Function File} {@var{x} =} bicg (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{P})
22 ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicg (@var{A}, @var{b}, @dots{}) 22 ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicg (@var{A}, @var{b}, @dots{})
23 ## Solve @code{A x = b} using the Bi-conjugate gradient iterative method. 23 ## Solve @code{A x = b} using the Bi-conjugate gradient iterative method.
24 ## 24 ##
25 ## @itemize @minus 25 ## @itemize @minus
26 ## @item @var{rtol} is the relative tolerance, if not given 26 ## @item @var{rtol} is the relative tolerance, if not given or set to [] the
27 ## or set to [] the default value 1e-6 is used. 27 ## default value 1e-6 is used.
28 ## 28 ##
29 ## @item @var{maxit} the maximum number of outer iterations, 29 ## @item @var{maxit} the maximum number of outer iterations, if not given or
30 ## if not given or set to [] the default value 30 ## set to [] the default value @code{min (20, numel (b))} is used.
31 ## @code{min (20, numel (b))} is used. 31 ##
32 ## 32 ## @item @var{x0} the initial guess, if not given or set to [] the default
33 ## @item @var{x0} the initial guess, if not given or set to [] 33 ## value @code{zeros (size (b))} is used.
34 ## the default value @code{zeros (size (b))} is used.
35 ## @end itemize 34 ## @end itemize
36 ## 35 ##
37 ## @var{A} can be passed as a matrix or as a function handle or 36 ## @var{A} can be passed as a matrix or as a function handle or inline function
38 ## inline function @code{f} such that @code{f(x, "notransp") = A*x} 37 ## @code{f} such that @code{f(x, "notransp") = A*x} and
39 ## and @code{f(x, "transp") = A'*x}. 38 ## @code{f(x, "transp") = A'*x}.
40 ## 39 ##
41 ## The preconditioner @var{P} is given as @code{P = M1 * M2}. 40 ## The preconditioner @var{P} is given as @code{P = M1 * M2}. Both @var{M1}
42 ## Both @var{M1} and @var{M2} can be passed as a matrix or as 41 ## and @var{M2} can be passed as a matrix or as a function handle or inline
43 ## a function handle or inline function @code{g} such that 42 ## function @code{g} such that @code{g(x, "notransp") = M1 \ x} or
44 ## @code{g(x, "notransp") = M1 \ x} or @code{g(x, "notransp") = M2 \ x} and 43 ## @code{g(x, "notransp") = M2 \ x} and @code{g(x, "transp") = M1' \ x} or
45 ## @code{g(x, "transp") = M1' \ x} or @code{g(x, "transp") = M2' \ x}. 44 ## @code{g(x, "transp") = M2' \ x}.
46 ## 45 ##
47 ## If called with more than one output parameter 46 ## If called with more than one output parameter
48 ## 47 ##
49 ## @itemize @minus 48 ## @itemize @minus
50 ## @item @var{flag} indicates the exit status: 49 ## @item @var{flag} indicates the exit status: