Mercurial > octave-nkf
diff scripts/sparse/pcg.m @ 20199:df437a52bcaf stable
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 | 9fc020886ae9 |
| children |
line wrap: on
line diff
--- a/scripts/sparse/pcg.m Sun May 03 21:52:42 2015 -0700 +++ b/scripts/sparse/pcg.m Mon May 04 14:22:02 2015 -0700 @@ -21,8 +21,9 @@ ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}, @var{eigest}] =} pcg (@dots{}) ## ## Solve the linear system of equations @w{@code{@var{A} * @var{x} = @var{b}}} -## by means of the Preconditioned Conjugate Gradient iterative method. The -## input arguments are +## by means of the Preconditioned Conjugate Gradient iterative method. +## +## The input arguments are ## ## @itemize ## @item @@ -52,14 +53,13 @@ ## the iteration is (theoretically) equivalent to solving by @code{pcg} ## @w{@code{@var{P} * @var{x} = @var{m} \ @var{b}}}, with ## @w{@code{@var{P} = @var{m} \ @var{A}}}. -## Note that a proper choice of the preconditioner may dramatically -## improve the overall performance of the method. Instead of matrices -## @var{m1} and @var{m2}, the user may pass two functions which return -## the results of applying the inverse of @var{m1} and @var{m2} to -## a vector (usually this is the preferred way of using the preconditioner). -## If @var{m1} is omitted or empty @code{[]} then no preconditioning is -## applied. If @var{m2} is omitted, @var{m} = @var{m1} will be used as -## a preconditioner. +## Note that a proper choice of the preconditioner may dramatically improve +## the overall performance of the method. Instead of matrices @var{m1} and +## @var{m2}, the user may pass two functions which return the results of +## applying the inverse of @var{m1} and @var{m2} to a vector (usually this is +## the preferred way of using the preconditioner). If @var{m1} is omitted or +## empty @code{[]} then no preconditioning is applied. If @var{m2} is +## omitted, @var{m} = @var{m1} will be used as a preconditioner. ## ## @item ## @var{x0} is the initial guess. If @var{x0} is omitted or empty then the @@ -154,16 +154,16 @@ ## @end example ## ## @sc{Example 4:} @code{pcg} with a preconditioner: @var{l} * @var{u}. -## Faster than @sc{Example 3} since lower and upper triangular matrices -## are easier to invert +## Faster than @sc{Example 3} since lower and upper triangular matrices are +## easier to invert ## ## @example ## x = pcg (A, b, 1.e-6, 500, l, u) ## @end example ## ## @sc{Example 5:} Preconditioned iteration, with full diagnostics. The -## preconditioner (quite strange, because even the original matrix -## @var{A} is trivial) is defined as a function +## preconditioner (quite strange, because even the original matrix @var{A} is +## trivial) is defined as a function ## ## @example ## @group @@ -179,8 +179,8 @@ ## @end group ## @end example ## -## @sc{Example 6:} Finally, a preconditioner which depends on a -## parameter @var{k}. +## @sc{Example 6:} Finally, a preconditioner which depends on a parameter +## @var{k}. ## ## @example ## @group