Mercurial > octave

diff scripts/linear-algebra/condest.m @ 22299:9fc91bb2aec3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: grammarcheck documentation for 4.2 release. * container.txi, contrib.txi, diagperm.txi, errors.txi, external.txi, func.txi, image.txi, nonlin.txi, numbers.txi, plot.txi, quad.txi, sparse.txi, strings.txi, tips.txi, var.txi, vectorize.txi, __dispatch__.cc, cellfun.cc, file-io.cc, gsvd.cc, load-path.cc, regexp.cc, __init_gnuplot__.cc, __osmesa_print__.cc, qr.cc, xzip.cc, ov-classdef.cc, octave_config_info.m, grabcode.m, publish.m, dialog.m, condest.m, normest1.m, mkdir.m, ode23.m, ode45.m, odeplot.m, AbsRel_Norm.m, integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, axis.m, isocaps.m, isocolors.m, isosurface.m, light.m, __calc_isovalue_from_data__.m, __marching_cube__.m, cov.m, median.m: doc: grammarcheck documentation for 4.2 release.
author Rik <rik@octave.org>
date Mon, 15 Aug 2016 10:05:50 -0700
parents bfb1b089c230
children bac0d6f07a3e
line wrap: on
line diff
--- a/scripts/linear-algebra/condest.m	Mon Aug 15 12:46:51 2016 +0200
+++ b/scripts/linear-algebra/condest.m	Mon Aug 15 10:05:50 2016 -0700
@@ -35,24 +35,33 @@
 ##
 ## @itemize @minus
 ## @item @var{afun} which should returns
+##
 ## @itemize @bullet
 ## @item
-## the dimension @var{n} of @var{a}, if @var{flag} is "dim"
+## the dimension @var{n} of @var{a}, if @var{flag} is @qcode{"dim"}
+##
 ## @item
-## true if @var{a} is a real operator, if @var{flag} is "real"
+## true if @var{a} is a real operator, if @var{flag} is @qcode{"real"}
+##
 ## @item
 ## the result @code{@var{a} * @var{x}}, if @var{flag} is "notransp"
+##
 ## @item
 ## the result @code{@var{a}' * @var{x}}, if @var{flag} is "transp"
 ## @end itemize
+##
 ## @item @var{solvefun} which should returns
+##
 ## @itemize @bullet
 ## @item
-## the dimension @var{n} of @var{a}, if @var{flag} is "dim"
+## the dimension @var{n} of @var{a}, if @var{flag} is @qcode{"dim"}
+##
 ## @item
-## true if @var{a} is a real operator, if @var{flag} is "real"
+## true if @var{a} is a real operator, if @var{flag} is @qcode{"real"}
+##
 ## @item
 ## the result @code{@var{a} \ @var{x}}, if @var{flag} is "notransp"
+##
 ## @item
 ## the result @code{@var{a}' \ @var{x}}, if @var{flag} is "transp"
 ## @end itemize
@@ -64,8 +73,9 @@
 ## @dots{})}.
 ##
 ## @code{condest} uses a randomized algorithm to approximate the
-## 1-norms. Therefore, if consistent results are required, the "state" of the
-## random generator should be fixed before invoking @code{normest1}.
+## 1-norms.  Therefore, if consistent results are required, the
+## @qcode{"state"} of the random generator should be fixed before invoking
+## @code{normest1}.
 ##
 ## @code{condest} returns the 1-norm condition estimate @var{est} and a vector
 ## @var{v} satisfying @code{norm (A*v, 1) == norm (A, 1) * norm