Mercurial > hg > octave-nkf
diff scripts/sparse/pcr.m @ 11563:3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 18 Jan 2011 20:55:01 -0800 |
parents | fd0a3ac60b0e |
children | c792872f8942 |
line wrap: on
line diff
--- a/scripts/sparse/pcr.m +++ b/scripts/sparse/pcr.m @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {@var{x} =} pcr (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{m}, @var{x0}, @dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} pcr (@dots{}) ## -## Solves the linear system of equations @code{@var{A} * @var{x} = -## @var{b}} by means of the Preconditioned Conjugate Residuals iterative +## Solves the linear system of equations @code{@var{A} * @var{x} = @var{b}} +## by means of the Preconditioned Conjugate Residuals iterative ## method. The input arguments are ## ## @itemize @@ -38,9 +38,10 @@ ## ## @item ## @var{tol} is the required relative tolerance for the residual error, -## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if @code{norm -## (@var{b} - @var{A} * @var{x}) <= @var{tol} * norm (@var{b} - @var{A} * -## @var{x0})}. If @var{tol} is empty or is omitted, the function sets +## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if +## @code{norm (@var{b} - @var{A} * @var{x}) <= +## @var{tol} * norm (@var{b} - @var{A} * @var{x0})}. +## If @var{tol} is empty or is omitted, the function sets ## @code{@var{tol} = 1e-6} by default. ## ## @item