annotate scripts/sparse/spy.m @ 6669:39d76485706a

[project @ 2007-05-29 17:44:30 by jwe]
author jwe
date Tue, 29 May 2007 17:44:30 +0000
parents 98724cae69c7
children e236f1b0a221
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998-2004 Andy Adler
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
2 ##
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
6 ## (at your option) any later version.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
7 ##
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
11 ## GNU General Public License for more details.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
12 ##
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5215
diff changeset
15 ## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5215
diff changeset
16 ## 02110-1301 USA
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
17
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
18 ## -*- texinfo -*-
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
19 ## @deftypefn {Function File} {} spy (@var{x})
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
20 ## @deftypefnx {Function File} {} spy (@dots{}, @var{markersize})
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
21 ## @deftypefnx {Function File} {} spy (@dots{}, @var{LineSpec})
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
22 ## Plot the sparsity pattern of the sparse matrix @var{x}. If the argument
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
23 ## @var{markersize} is given as an scalar value, it is used to determine the
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
24 ## point size in the plot. If the string @var{LineSpec} is given it is
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
25 ## passed to @code{plot} and determines the appearance of the plot.
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
26 ## @seealso{plot}
5164
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
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
29 function spy (S, varargin)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
30
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
31 markersize = NaN;
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
32 if (numel (i) < 1000)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
33 LineSpec = "*";
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
34 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
35 LineSpec = ".";
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
36 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
37 for i = 1:length(varargin)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
38 if (ischar(varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
39 LineSpec = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
40 elseif (isscalar (varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
41 markersize = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
42 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
43 error ("spy: expected markersize or linespec");
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
44 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
45 endfor
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
46
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
47 if (issparse (S))
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
48 [i, j, s, m, n] = spfind (S);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
49 else
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
50 [i, j, s] = find (S);
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
51 [m, n] = size (S);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
52 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
53
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
54 if (isnan (markersize))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
55 plot (j, i, LineSpec);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
56 else
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
57 plot (j, i, LineSpec, "MarkerSize", markersize);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
58 endif
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
59
6669
39d76485706a [project @ 2007-05-29 17:44:30 by jwe]
jwe
parents: 6607
diff changeset
60 axis ([0, n+1, m+1, 0], "ij");
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
61
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
62 endfunction