Mercurial > hg > octave-lyh
annotate scripts/sparse/svds.m @ 14363:f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
* wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m,
asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m,
csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m,
accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m,
celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m,
cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m,
flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m,
interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m,
isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m,
narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m,
randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m,
structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m,
griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m,
get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m,
imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m,
textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m,
duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m,
issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m,
qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m,
bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m,
fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m,
ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m,
news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m,
setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m,
warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m,
pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m,
__plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m,
colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m,
ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m,
ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m,
legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m,
orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m,
refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m,
stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m,
deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m,
polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m,
ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m,
autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m,
fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m,
sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m,
pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m,
sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m,
beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m,
nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m,
realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m,
vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m,
iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m,
median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m,
range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m,
statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m,
betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m,
cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m,
chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m,
empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m,
expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m,
gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m,
hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m,
laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m,
logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m,
lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m,
norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m,
poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m,
tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m,
unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m,
wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m,
strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m,
substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m,
asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m,
eomday.m, etime.m, is_leap_year.m, now.m:
Use Octave coding conventions in all m-file %!test blocks
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:29:44 -0800 |
parents | 4d917a6a858b |
children | 5d3a684236b0 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14041
diff
changeset
|
1 ## Copyright (C) 2006-2012 David Bateman |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
2 ## |
11104 | 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 | 5 ## Octave is free software; you can redistribute it and/or modify it |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
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 | 16 ## along with Octave; see the file COPYING. If not, see |
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 -*- |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
20 ## @deftypefn {Function File} {@var{s} =} svds (@var{A}) |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{s} =} svds (@var{A}, @var{k}) |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{s} =} svds (@var{A}, @var{k}, @var{sigma}) |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
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 ## |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
27 ## Find a few singular values of the matrix @var{A}. The singular values |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
28 ## are calculated using |
8417
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 |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14182
diff
changeset
|
32 ## [@var{m}, @var{n}] = size (@var{A}); |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14182
diff
changeset
|
33 ## @var{s} = eigs ([sparse(@var{m}, @var{m}), @var{A}; |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14182
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 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
38 ## The eigenvalues returned by @code{eigs} correspond to the singular values |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
39 ## of @var{A}. The number of singular values to calculate is given by @var{k} |
10663
b90328525985
svds.m: Validate struct input argument.
Rik <octave@nomad.inbox5.com>
parents:
10660
diff
changeset
|
40 ## and defaults to 6. |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
41 ## |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
42 ## The argument @var{sigma} specifies which singular values to find. When |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
43 ## @var{sigma} is the string 'L', the default, the largest singular values of |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
44 ## @var{A} are found. Otherwise, @var{sigma} must be a real scalar and the |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
45 ## singular values closest to @var{sigma} are found. As a corollary, |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
46 ## @code{@var{sigma} = 0} finds the smallest singular values. Note that for |
10671
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 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
48 ## number of singular values will not be found. In that case @var{sigma} |
10671
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 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
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 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
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 |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
64 ## The level of diagnostic printout (0|1|2). If @code{disp} is 0 then |
10671
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
69 ## approximation of the singular value decomposition of @var{A} |
10671
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
72 ## @var{A}_approx = @var{u}*@var{s}*@var{v}' |
10671
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
76 ## where @var{A}_approx is a matrix of size @var{A} but only rank @var{k}. |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
77 ## |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
78 ## @var{flag} returns 0 if the algorithm has succesfully converged, and 1 |
10671
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
88 ## sparse matrix. Otherwise, @code{svd (full(@var{A}))} will likely be more |
10846
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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
93 function [u, s, v, flag] = svds (A, k, sigma, opts) |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
94 |
8507 | 95 persistent root2 = sqrt (2); |
96 | |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
97 if (nargin < 1 || nargin > 4) |
8507 | 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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
101 if (ndims(A) > 2) |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
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 | 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 | 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 | 113 if (!isfield (opts, "tol")) |
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")) |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
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 | 125 if (nargin < 3 || strcmp (sigma, "L")) |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
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 | 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 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
139 [m, n] = size (A); |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
140 max_a = max (abs (A(:))); |
8507 | 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 | 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 | 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. |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
151 b = A / max_a; |
8507 | 152 b_opts = opts; |
12649
8579e7a6e6e0
Improve performance (2X) of svds by avoiding issymmetric calculation (bug #33073)
Rik <octave@nomad.inbox5.com>
parents:
12517
diff
changeset
|
153 ## Call to eigs is always a symmetric matrix by construction |
8579e7a6e6e0
Improve performance (2X) of svds by avoiding issymmetric calculation (bug #33073)
Rik <octave@nomad.inbox5.com>
parents:
12517
diff
changeset
|
154 b_opts.issym = true; |
8507 | 155 b_opts.tol = opts.tol / max_a; |
156 b_sigma = sigma; | |
157 if (!ischar (b_sigma)) | |
158 b_sigma = b_sigma / max_a; | |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
159 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
160 |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
161 if (b_sigma == 0) |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
162 ## Find the smallest eigenvalues |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
163 ## The eigenvalues returns by eigs for sigma=0 are symmetric about 0. |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
164 ## As we are only interested in the positive eigenvalues, we have to |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
165 ## double k and then throw out the k negative eigenvalues. |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
166 ## Separately, if sigma is non-zero, but smaller than the smallest |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
167 ## singular value, ARPACK may not return k eigenvalues. However, as |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
168 ## computation scales with k we'd like to avoid doubling k for all |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
169 ## scalar values of sigma. |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
170 b_k = 2 * k; |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
171 else |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
172 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
|
173 endif |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
174 |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
175 if (nargout > 1) |
8507 | 176 [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
|
177 b_k, b_sigma, b_opts); |
12517
c2e8c9d9e284
Fix bug #32818, nonconformant arguments in svds.
Rik <octave@nomad.inbox5.com>
parents:
12329
diff
changeset
|
178 s = diag (s); |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
179 else |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
180 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
|
181 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
182 |
8507 | 183 if (ischar (sigma)) |
184 norma = max (s); | |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
185 else |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
186 norma = normest (A); |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
187 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
188 ## We wish to exclude all eigenvalues that are less than zero as these |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
189 ## are artifacts of the way the matrix passed to eigs is formed. There |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
190 ## is also the possibility that the value of sigma chosen is exactly |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
191 ## a singular value, and in that case we're dead!! So have to rely on |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
192 ## 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
|
193 ## 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
|
194 ## 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
|
195 ## values. |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
196 tol = norma * opts.tol; |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
197 ind = find(s > tol); |
8507 | 198 if (length (ind) < k) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
199 ## Too few eigenvalues returned. Add in any zero eigenvalues of B, |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
200 ## including the nominally negative ones. |
8507 | 201 zind = find (abs (s) <= tol); |
202 p = min (length (zind), k - length (ind)); | |
203 ind = [ind; zind(1:p)]; | |
204 elseif (length (ind) > k) | |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
205 ## 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
|
206 if (b_sigma == 0) |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
207 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
|
208 else |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
209 ind = ind(1:k); # largest eigenvalues |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
210 endif |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
211 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
212 s = s(ind); |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
213 |
8507 | 214 if (length (s) < k) |
215 warning ("returning fewer singular values than requested"); | |
216 if (!ischar (sigma)) | |
10549 | 217 warning ("try increasing the value of sigma"); |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
218 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
219 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
220 |
8507 | 221 s = s * max_a; |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
222 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
223 |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
224 if (nargout < 2) |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
225 u = s; |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
226 else |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
227 if (max_a == 0) |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
228 u = eye (m, k); |
12517
c2e8c9d9e284
Fix bug #32818, nonconformant arguments in svds.
Rik <octave@nomad.inbox5.com>
parents:
12329
diff
changeset
|
229 s = diag (s); |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
230 v = eye (n, k); |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
231 else |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
232 u = root2 * V(1:m,ind); |
12517
c2e8c9d9e284
Fix bug #32818, nonconformant arguments in svds.
Rik <octave@nomad.inbox5.com>
parents:
12329
diff
changeset
|
233 s = diag (s); |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
234 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
|
235 endif |
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
236 |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
237 if (nargout > 3) |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
238 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
|
239 endif |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
240 endif |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
241 |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
242 endfunction |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
243 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
244 |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
245 %!shared n, k, A, u, s, v, opts, rand_state, randn_state |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
246 %! n = 100; |
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
247 %! k = 7; |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
248 %! 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)]); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
249 %! [u,s,v] = svd (full (A)); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
250 %! s = diag (s); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
251 %! [~, idx] = sort (abs(s)); |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
252 %! s = s(idx); |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
253 %! u = u(:, idx); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
254 %! v = v(:, idx); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
255 %! randn_state = randn ("state"); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
256 %! rand_state = rand ("state"); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
257 %! randn ("state", 42); % Initialize to make normest function reproducible |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
258 %! rand ("state", 42); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
259 %! opts.v0 = rand (2*n,1); % Initialize eigs ARPACK starting vector |
10671
f5f9bc8e83fc
svds.m: Overhaul code while fixing bug #29721.
Rik <octave@nomad.inbox5.com>
parents:
10663
diff
changeset
|
260 %! % to guarantee reproducible results |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
261 %! |
14144
834df9f10963
remove ARPACK files from sources and restore configure checks for external ARPACK library
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
262 %!testif HAVE_ARPACK |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
263 %! [u2,s2,v2,flag] = svds (A,k); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
264 %! s2 = diag (s2); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
265 %! assert (flag, !1); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
266 %! assert (s2, s(end:-1:end-k+1), 1e-10); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
267 %! |
14182
f8d99761244c
test: Expand %!testif functionality to multiple conditions
Rik <octave@nomad.inbox5.com>
parents:
14144
diff
changeset
|
268 %!testif HAVE_ARPACK, HAVE_UMFPACK |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
269 %! [u2,s2,v2,flag] = svds (A,k,0,opts); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
270 %! s2 = diag (s2); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
271 %! assert (flag, !1); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
272 %! assert (s2, s(k:-1:1), 1e-10); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
273 %! |
14182
f8d99761244c
test: Expand %!testif functionality to multiple conditions
Rik <octave@nomad.inbox5.com>
parents:
14144
diff
changeset
|
274 %!testif HAVE_ARPACK, HAVE_UMFPACK |
8417
654bcfb937bf
Add the eigs and svds functions
David Bateman <dbateman@free.fr>
parents:
diff
changeset
|
275 %! idx = floor(n/2); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
276 %! % Don't put sigma right on a singular value or there are convergence issues |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
277 %! sigma = 0.99*s(idx) + 0.01*s(idx+1); |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
278 %! [u2,s2,v2,flag] = svds (A,k,sigma,opts); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
279 %! s2 = diag (s2); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
280 %! assert (flag, !1); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
281 %! assert (s2, s((idx+floor(k/2)):-1:(idx-floor(k/2))), 1e-10); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
282 %! |
14144
834df9f10963
remove ARPACK files from sources and restore configure checks for external ARPACK library
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
283 %!testif HAVE_ARPACK |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
284 %! [u2,s2,v2,flag] = svds (zeros (10), k); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
285 %! assert (u2, eye (10, k)); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
286 %! assert (s2, zeros (k)); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
287 %! assert (v2, eye (10, 7)); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
288 %! |
14144
834df9f10963
remove ARPACK files from sources and restore configure checks for external ARPACK library
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
289 %!testif HAVE_ARPACK |
12517
c2e8c9d9e284
Fix bug #32818, nonconformant arguments in svds.
Rik <octave@nomad.inbox5.com>
parents:
12329
diff
changeset
|
290 %! s = svds (speye (10)); |
c2e8c9d9e284
Fix bug #32818, nonconformant arguments in svds.
Rik <octave@nomad.inbox5.com>
parents:
12329
diff
changeset
|
291 %! assert (s, ones (6, 1), 2*eps); |
13747
e8564e8b0043
Restore random number state after %!demos or %!tests
Rik <octave@nomad.inbox5.com>
parents:
12939
diff
changeset
|
292 |
14041
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
293 %!test |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
294 %! ## Restore random number generator seeds at end of tests |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
295 %! rand ("state", rand_state); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
296 %! randn ("state", randn_state); |
6cb6e390e58c
svds.m: Correctly restore random seed state after %!tests
Rik <octave@nomad.inbox5.com>
parents:
13747
diff
changeset
|
297 |