Mercurial > hg > octave-nkf

diff scripts/linear-algebra/gmres.m @ 12642:f96b9b9f141b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Periodic grammarcheck and spellcheck of documentation. * func.txi: Correct two misspellings * cumtrapz.m, dblquad.m, quadgk.m, quadl.m, quadv.m, trapz.m, triplequad.m, cond.m, gmres.m, bzip2.m, compare_versions.m, getappdata.m, unpack.m, ver.m, glpk.m, pkg.m, axis.m, uigetdir.m, uigetfile.m, view.m, prctile.m, quantile.m, unidcdf.m, unidinv.m, isstrprop.m, balance.cc, besselj.cc, cellfun.cc, colamd.cc, dot.cc, eigs.cc, fftw.cc, matrix_type.cc, pinv.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, regexp.cc, schur.cc, time.cc (gmtime), typecast.cc urlwrite.cc bitfcns.cc (bitshift), data.cc (rem, norm, merge) debug.cc (dbstatus), dirfns.cc (glob), file-io.cc (freport), load-path.cc (genpath), load-save.cc (save), mappers.cc (islower, isupper, tolower, toupper) oct-hist.cc (edit_history), ov-fcn-inline.cc (vectorize), ov.cc (subsref), syscalls.cc (stat), variables.cc (whos, clear): Improve docstrings. Removed trailing whitespace characters on line.
author Rik <octave@nomad.inbox5.com>
date Sun, 01 May 2011 11:39:50 -0700
parents e742720c5e71
children 13bcd62824a7
line wrap: on
line diff
--- a/scripts/linear-algebra/gmres.m
+++ b/scripts/linear-algebra/gmres.m
@@ -24,25 +24,25 @@
 ## with restart, a.k.a. PGMRES(m).
 ##
 ## @itemize @minus
-## @item @var{rtol} is the relative tolerance, 
+## @item @var{rtol} is the relative tolerance,
 ## if not given or set to [] the default value 1e-6 is used.
 ##
 ## @item @var{maxit} is the maximum number of outer iterations,
-## if not given or set to [] the default value 
+## if not given or set to [] the default value
 ## @code{min (10, numel (b) / restart)} is used.
 ##
 ## @item @var{x0} is the initial guess,
-## if not given or set to [] the default value @code{zeros(size (b))} is used. 
+## if not given or set to [] the default value @code{zeros(size (b))} is used.
 ##
 ## @item @var{m} is the restart parameter,
 ## if not given or set to [] the default value @code{numel (b)} is used.
 ## @end itemize
 ##
-## Argument @var{A} can be passed as a matrix, function handle, or 
+## Argument @var{A} can be passed as a matrix, function handle, or
 ## inline function @code{f} such that @code{f(x) = A*x}.
 ##
-## The preconditioner @var{P} is given as @code{P = M1 * M2}. 
-## Both @var{M1} and @var{M2} can be passed as a matrix, function handle, or 
+## The preconditioner @var{P} is given as @code{P = M1 * M2}.
+## Both @var{M1} and @var{M2} can be passed as a matrix, function handle, or
 ## inline function @code{g} such that @code{g(x) = M1\x} or @code{g(x) = M2\x}.
 ##
 ## Besides the vector @var{x}, additional outputs are:
@@ -63,7 +63,7 @@
 ## @item @var{relres} is the final value of the relative residual.
 ##
 ## @item @var{iter} is a vector containing the number of outer iterations and
-## total iterations performed. 
+## total iterations performed.
 ##
 ## @item @var{resvec} is a vector containing the relative residual at each
 ## iteration.