diff scripts/sparse/cgs.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents 1673a0dc019f
children 1740012184f9
line wrap: on
line diff
--- a/scripts/sparse/cgs.m
+++ b/scripts/sparse/cgs.m
@@ -17,15 +17,18 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} cgs (@var{A}, @var{b})
+## @deftypefn  {Function File} {} cgs (@var{A}, @var{b})
 ## @deftypefnx {Function File} {} cgs (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0})
 ## This procedure attempts to solve a system of linear equations A*x = b for x.
 ## The @var{A} must be square, symmetric and positive definite real matrix N*N.
 ## The @var{b} must be a one column vector with a length of N.
 ## The @var{tol} specifies the tolerance of the method, default value is 1e-6.
-## The @var{maxit} specifies the maximum number of iteration, default value is MIN(20,N).
-## The @var{M1} specifies a preconditioner, can also be a function handler which returns M\X.
-## The @var{M2} combined with @var{M1} defines preconditioner as preconditioner=M1*M2.
+## The @var{maxit} specifies the maximum number of iteration, default value is
+## MIN(20,N).
+## The @var{M1} specifies a preconditioner, can also be a function handler which
+## returns M\X.
+## The @var{M2} combined with @var{M1} defines preconditioner as
+## preconditioner=M1*M2.
 ## The @var{x0} is initial guess, default value is zeros(N,1).
 ##
 ## @end deftypefn