octave-antonio: scripts/sparse/gplot.m annotate

annotate scripts/sparse/gplot.m @ 20164:df437a52bcaf stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Mon, 04 May 2015 14:22:02 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 2005-2015 Ivana Varekova
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6746 diff changeset	3 ## This file is part of Octave.
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	4 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6746 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: 6746 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: 6746 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: 6746 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6746 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6746 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: 6746 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6746 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: 6746 diff changeset	13 ## General Public License for more details.
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	14 ##
7e008607a86e [project @ 2005-12-13 19:05:54 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: 6746 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: 6746 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	18
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	20 ## @deftypefn {Function File} {} gplot (@var{A}, @var{xy})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	21 ## @deftypefnx {Function File} {} gplot (@var{A}, @var{xy}, @var{line_style})
994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	22 ## @deftypefnx {Function File} {[@var{x}, @var{y}] =} gplot (@var{A}, @var{xy})
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ## Plot a graph defined by @var{A} and @var{xy} in the graph theory sense.
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	24 ##
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	25 ## @var{A} is the adjacency matrix of the array to be plotted and @var{xy} is
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## an @var{n}-by-2 matrix containing the coordinates of the nodes of the graph.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## The optional parameter @var{line_style} defines the output style for the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## plot. Called with no output arguments the graph is plotted directly.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## Otherwise, return the coordinates of the plot in @var{x} and @var{y}.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5577 diff changeset	31 ## @seealso{treeplot, etreeplot, spy}
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	32 ## @end deftypefn
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	33
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	34 function [x, y] = gplot (A, xy, line_style)
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	35
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	36 if (nargin < 2 \|\| nargin > 3 \|\| nargout > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	37 print_usage ();
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	38 endif
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	39
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	40 if (nargin == 2)
6746 a8105a726e68 [project @ 2007-06-19 08:18:34 by dbateman] dbateman parents: 6273 diff changeset	41 line_style = "-";
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	42 endif
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	43
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	44 [i, j] = find (A);
10547 af55e4a499e4 Fix parsing error when NaN used inside of matrix declaration Rik <code@nomad.inbox5.com> parents: 10540 diff changeset	45 xcoord = [xy(i,1), xy(j,1), NaN(length(i),1) ]'(:);
af55e4a499e4 Fix parsing error when NaN used inside of matrix declaration Rik <code@nomad.inbox5.com> parents: 10540 diff changeset	46 ycoord = [xy(i,2), xy(j,2), NaN(length(i),1) ]'(:);
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	47
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	48 if (nargout == 0)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 plot (xcoord, ycoord, line_style);
5576 7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	50 else
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	51 x = xcoord;
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	52 y = ycoord;
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	53 endif
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	54
7e008607a86e [project @ 2005-12-13 19:05:54 by jwe] jwe parents: diff changeset	55 endfunction
13087 71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	56
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	57
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	58 %!demo
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	59 %! ## Binary Tree Representation
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60 %! A = [0 1 0 0 0 0 0
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 %! 1 0 1 1 0 0 0
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 %! 0 1 0 0 0 0 0
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 %! 0 1 0 0 1 0 0
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 %! 0 0 0 1 0 1 1
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 %! 0 0 0 0 1 0 0
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 %! 0 0 0 0 1 0 0];
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	67 %!
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	68 %! xy = [1 , 0
13087 71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 %! 1.5, 1
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %! 2 , 0
13087 71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71 %! 2.5, 2
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	72 %! 3.5, 1
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	73 %! 3 , 0
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74 %! 4 , 0];
13087 71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 %!
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76 %! clf;
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77 %! gplot (A, xy, "o-");
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78 %! set (get (gca, ("children")), "markersize", 12);
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	79 %! title ("gplot() of Binary Tree Adjacency matrix");
71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	80
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	81 ## 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: 14237 diff changeset	82 %!assert (1)
13087 71ce008332e2 codesprint: Add demo block to gplot.m Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	83

Mercurial > octave-antonio

annotate scripts/sparse/gplot.m @ 20164:df437a52bcaf stable