Mercurial > hg > octave-nkf
diff scripts/linear-algebra/onenormest.m @ 20370:03b9d17a2d95 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed io, java, linear-algebra, prefs, and set script directories.
* scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m,
scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m,
scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m,
scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m,
scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m,
scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m,
scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m,
scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m,
scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m,
scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m,
scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m,
scripts/set/powerset.m, scripts/set/setdiff.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 15:36:23 -0700 |
parents | 00e31f316a3a |
children | b0f7ee81d974 |
line wrap: on
line diff
--- a/scripts/linear-algebra/onenormest.m +++ b/scripts/linear-algebra/onenormest.m @@ -21,8 +21,9 @@ ## @deftypefnx {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{apply}, @var{apply_t}, @var{n}, @var{t}) ## ## Apply @nospell{Higham and Tisseur's} randomized block 1-norm estimator to -## matrix @var{A} using @var{t} test vectors. If @var{t} exceeds 5, then -## only 5 test vectors are used. +## matrix @var{A} using @var{t} test vectors. +## +## If @var{t} exceeds 5, then only 5 test vectors are used. ## ## If the matrix is not explicit, e.g., when estimating the norm of ## @code{inv (@var{A})} given an LU@tie{}factorization, @code{onenormest} @@ -31,11 +32,10 @@ ## @var{n} by @var{t}. The implicit version requires an explicit dimension ## @var{n}. ## -## Returns the norm estimate @var{est}, two vectors @var{v} and -## @var{w} related by norm -## @code{(@var{w}, 1) = @var{est} * norm (@var{v}, 1)}, -## and the number of iterations @var{iter}. The number of -## iterations is limited to 10 and is at least 2. +## Returns the norm estimate @var{est}, two vectors @var{v} and @var{w} related +## by norm @code{(@var{w}, 1) = @var{est} * norm (@var{v}, 1)}, and the number +## of iterations @var{iter}. The number of iterations is limited to 10 and is +## at least 2. ## ## References: ##