Mercurial > hg > octave-lyh
diff scripts/sparse/normest.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Fri, 27 Mar 2009 22:31:03 -0700 |
| parents | eb63fbe60fab |
| children |
line wrap: on
line diff
--- a/scripts/sparse/normest.m +++ b/scripts/sparse/normest.m @@ -19,12 +19,12 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{n}, @var{c}] =} normest (@var{a}, @var{tol}) ## Estimate the 2-norm of the matrix @var{a} using a power series -## analysis. This is typically used for large matrices, where the cost +## analysis. This is typically used for large matrices, where the cost ## of calculating the @code{norm (@var{a})} is prohibitive and an approximation ## to the 2-norm is acceptable. ## -## @var{tol} is the tolerance to which the 2-norm is calculated. By default -## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for +## @var{tol} is the tolerance to which the 2-norm is calculated. By default +## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for ## @code{normest} to converge. ## @end deftypefn