comparison scripts/sparse/bicgstab.m @ 25003:2365c2661b3c stable

doc: Spellcheck documentation ahead of 4.4 release. * aspell-octave.en.pws: Add new words to Octave-only spelling dictionary. Remove exception words which are no longer used in manual. * basics.txi, bugs.txi, func.txi, geometry.txi, install.txi, matrix.txi, package.txi, plot.txi, poly.txi, preface.txi, quad.txi, sparse.txi, strings.txi, vectorize.txi, data.cc, defaults.cc, file-io.cc, pinv.cc, quadcc.cc, qz.cc, rand.cc, schur.cc, syscalls.cc, sysdep.cc, toplev.cc, amd.cc, audioread.cc, colamd.cc, dmperm.cc, symrcm.cc, quadgk.m, quadl.m, imfinfo.m, rgb2gray.m, javachk.m, usejava.m, unpack.m, fzero.m, glpk.m, pqpnonneg.m, stemleaf.m, print.m, polyfit.m, blackman.m, bicgstab.m, cgs.m, eigs.m, pcg.m, tfqmr.m, gallery.m, rosser.m, toeplitz.m, vander.m, isstrprop.m: Add @nospell{} macro around proper names and other words which aspell should not check. Correct misspellings identified by aspell.
author Rik <rik@octave.org>
date Mon, 26 Mar 2018 10:45:04 -0700
parents 3d5a39077708
children 6652d3823428
comparison
equal deleted inserted replaced
25002:64c6e8bfc9e5 25003:2365c2661b3c
51 ## @var{M} is given as @code{@var{M} = @var{M1} * @var{M2}}. 51 ## @var{M} is given as @code{@var{M} = @var{M1} * @var{M2}}.
52 ## Both @var{M1} and @var{M2} can be passed as a matrix or as a function 52 ## Both @var{M1} and @var{M2} can be passed as a matrix or as a function
53 ## handle or inline function @code{g} such that 53 ## handle or inline function @code{g} such that
54 ## @code{g(@var{x}) = @var{M1} \ @var{x}} or 54 ## @code{g(@var{x}) = @var{M1} \ @var{x}} or
55 ## @code{g(@var{x}) = @var{M2} \ @var{x}}. 55 ## @code{g(@var{x}) = @var{M2} \ @var{x}}.
56 ## The techinque used is the right preconditioning, i.e., it is 56 ## The technique used is the right preconditioning, i.e., it is
57 ## solved @code{@var{A} * inv (@var{M}) * @var{y} = @var{b}} and then 57 ## solved @code{@var{A} * inv (@var{M}) * @var{y} = @var{b}} and then
58 ## @code{@var{x} = inv (@var{M}) * @var{y}}. 58 ## @code{@var{x} = inv (@var{M}) * @var{y}}.
59 ## 59 ##
60 ## @item @var{x0} the initial guess, if not given or set to [] the default 60 ## @item @var{x0} the initial guess, if not given or set to [] the default
61 ## value @code{zeros (size (@var{b}))} is used. 61 ## value @code{zeros (size (@var{b}))} is used.
183 ## M = M1 * M2; 183 ## M = M1 * M2;
184 ## 184 ##
185 ## ## reference solution computed by bicgstab after one iteration 185 ## ## reference solution computed by bicgstab after one iteration
186 ## [x_ref, fl] = bicgstab (A, b, [], 1, M) 186 ## [x_ref, fl] = bicgstab (A, b, [], 1, M)
187 ## 187 ##
188 ## ## rigth preconditioning 188 ## ## right preconditioning
189 ## [y, fl] = bicgstab (A / M, b, [], 1) 189 ## [y, fl] = bicgstab (A / M, b, [], 1)
190 ## x = M \ y # compare x and x_ref 190 ## x = M \ y # compare x and x_ref
191 ## 191 ##
192 ## @end group 192 ## @end group
193 ## @end example 193 ## @end example