annotate scripts/sparse/spy.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents e236f1b0a221
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6674
diff changeset
1 ## Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Andy Adler
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6674
diff changeset
2 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6674
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: 6674
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: 6674
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: 6674
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: 6674
diff changeset
8 ## your option) any later version.
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
9 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6674
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: 6674
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6674
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: 6674
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: 6674
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: 6674
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} {} spy (@var{x})
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
21 ## @deftypefnx {Function File} {} spy (@dots{}, @var{markersize})
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
22 ## @deftypefnx {Function File} {} spy (@dots{}, @var{LineSpec})
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
23 ## 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
24 ## @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
25 ## 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
26 ## 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
27 ## @seealso{plot}
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
29
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
30 function spy (S, varargin)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
31
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
32 markersize = NaN;
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
33 if (numel (i) < 1000)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
34 LineSpec = "*";
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
35 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
36 LineSpec = ".";
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
37 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
38 for i = 1:length(varargin)
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
39 if (ischar(varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
40 LineSpec = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
41 elseif (isscalar (varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
42 markersize = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
43 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
44 error ("spy: expected markersize or linespec");
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
45 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
46 endfor
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
47
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
48 if (issparse (S))
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
49 [i, j, s, m, n] = spfind (S);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
50 else
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
51 [i, j, s] = find (S);
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
52 [m, n] = size (S);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
53 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
54
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
55 if (isnan (markersize))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
56 plot (j, i, LineSpec);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
57 else
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
58 plot (j, i, LineSpec, "MarkerSize", markersize);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
59 endif
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
60
6674
e236f1b0a221 [project @ 2007-05-31 18:19:01 by jwe]
jwe
parents: 6669
diff changeset
61 axis ([0, n+1, 0, m+1], "ij");
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
62
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
63 endfunction