annotate scripts/sparse/normest.m @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents cadc73247d65
children 1bf0ce0930be
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
1 ## Copyright (C) 2006, 2007, 2008, 2009 David Bateman and Marco Caliari
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
3 ## This file is part of Octave.
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
13 ## General Public License for more details.
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
14 ##
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
18
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {[@var{n}, @var{c}] =} normest (@var{a}, @var{tol})
6222
07d967f75dba [project @ 2007-01-03 20:15:15 by jwe]
jwe
parents: 6213
diff changeset
21 ## Estimate the 2-norm of the matrix @var{a} using a power series
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
22 ## analysis. This is typically used for large matrices, where the cost
6222
07d967f75dba [project @ 2007-01-03 20:15:15 by jwe]
jwe
parents: 6213
diff changeset
23 ## of calculating the @code{norm (@var{a})} is prohibitive and an approximation
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
24 ## to the 2-norm is acceptable.
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
25 ##
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
26 ## @var{tol} is the tolerance to which the 2-norm is calculated. By default
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
27 ## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
28 ## @code{normest} to converge.
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
29 ## @end deftypefn
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
30
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
31 function [e1, c] = normest (A, tol)
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
32 if (nargin < 2)
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
33 tol = 1e-6;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
34 endif
7795
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
35 if (isa (A, "single"))
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
36 if (tol < eps ("single"))
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
37 tol = eps ("single");
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
38 endif
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
39 else
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
40 if (tol < eps)
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
41 tol = eps
df9519e9990c Handle single precision eps values
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
42 endif
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
43 endif
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7795
diff changeset
44 if (ndims (A) != 2)
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
45 error ("normest: A must be a matrix");
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
46 endif
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
47 maxA = max (max (abs (A)));
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
48 c = 0;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
49 if (maxA == 0)
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
50 e1 = 0
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
51 else
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
52 [m, n] = size (A);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
53 B = A / maxA;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
54 Bt = B';
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
55 if (m > n)
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
56 tmp = B;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
57 B = Bt;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
58 Bt = tmp;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
59 endif
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
60 e0 = 0;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
61 x = randn (min (m, n), 1);
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
62 e1 = norm (x);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
63 x = x / e1;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
64 e1 = sqrt (e1);
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
65 if (issparse (A))
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
66 while (abs (e1 - e0) > tol * e1)
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
67 e0 = e1;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
68 x = B * (Bt * x);
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
69 e1 = norm (x);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
70 x = x / e1;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
71 e1 = sqrt (e1);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
72 c = c + 1;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
73 endwhile
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
74 else
6213
0a259ae4375e [project @ 2006-12-08 22:05:59 by dbateman]
dbateman
parents: 6212
diff changeset
75 B = B * Bt;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
76 while (abs (e1 - e0) > tol * e1)
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
77 e0 = e1;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
78 x = B * x;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
79 e1 = norm (x);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
80 x = x / e1;
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6222
diff changeset
81 e1 = sqrt (e1);
6212
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
82 c = c + 1;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
83 endwhile
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
84 endif
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
85 e1 = e1 * maxA;
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
86 endif
cc34c0be7b00 [project @ 2006-12-08 11:17:12 by dbateman]
dbateman
parents:
diff changeset
87 endfunction