Mercurial > octave-nkf

changeset 13070:a0d854f079d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
codesprint: Fix building of docs for new bicg functions
author Jordi Gutiérrez Hermoso <jordigh@gmail.com>
date Sat, 03 Sep 2011 14:37:38 -0500
parents 48c94e21b57f
children a3d21c3c0f58
files scripts/linear-algebra/bicg.m scripts/linear-algebra/module.mk scripts/sparse/bicgstab.m
diffstat 3 files changed, 14 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/linear-algebra/bicg.m	Sat Sep 03 15:24:44 2011 -0400
+++ b/scripts/linear-algebra/bicg.m	Sat Sep 03 14:37:38 2011 -0500
@@ -51,7 +51,7 @@
 ##   @item @var{resvec} is a vector containing the relative residual at each iteration.
 ##   @end itemize
 ##
-##   @seealso{pcg,cgs,bigcstab,gmres}
+##   @seealso{pcg,cgs,bicgstab,gmres}
 ##
 ## @end deftypefn
 
--- a/scripts/linear-algebra/module.mk	Sat Sep 03 15:24:44 2011 -0400
+++ b/scripts/linear-algebra/module.mk	Sat Sep 03 14:37:38 2011 -0500
@@ -1,6 +1,7 @@
 FCN_FILE_DIRS += linear-algebra
 
 linear_algebra_FCN_FILES = \
+	linear-algebra/bicg.m \
   linear-algebra/commutation_matrix.m \
   linear-algebra/cond.m \
   linear-algebra/condest.m \
--- a/scripts/sparse/bicgstab.m	Sat Sep 03 15:24:44 2011 -0400
+++ b/scripts/sparse/bicgstab.m	Sat Sep 03 14:37:38 2011 -0500
@@ -26,9 +26,17 @@
 ##   Solve @code{A x = b} using the stabilizied Bi-conjugate gradient iterative method.
 ##
 ##   @itemize @minus
-##   @item @var{rtol} is the relative tolerance, if not given or set to [] the default value 1e-6 is used.
-##   @item @var{maxit} the maximum number of outer iterations, if not given or set to [] the default value @code{min (20, numel (b))} is used.
-##   @item @var{x0} the initial guess, if not given or set to [] the default value @code{zeros (size (b))} is used. 
+##
+##   @item @var{rtol} is the relative tolerance, if not given or set to
+##   [] the default value 1e-6 is used.
+##
+##   @item @var{maxit} the maximum number of outer iterations, if not
+##   given or set to [] the default value @code{min (20, numel (b))} is
+##   used.
+##
+##   @item @var{x0} the initial guess, if not given or set to [] the
+##   default value @code{zeros (size (b))} is used.
+##
 ##   @end itemize
 ##
 ##   @var{A} can be passed as a matrix or as a function handle or 
@@ -53,7 +61,7 @@
 ##   @item @var{resvec} is a vector containing the relative residual at each iteration.
 ##   @end itemize
 ##
-##   @seealso{pcg,cgs,bigc,gmres}
+##   @seealso{pcg,cgs,bicg,gmres}
 ##
 ## @end deftypefn