Mercurial > octave
view scripts/sparse/spdiags.m @ 28789:28de41192f3c
Eliminate unneeded verification of nargin, nargout in m-files.
* FIRfilter.m, FIRfilter_aggregation.m, get.m, polynomial.m,
polynomial_superiorto.m, polynomial2.m, makeUniqueStrings.m, base64decode.m,
base64encode.m, cd.m, lin2mu.m, record.m, sound.m, soundsc.m, accumarray.m,
accumdim.m, bitcmp.m, bitset.m, cart2pol.m, celldisp.m, circshift.m,
cplxpair.m, cumtrapz.m, flip.m, idivide.m, interpft.m, logspace.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, rat.m, rot90.m, rotdim.m, shift.m, shiftdim.m,
sortrows.m, trapz.m, dsearch.m, dsearchn.m, getappdata.m, getpixelposition.m,
guidata.m, guihandles.m, isappdata.m, listfonts.m, uigetdir.m,
waitforbuttonpress.m, __makeinfo__.m, doc.m, get_first_help_sentence.m,
autumn.m, bone.m, brighten.m, cmpermute.m, cmunique.m, colorcube.m, contrast.m,
cool.m, copper.m, cubehelix.m, flag.m, gray.m, gray2ind.m, hot.m, hsv.m,
im2double.m, im2frame.m, imformats.m, jet.m, lines.m, ocean.m, pink.m, prism.m,
rainbow.m, rgbplot.m, spinmap.m, spring.m, summer.m, viridis.m, white.m,
winter.m, beep.m, importdata.m, is_valid_file_id.m, javachk.m, javaclasspath.m,
findstr.m, genvarname.m, strmatch.m, bandwidth.m, commutation_matrix.m, cond.m,
cross.m, isdefinite.m, ishermitian.m, issymmetric.m, krylov.m, linsolve.m,
logm.m, lscov.m, null.m, ordeig.m, orth.m, rank.m, rref.m, vecnorm.m,
bunzip2.m, citation.m, computer.m, copyfile.m, dir.m, dos.m, fileattrib.m,
gunzip.m, inputParser.m, inputname.m, ismac.m, ispc.m, isunix.m, license.m,
list_primes.m, methods.m, mkdir.m, movefile.m, nargchk.m, news.m,
orderfields.m, recycle.m, tar.m, unix.m, unpack.m, untar.m, unzip.m, ver.m,
version.m, what.m, zip.m, decic.m, fminbnd.m, fminunc.m, fsolve.m, fzero.m,
glpk.m, humps.m, lsqnonneg.m, optimget.m, pqpnonneg.m, sqp.m, pathdef.m,
camlookat.m, hidden.m, specular.m, plotmatrix.m, smooth3.m, sombrero.m,
stemleaf.m, __gnuplot_drawnow__.m, __opengl_info__.m, ancestor.m, cla.m,
close.m, closereq.m, copyobj.m, gca.m, gcf.m, ginput.m, graphics_toolkit.m,
groot.m, hgload.m, hgsave.m, isgraphics.m, ishold.m, linkaxes.m, meshgrid.m,
newplot.m, refresh.m, refreshdata.m, rotate.m, saveas.m, struct2hdl.m, conv.m,
mkpp.m, mpoles.m, padecoef.m, pchip.m, polyder.m, polyfit.m, polygcd.m,
polyint.m, polyout.m, polyval.m, ppder.m, ppint.m, getpref.m, ispref.m,
rmpref.m, profexport.m, profshow.m, powerset.m, arch_fit.m, arma_rnd.m,
blackman.m, detrend.m, diffpara.m, fftconv.m, fftfilt.m, filter2.m, freqz.m,
freqz_plot.m, hamming.m, hanning.m, sinetone.m, sinewave.m, spectral_adf.m,
spectral_xdf.m, stft.m, unwrap.m, gplot.m, ichol.m, ilu.m, spdiags.m, sprand.m,
sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, betainc.m,
betaincinv.m, ellipke.m, gammainc.m, gammaincinv.m, legendre.m, pow2.m,
hankel.m, pascal.m, rosser.m, toeplitz.m, bounds.m, corr.m, cov.m, histc.m,
kendall.m, kurtosis.m, mad.m, mode.m, moment.m, prctile.m, quantile.m, range.m,
ranks.m, run_count.m, skewness.m, spearman.m, std.m, var.m, zscore.m,
dec2base.m, dec2bin.m, dec2hex.m, index.m, mat2str.m, native2unicode.m,
ostrsplit.m, strjoin.m, strjust.m, strtok.m, substr.m, unicode2native.m,
untabify.m, __debug_octave__.m, demo.m, example.m, fail.m, oruntests.m,
dump_demos.m, speed.m, test.m, date.m, datenum.m, datestr.m, datevec.m,
is_leap_year.m, now.m, weekday.m:
Eliminate unneeded verification of nargin, nargout in m-files now that
the interpreter checks these values.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 24 Sep 2020 14:44:58 -0700 |
parents | bd51beb6205e |
children | 90fea9cc9caa |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{B} =} spdiags (@var{A}) ## @deftypefnx {} {[@var{B}, @var{d}] =} spdiags (@var{A}) ## @deftypefnx {} {@var{B} =} spdiags (@var{A}, @var{d}) ## @deftypefnx {} {@var{A} =} spdiags (@var{v}, @var{d}, @var{A}) ## @deftypefnx {} {@var{A} =} spdiags (@var{v}, @var{d}, @var{m}, @var{n}) ## A generalization of the function @code{diag}. ## ## Called with a single input argument, the nonzero diagonals @var{d} of ## @var{A} are extracted. ## ## With two arguments the diagonals to extract are given by the vector @var{d}. ## ## The other two forms of @code{spdiags} modify the input matrix by replacing ## the diagonals. They use the columns of @var{v} to replace the diagonals ## represented by the vector @var{d}. If the sparse matrix @var{A} is ## defined then the diagonals of this matrix are replaced. Otherwise a ## matrix of @var{m} by @var{n} is created with the diagonals given by the ## columns of @var{v}. ## ## Negative values of @var{d} represent diagonals below the main diagonal, and ## positive values of @var{d} diagonals above the main diagonal. ## ## For example: ## ## @example ## @group ## spdiags (reshape (1:12, 4, 3), [-1 0 1], 5, 4) ## @result{} 5 10 0 0 ## 1 6 11 0 ## 0 2 7 12 ## 0 0 3 8 ## 0 0 0 4 ## @end group ## @end example ## ## @seealso{diag} ## @end deftypefn function [B, d] = spdiags (v, d, m, n) if (nargin < 1) print_usage (); endif if (nargin == 1 || nargin == 2) ## extract nonzero diagonals of A into B,d [nr, nc] = size (v); [i, j] = find (v); if (nargin == 1) ## d contains the active diagonals d = unique (j-i); endif ## FIXME: Maybe this could be done faster using [i,j,v] = find (v) ## and then massaging the indices i, j. However, some ## benchmarking has shown that diag() written in C++ makes ## the following code faster even with the for loop. Brows = min (nr, nc); B = zeros (Brows, length (d)); for k = 1:length (d) dn = d(k); if (dn <= -nr || dn > nc) continue; endif dv = diag (v, dn); len = rows (dv); ## Put sub/super-diagonals in the right place based on matrix size (MxN) if (nr >= nc) if (dn > 0) offset = Brows - len + 1; B(offset:Brows, k) = dv; else B(1:len, k) = dv; endif else if (dn < 0) offset = Brows - len + 1; B(offset:Brows, k) = dv; else B(1:len, k) = dv; endif endif endfor elseif (nargin == 3) ## Replace specific diagonals d of m with v,d [nr, nc] = size (m); A = spdiags (m, d); B = m - spdiags (A, d, nr, nc) + spdiags (v, d, nr, nc); else ## Create new matrix of size mxn using v,d [j, i, v] = find (v); if (m >= n) offset = max (min (d(:), n-m), 0); else offset = d(:); endif j = j(:) + offset(i(:)); i = j - d(:)(i(:)); idx = i > 0 & i <= m & j > 0 & j <= n; B = sparse (i(idx), j(idx), v(idx), m, n); endif endfunction %!test %! [B,d] = spdiags (magic (3)); %! assert (d, [-2 -1 0 1 2]'); %! assert (B, [4 3 8 0 0 %! 0 9 5 1 0 %! 0 0 2 7 6]); %! B = spdiags (magic (3), [-2 1]); %! assert (B, [4 0; 0 1; 0 7]); ## Test zero filling for supra- and super-diagonals %!test %! ## Case 1: M = N %! A = sparse (zeros (3,3)); %! A(1,3) = 13; %! A(3,1) = 31; %! [B, d] = spdiags (A); %! assert (d, [-2 2]'); %! assert (B, [31 0; 0 0; 0 13]); %! assert (spdiags (B, d, 3,3), A); %!test %! ## Case 1: M > N %! A = sparse (zeros (4,3)); %! A(1,3) = 13; %! A(3,1) = 31; %! [B, d] = spdiags (A); %! assert (d, [-2 2]'); %! assert (B, [31 0; 0 0; 0 13]); %! assert (spdiags (B, d, 4,3), A); %!test %! ## Case 1: M < N %! A = sparse (zeros (3,4)); %! A(1,3) = 13; %! A(3,1) = 31; %! [B, d] = spdiags (A); %! assert (d, [-2 2]'); %! assert (B, [0 13; 0 0; 31 0]); %! assert (spdiags (B, d, 3,4), A); %!assert (spdiags (zeros (1,0),1,1,1), sparse (0)) %!assert (spdiags (zeros (0,1),1,1,1), sparse (0)) %!assert (spdiags ([0.5 -1 0.5], 0:2, 1, 1), sparse (0.5)) ## Test input validation %!error spdiags () %!error spdiags (1,2,3,4,5)