Mercurial > octave-antonio
diff scripts/linear-algebra/condest.m @ 20160: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 |
line wrap: on
line diff
--- a/scripts/linear-algebra/condest.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/condest.m Sun May 03 15:36:23 2015 -0700 @@ -23,8 +23,9 @@ ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{A}, @var{solve}, @var{solve_t}, @var{t}) ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{apply}, @var{apply_t}, @var{solve}, @var{solve_t}, @var{n}, @var{t}) ## -## Estimate the 1-norm condition number of a matrix @var{A} -## using @var{t} test vectors using a randomized 1-norm estimator. +## Estimate the 1-norm condition number of a matrix @var{A} using @var{t} test +## vectors using a randomized 1-norm estimator. +## ## If @var{t} exceeds 5, then only 5 test vectors are used. ## ## If the matrix is not explicit, e.g., when estimating the condition @@ -47,11 +48,10 @@ ## ## The implicit version requires an explicit dimension @var{n}. ## -## @code{condest} uses a randomized algorithm to approximate -## the 1-norms. +## @code{condest} uses a randomized algorithm to approximate the 1-norms. ## -## @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 +## @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 ## (@var{v}, 1) / @var{est}}. When @var{est} is large, @var{v} is an ## approximate null vector. ##