Mercurial > octave-nkf

annotate scripts/sparse/svds.m @ 11104:2c356a35d7f5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix copyright notices
author John W. Eaton <jwe@octave.org>
date Sun, 17 Oct 2010 23:43:42 -0400
parents a4f482e66b65
children 994e2a93a8e2
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: 8846
diff changeset
1 ## Copyright (C) 2006, 2008, 2009 David Bateman
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
3 ## This file is part of Octave.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
8 ## your option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
9 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
13 ## General Public License for more details.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
17 ## <http://www.gnu.org/licenses/>.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
20 ## @deftypefn {Function File} {@var{s} =} svds (@var{a})
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{s} =} svds (@var{a}, @var{k})
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## @deftypefnx {Function File} {@var{s} =} svds (@var{a}, @var{k}, @var{sigma})
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @deftypefnx {Function File} {@var{s} =} svds (@var{a}, @var{k}, @var{sigma}, @var{opts})
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
24 ## @deftypefnx {Function File} {[@var{u}, @var{s}, @var{v}] =} svds (@dots{})
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## @deftypefnx {Function File} {[@var{u}, @var{s}, @var{v}, @var{flag}] =} svds (@dots{})
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ##
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## Find a few singular values of the matrix @var{a}. The singular values
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ## are calculated using
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## @example
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ## @group
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## [@var{m}, @var{n}] = size(@var{a})
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
33 ## @var{s} = eigs([sparse(@var{m}, @var{m}), @var{a};
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
34 ## @var{a}', sparse(@var{n}, @var{n})])
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 ## @end group
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 ## @end example
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 ##
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
38 ## The eigenvalues returned by @code{eigs} correspond to the singular values
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
39 ## of @var{a}. The number of singular values to calculate is given by @var{k}
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
40 ## and defaults to 6.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ##
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
42 ## The argument @var{sigma} specifies which singular values to find. When
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
43 ## @var{sigma} is the string 'L', the default, the largest singular values of
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
44 ## @var{a} are found. Otherwise, @var{sigma} must be a real scalar and the
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
45 ## singular values closest to @var{sigma} are found. As a corollary,
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
46 ## @code{@var{sigma} = 0} finds the smallest singular values. Note that for
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
47 ## relatively small values of @var{sigma}, there is a chance that the requested
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
48 ## number of singular values will not be found. In that case @var{sigma}
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
49 ## should be increased.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 ##
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
51 ## @var{opts} is a structure defining options that @code{svds} will pass
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
52 ## to @code{eigs}. The possible fields of this structure are documented in
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
53 ## @code{eigs}. By default, @code{svds} sets the following three fields:
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 ## @table @code
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 ## @item tol
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
57 ## The required convergence tolerance for the singular values. The default
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
58 ## value is 1e-10. @code{eigs} is passed @code{@var{tol} / sqrt(2)}.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 ## @item maxit
9066
be150a172010 Cleanup documentation for diagperm.texi, sparse.texi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
61 ## The maximum number of iterations. The default is 300.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 ## @item disp
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
64 ## The level of diagnostic printout (0|1|2). If @code{disp} is 0 then
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
65 ## diagnostics are disabled. The default value is 0.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 ## @end table
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 ##
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
68 ## If more than one output is requested then @code{svds} will return an
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
69 ## approximation of the singular value decomposition of @var{a}
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
70 ##
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
71 ## @example
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
72 ## @var{a}_approx = @var{u}*@var{s}*@var{v}'
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
73 ## @end example
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
74 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10671
diff changeset
75 ## @noindent
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
76 ## where @var{a}_approx is a matrix of size @var{a} but only rank @var{k}.
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
77 ##
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
78 ## @var{flag} returns 0 if the algorithm has succesfully converged, and 1
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
79 ## otherwise. The test for convergence is
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
80 ##
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 ## @example
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 ## @group
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
83 ## norm (@var{a}*@var{v} - @var{u}*@var{s}, 1) <= @var{tol} * norm (@var{a}, 1)
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 ## @end group
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 ## @end example
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10671
diff changeset
87 ## @code{svds} is best for finding only a few singular values from a large
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10671
diff changeset
88 ## sparse matrix. Otherwise, @code{svd (full(@var{a}))} will likely be more
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10671
diff changeset
89 ## efficient.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 ## @end deftypefn
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
91 ## @seealso{svd, eigs}
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
92
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 function [u, s, v, flag] = svds (a, k, sigma, opts)
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
94
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
95 persistent root2 = sqrt (2);
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
96
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 if (nargin < 1 || nargin > 4)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
98 print_usage ();
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
100
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
101 if (ndims(a) > 2)
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
102 error ("svds: A must be a 2D matrix")
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
103 endif
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
104
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 if (nargin < 4)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
106 opts.tol = 1e-10 / root2;
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 opts.disp = 0;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 opts.maxit = 300;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
110 if (!isstruct (opts))
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
111 error ("svds: OPTS must be a structure");
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
112 endif
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
113 if (!isfield (opts, "tol"))
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
114 opts.tol = 1e-10 / root2;
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
115 else
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
116 opts.tol = opts.tol / root2;
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
117 endif
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
118 if (isfield (opts, "v0"))
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
119 if (!isvector (opts.v0) || (length (opts.v0) != sum (size (a))))
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
120 error ("svds: OPTS.v0 must be a vector with rows(A)+columns(A) entries");
10663
b90328525985 svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents: 10660
diff changeset
121 endif
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
122 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
124
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
125 if (nargin < 3 || strcmp (sigma, "L"))
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
126 if (isreal (a))
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
127 sigma = "LA";
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
128 else
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 sigma = "LR";
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
130 endif
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
131 elseif (isscalar (sigma) && isnumeric (sigma) && isreal (sigma))
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
132 if (sigma < 0)
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
133 error ("svds: SIGMA must be a positive real value");
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
135 else
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
136 error ("svds: SIGMA must be a positive real value or the string 'L'");
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
137 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
138
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
139 [m, n] = size (a);
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
140 max_a = max (abs (a(:)));
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
141 if (max_a == 0)
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
142 s = zeros (k, 1); # special case of zero matrix
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
143 else
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
144 if (nargin < 2)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
145 k = min ([6, m, n]);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
146 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
147 k = min ([k, m, n]);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
148 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
149
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
150 ## Scale everything by the 1-norm to make things more stable.
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
151 b = a / max_a;
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
152 b_opts = opts;
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
153 b_opts.tol = opts.tol / max_a;
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
154 b_sigma = sigma;
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
155 if (!ischar (b_sigma))
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
156 b_sigma = b_sigma / max_a;
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
157 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
158
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
159 if (b_sigma == 0)
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
160 ## Find the smallest eigenvalues
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
161 ## The eigenvalues returns by eigs for sigma=0 are symmetric about 0.
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
162 ## As we are only interested in the positive eigenvalues, we have to
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
163 ## double k and then throw out the k negative eigenvalues.
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
164 ## Separately, if sigma is non-zero, but smaller than the smallest
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
165 ## singular value, ARPACK may not return k eigenvalues. However, as
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
166 ## computation scales with k we'd like to avoid doubling k for all
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
167 ## scalar values of sigma.
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
168 b_k = 2 * k;
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
169 else
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
170 b_k = k; # Normal case, find just the k largest eigenvalues
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
171 endif
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
172
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
173 if (nargout > 1)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
174 [V, s, flag] = eigs ([sparse(m,m), b; b', sparse(n,n)],
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
175 b_k, b_sigma, b_opts);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
176 else
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
177 s = eigs ([sparse(m,m), b; b', sparse(n,n)], b_k, b_sigma, b_opts);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
178 endif
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
179 s = diag (s);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
180
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
181 if (ischar (sigma))
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
182 norma = max (s);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
183 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
184 norma = normest (a);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
185 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
186 ## We wish to exclude all eigenvalues that are less than zero as these
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
187 ## are artifacts of the way the matrix passed to eigs is formed. There
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
188 ## is also the possibility that the value of sigma chosen is exactly
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
189 ## a singular value, and in that case we're dead!! So have to rely on
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
190 ## the warning from eigs. We exclude the singular values which are
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
191 ## less than or equal to zero to within some tolerance scaled by the
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
192 ## norm since if we don't we might end up with too many singular
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
193 ## values.
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
194 tol = norma * opts.tol;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
195 ind = find(s > tol);
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
196 if (length (ind) < k)
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
197 ## Too few eigenvalues returned. Add in any zero eigenvalues of B,
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
198 ## including the nominally negative ones.
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
199 zind = find (abs (s) <= tol);
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
200 p = min (length (zind), k - length (ind));
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
201 ind = [ind; zind(1:p)];
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
202 elseif (length (ind) > k)
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
203 ## Too many eigenvalues returned. Select according to criterium.
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
204 if (b_sigma == 0)
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
205 ind = ind(end+1-k:end); # smallest eigenvalues
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
206 else
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
207 ind = ind(1:k); # largest eigenvalues
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
208 endif
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
209 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
210 s = s(ind);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
211
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
212 if (length (s) < k)
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
213 warning ("returning fewer singular values than requested");
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
214 if (!ischar (sigma))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9209
diff changeset
215 warning ("try increasing the value of sigma");
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
216 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
217 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
218
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
219 s = s * max_a;
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
220 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
221
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
222 if (nargout < 2)
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
223 u = s;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
224 else
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
225 if (max_a == 0)
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
226 u = eye (m, k);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
227 s = diag(s);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
228 v = eye (n, k);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
229 else
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
230 u = root2 * V(1:m,ind);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
231 s = diag(s);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
232 v = root2 * V(m+1:end,ind);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
233 endif
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
234
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
235 if (nargout > 3)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8417
diff changeset
236 flag = norm (a*v - u*s, 1) > root2 * opts.tol * norm (a, 1);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
237 endif
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
238 endif
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
239
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
240 endfunction
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
241
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
242 %!shared n, k, a, u, s, v, opts
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
243 %! n = 100;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
244 %! k = 7;
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
245 %! a = sparse([3:n,1:n,1:(n-2)],[1:(n-2),1:n,3:n],[ones(1,n-2),0.4*n*ones(1,n),ones(1,n-2)]);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
246 %! [u,s,v] = svd(full(a));
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
247 %! s = diag(s);
10660
4cdc43c095c5 Initialize ARPACK starting vector in svds test code. (bug #29721)
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
248 %! [~, idx] = sort(abs(s));
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
249 %! s = s(idx);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
250 %! u = u(:,idx);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
251 %! v = v(:,idx);
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
252 %! randn('state',42); % Initialize to make normest function reproducible
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
253 %! rand('state',42)
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
254 %! opts.v0 = rand (2*n,1); % Initialize eigs ARPACK starting vector
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
255 %! % to guarantee reproducible results
8585
e6497be3f3d6 Skip tests if ARPACK is missing.
Ben Abbott <bpabbott@mac.com>
parents: 8507
diff changeset
256 %!testif HAVE_ARPACK
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
257 %! [u2,s2,v2,flag] = svds(a,k);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
258 %! s2 = diag(s2);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
259 %! assert(flag,!1);
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
260 %! assert(s2, s(end:-1:end-k+1), 1e-10);
8585
e6497be3f3d6 Skip tests if ARPACK is missing.
Ben Abbott <bpabbott@mac.com>
parents: 8507
diff changeset
261 %!testif HAVE_ARPACK
10660
4cdc43c095c5 Initialize ARPACK starting vector in svds test code. (bug #29721)
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
262 %! [u2,s2,v2,flag] = svds(a,k,0,opts);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
263 %! s2 = diag(s2);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
264 %! assert(flag,!1);
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
265 %! assert(s2, s(k:-1:1), 1e-10);
8585
e6497be3f3d6 Skip tests if ARPACK is missing.
Ben Abbott <bpabbott@mac.com>
parents: 8507
diff changeset
266 %!testif HAVE_ARPACK
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
267 %! idx = floor(n/2);
10660
4cdc43c095c5 Initialize ARPACK starting vector in svds test code. (bug #29721)
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
268 %! % Don't put sigma right on a singular value or there are convergence issues
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
269 %! sigma = 0.99*s(idx) + 0.01*s(idx+1);
10660
4cdc43c095c5 Initialize ARPACK starting vector in svds test code. (bug #29721)
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
270 %! [u2,s2,v2,flag] = svds(a,k,sigma,opts);
8417
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
271 %! s2 = diag(s2);
654bcfb937bf Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff changeset
272 %! assert(flag,!1);
10671
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
273 %! assert(s2, s((idx+floor(k/2)):-1:(idx-floor(k/2))), 1e-10);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
274 %!testif HAVE_ARPACK
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
275 %! [u2,s2,v2,flag] = svds(zeros (10), k);
f5f9bc8e83fc svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents: 10663
diff changeset
276 %! assert (isequal(u2, eye (10, k)) && isequal (s2, zeros(k)) && isequal (v2, eye(10, 7)))