annotate scripts/sparse/spy.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents 9d7233ec8cbc
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: 13692
diff changeset
1 ## Copyright (C) 1998-2012 Andy Adler
7016
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 -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10714
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})
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
22 ## @deftypefnx {Function File} {} spy (@dots{}, @var{line_spec})
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ## Plot the sparsity pattern of the sparse matrix @var{x}. If the argument
13692
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
24 ## @var{markersize} is given as a scalar value, it is used to determine the
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## point size in the plot. If the string @var{line_spec} is given it is
6607
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
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
30 function spy (x, varargin)
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
31
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
32 if (nargin < 1)
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
33 print_usage ();
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
34 endif
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
35
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
36 markersize = NaN;
10714
600bdfb08540 Fix typo in spy.m
Brad Froehle <brad.froehle@gmail.com>
parents: 9051
diff changeset
37 if (numel (x) < 1000)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
38 line_spec = "*";
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
39 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
40 line_spec = ".";
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
41 endif
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
42 for i = 1:length (varargin)
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
43 if (ischar (varargin{i}))
13692
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
44 if (length (varargin{i}) == 1)
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
45 line_spec = [line_spec, varargin{i}];
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
46 else
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
47 line_spec = varargin{i};
9d7233ec8cbc add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents: 13086
diff changeset
48 endif
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
49 elseif (isscalar (varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
50 markersize = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
51 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
52 error ("spy: expected markersize or linespec");
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
53 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
54 endfor
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
55
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
56 [i, j, s] = find (x);
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
57 [m, n] = size (x);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
58
6607
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman]
dbateman
parents: 6606
diff changeset
59 if (isnan (markersize))
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
60 plot (j, i, line_spec);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
61 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
62 plot (j, i, line_spec, "markersize", markersize);
6446
f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe]
jwe
parents: 5926
diff changeset
63 endif
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
64
6674
e236f1b0a221 [project @ 2007-05-31 18:19:01 by jwe]
jwe
parents: 6669
diff changeset
65 axis ([0, n+1, 0, m+1], "ij");
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
66
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
67 endfunction
13086
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
68
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
69
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
70 %!demo
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
71 %! clf;
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
72 %! spy (sprand (10,10, 0.2));
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
73
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
74 %% Mark graphical function as tested by demo block
7015842c6562 codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
75 %!assert (1);