Mercurial > hg > octave-nkf

annotate scripts/sparse/spconvert.m @ 14333:6dd710b73150

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: add yet another file omitted from earlier commit
author John W. Eaton <jwe@octave.org>
date Sun, 05 Feb 2012 15:41:42 -0500
parents 72c96de7a403
children f3d52523cde1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
1 ## Copyright (C) 2004-2012 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})
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
21 ## This function converts for a simple sparse matrix format easily
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7017
diff changeset
22 ## produced by other programs into Octave's internal sparse format. The
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
23 ## input @var{x} is either a 3 or 4 column real matrix, containing
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
24 ## the row, column, real and imaginary parts of the elements of the
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7017
diff changeset
25 ## sparse matrix. An element with a zero real and imaginary part can
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
26 ## be used to force a particular matrix size.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
28
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
29 function s = spconvert (m)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
30
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
31 if (issparse (m))
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
32 s = m;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
33 else
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
34 sz = size (m);
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
35 if (nargin != 1 || ! ismatrix (m) || ! isreal (m)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
36 || 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
37 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
38 elseif (sz(2) == 3)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
39 s = sparse (m(:,1), m(:,2), m(:,3));
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
40 else
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
41 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
42 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
43 endif
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5307
diff changeset
44
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
45 endfunction
13050
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 %!test
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49 %! i = [1; 3; 5];
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
50 %! j = [2; 4; 6];
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
51 %! 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
52 %! s = spconvert ([i, j, v]);
13050
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 %! assert (issparse (s));
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 %! 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
56 %! s = spconvert ([i, j, v, j]);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 %! [fi, fj, fv] = find (s);
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 %! 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
59 %! 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
60
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 %% Test input validation
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 %!error spconvert ()
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 %!error spconvert (1, 2)
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 %!error spconvert ({[1 2 3]})
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 3i])
438b53faa9fa codesprint: Add tests for spconvert.m
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 %!error spconvert ([1 2 3 4 5])