Mercurial > octave-antonio
view scripts/sparse/spconvert.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2004-2015 David Bateman and Andy Adler ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{x} =} spconvert (@var{m}) ## Convert a simple sparse matrix format easily generated by other programs ## into Octave's internal sparse format. ## ## The input @var{m} is either a 3 or 4 column real matrix, containing the ## row, column, real, and imaginary parts of the elements of the sparse ## matrix. An element with a zero real and imaginary part can be used to ## force a particular matrix size. ## @seealso{sparse} ## @end deftypefn function s = spconvert (m) if (issparse (m)) s = m; else sz = size (m); if (nargin != 1 || ! ismatrix (m) || ! isreal (m) || length (sz) != 2 || (sz(2) != 3 && sz(2) != 4)) error ("spconvert: argument must be sparse or real matrix with 3 or 4 columns"); elseif (sz(2) == 3) s = sparse (m(:,1), m(:,2), m(:,3)); else s = sparse (m(:,1), m(:,2), m(:,3) + 1i*m(:,4)); endif endif endfunction %!test %! i = [1; 3; 5]; %! j = [2; 4; 6]; %! v = [7; 8; 9]; %! s = spconvert ([i, j, v]); %! assert (issparse (s)); %! [fi, fj, fv] = find (s); %! assert (isequal (i, fi) && isequal (j, fj) && isequal (v, fv)); %! s = spconvert ([i, j, v, j]); %! [fi, fj, fv] = find (s); %! assert (isequal (i, fi) && isequal (j, fj) && isequal (complex (v, j), fv)); %! assert (size (spconvert ([1, 1, 3; 5, 15, 0])), [5, 15]); ## Test input validation %!error spconvert () %!error spconvert (1, 2) %!error spconvert ({[1 2 3]}) %!error spconvert ([1 2]) %!error spconvert ([1 2 3i]) %!error spconvert ([1 2 3 4 5])