Mercurial > hg > octave-nkf

comparison scripts/sparse/normest.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{n}, @var{c}] =} normest (@var{a}, @var{tol}) 20 ## @deftypefn {Function File} {[@var{n}, @var{c}] =} normest (@var{a}, @var{tol})
21 ## Estimate the 2-norm of the matrix @var{a} using a power series 21 ## Estimate the 2-norm of the matrix @var{a} using a power series
22 ## analysis. This is typically used for large matrices, where the cost 22 ## analysis. This is typically used for large matrices, where the cost
23 ## of calculating the @code{norm (@var{a})} is prohibitive and an approximation 23 ## of calculating the @code{norm (@var{a})} is prohibitive and an approximation
24 ## to the 2-norm is acceptable. 24 ## to the 2-norm is acceptable.
25 ## 25 ##
26 ## @var{tol} is the tolerance to which the 2-norm is calculated. By default 26 ## @var{tol} is the tolerance to which the 2-norm is calculated. By default
27 ## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for 27 ## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for
28 ## @code{normest} to converge. 28 ## @code{normest} to converge.
29 ## @end deftypefn 29 ## @end deftypefn
30 30
31 function [e1, c] = normest (A, tol) 31 function [e1, c] = normest (A, tol)
32 if (nargin < 2) 32 if (nargin < 2)