Mercurial > octave

annotate scripts/sparse/spconvert.m @ 22323:bac0d6f07a3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright notices for 2016.
author John W. Eaton <jwe@octave.org>
date Wed, 17 Aug 2016 01:05:19 -0400
parents 3be6a07e8bad
children 3a2b891d0b33 e9a0469dedd9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22323
bac0d6f07a3e maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents: 21178
diff changeset
1 ## Copyright (C) 2004-2016 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 -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20164
diff changeset
20 ## @deftypefn {} {@var{x} =} spconvert (@var{m})
18809
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 ##
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
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: 19833
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: 19833
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: 19833
diff changeset
27 ## force a particular matrix size.
18809
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
21171
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
33 if (nargin != 1)
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
34 print_usage ();
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
35 endif
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
36
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
37 if (issparse (m))
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
38 s = m;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
39 else
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
40 sz = size (m);
21171
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
41 if (! ismatrix (m) || ! isreal (m)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
42 || length (sz) != 2 || (sz(2) != 3 && sz(2) != 4))
21171
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
43 error (["spconvert: argument must be sparse or real matrix" ...
2935d56203a4 Fix regressions caused by ismatrix definition change (partial fix bug #47036).
Rik <rik@octave.org>
parents: 20164
diff changeset
44 "with 3 or 4 columns"]);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
45 elseif (sz(2) == 3)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
46 s = sparse (m(:,1), m(:,2), m(:,3));
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
47 else
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
48 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
49 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
50 endif
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
51
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
52 endfunction
13050
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 %!test
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 %! i = [1; 3; 5];
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 %! j = [2; 4; 6];
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 %! 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
59 %! s = spconvert ([i, j, v]);
13050
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 %! assert (issparse (s));
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 %! 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
63 %! s = spconvert ([i, j, v, j]);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
65 %! 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
66 %! 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
67
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
68 ## Test input validation
13050
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 %!error spconvert ()
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
70 %!error spconvert (1, 2)
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
71 %!error spconvert ({[1 2 3]})
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
72 %!error spconvert ([1 2])
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
73 %!error spconvert ([1 2 3i])
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
74 %!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
75