octave-nkf: scripts/sparse/spconvert.m annotate

annotate scripts/sparse/spconvert.m @ 20374: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

rev	line source
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19004 diff changeset	1 ## Copyright (C) 2004-2015 David Bateman and Andy Adler
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	3 ## This file is part of Octave.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	4 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	13 ## General Public License for more details.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	14 ##
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	18
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	20 ## @deftypefn {Function File} {@var{x} =} spconvert (@var{m})
19004 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 17744 diff changeset	21 ## Convert a simple sparse matrix format easily generated by other programs
53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 17744 diff changeset	22 ## into Octave's internal sparse format.
53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 17744 diff changeset	23 ##
20374 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	24 ## The input @var{m} is either a 3 or 4 column real matrix, containing the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	25 ## row, column, real, and imaginary parts of the elements of the sparse
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	26 ## matrix. An element with a zero real and imaginary part can be used to
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	27 ## force a particular matrix size.
19004 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 17744 diff changeset	28 ## @seealso{sparse}
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	29 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	30
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	31 function s = spconvert (m)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32
6498 2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 5307 diff changeset	33 if (issparse (m))
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	34 s = m;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	35 else
6498 2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 5307 diff changeset	36 sz = size (m);
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 5307 diff changeset	37 if (nargin != 1 \|\| ! ismatrix (m) \|\| ! isreal (m)
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9245 diff changeset	38 \|\| length (sz) != 2 \|\| (sz(2) != 3 && sz(2) != 4))
6498 2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 5307 diff changeset	39 error ("spconvert: argument must be sparse or real matrix with 3 or 4 columns");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	40 elseif (sz(2) == 3)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41 s = sparse (m(:,1), m(:,2), m(:,3));
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	42 else
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	43 s = sparse (m(:,1), m(:,2), m(:,3) + 1i*m(:,4));
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	44 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	45 endif
6498 2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 5307 diff changeset	46
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	47 endfunction
13050 438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	48
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	49
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50 %!test
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 %! i = [1; 3; 5];
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 %! j = [2; 4; 6];
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	53 %! v = [7; 8; 9];
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 13050 diff changeset	54 %! s = spconvert ([i, j, v]);
13050 438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	55 %! assert (issparse (s));
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	57 %! assert (isequal (i, fi) && isequal (j, fj) && isequal (v, fv));
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	58 %! s = spconvert ([i, j, v, j]);
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60 %! assert (isequal (i, fi) && isequal (j, fj) && isequal (complex (v, j), fv));
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	61 %! assert (size (spconvert ([1, 1, 3; 5, 15, 0])), [5, 15]);
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62
20038 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19898 diff changeset	63 ## Test input validation
13050 438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	64 %!error spconvert ()
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	65 %!error spconvert (1, 2)
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	66 %!error spconvert ({[1 2 3]})
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67 %!error spconvert ([1 2])
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	68 %!error spconvert ([1 2 3i])
438b53faa9fa codesprint: Add tests for spconvert.m Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	69 %!error spconvert ([1 2 3 4 5])
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70

Mercurial > hg > octave-nkf

annotate scripts/sparse/spconvert.m @ 20374:df437a52bcaf stable