octave-nkf: scripts/sparse/spy.m annotate

annotate scripts/sparse/spy.m @ 20526:d8992a16643c

doc: Clean up m-files which generate images for Manual. * geometryimages.m, interpimages.m, plotimages.m, sparseimages.m, splineimages.m: Use the same style throughout the mi-files. Obey Octave coding conventions.

author	Rik <rik@octave.org>
date	Thu, 09 Jul 2015 21:38:57 -0700
parents	df437a52bcaf
children

rev	line source
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19790 diff changeset	1 ## Copyright (C) 1998-2015 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})
19004 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18827 diff changeset	23 ## Plot the sparsity pattern of the sparse matrix @var{x}.
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19004 diff changeset	24 ##
19004 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18827 diff changeset	25 ## If the argument @var{markersize} is given as a scalar value, it is used to
20374 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	26 ## determine the point size in the plot.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	27 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	28 ## If the string @var{line_spec} is given it is passed to @code{plot} and
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20038 diff changeset	29 ## determines the appearance of the plot.
19004 53af80da6781 doc: Update documentation of sparse functions including seealso links. Rik <rik@octave.org> parents: 18827 diff changeset	30 ## @seealso{plot, gplot}
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	31 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	33 function spy (x, varargin)
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	34
7125 f084ba47812b [project @ 2007-11-08 02:29:23 by jwe] jwe parents: 7017 diff changeset	35 if (nargin < 1)
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe] jwe parents: 7017 diff changeset	36 print_usage ();
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe] jwe parents: 7017 diff changeset	37 endif
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe] jwe parents: 7017 diff changeset	38
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	39 markersize = NaN;
18827 3994a1c2b994 spy.m: Use nnz, not numel, to avoid overflowing octave_idx_type (bug #42116). Rik <rik@octave.org> parents: 17744 diff changeset	40 if (nnz (x) < 1000)
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	41 line_spec = "*";
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	42 else
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	43 line_spec = ".";
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	44 endif
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	45 for i = 1:length (varargin)
cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	46 if (ischar (varargin{i}))
13692 9d7233ec8cbc add only color change possibility in spy.m Fotios Kasolis <fotios.kasolis@gmail.com> parents: 13086 diff changeset	47 if (length (varargin{i}) == 1)
9d7233ec8cbc add only color change possibility in spy.m Fotios Kasolis <fotios.kasolis@gmail.com> parents: 13086 diff changeset	48 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	49 else
9d7233ec8cbc add only color change possibility in spy.m Fotios Kasolis <fotios.kasolis@gmail.com> parents: 13086 diff changeset	50 line_spec = varargin{i};
9d7233ec8cbc add only color change possibility in spy.m Fotios Kasolis <fotios.kasolis@gmail.com> parents: 13086 diff changeset	51 endif
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	52 elseif (isscalar (varargin{i}))
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	53 markersize = varargin{i};
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	54 else
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	55 error ("spy: expected markersize or linespec");
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	56 endif
98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	57 endfor
6446 f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe] jwe parents: 5926 diff changeset	58
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	59 [i, j, s] = find (x);
cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	60 [m, n] = size (x);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	61
6607 98724cae69c7 [project @ 2007-05-07 19:57:47 by dbateman] dbateman parents: 6606 diff changeset	62 if (isnan (markersize))
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	63 plot (j, i, line_spec);
6446 f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe] jwe parents: 5926 diff changeset	64 else
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	65 plot (j, i, line_spec, "markersize", markersize);
6446 f82f516c8a00 [project @ 2007-03-23 21:20:21 by jwe] jwe parents: 5926 diff changeset	66 endif
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	67
6674 e236f1b0a221 [project @ 2007-05-31 18:19:01 by jwe] jwe parents: 6669 diff changeset	68 axis ([0, n+1, 0, m+1], "ij");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	69
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	70 endfunction
13086 7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71
7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	72
7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	73 %!demo
7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 %! clf;
7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 %! spy (sprand (10,10, 0.2));
7015842c6562 codesprint: Add demo block for spy.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76
20038 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19898 diff changeset	77 ## Mark graphical function as tested by demo block
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %!assert (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79

Mercurial > hg > octave-nkf

annotate scripts/sparse/spy.m @ 20526:d8992a16643c