Mercurial > octave-antonio
view 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 |
line wrap: on
line source
## Copyright (C) 2005-2015 Ivana Varekova ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} gplot (@var{A}, @var{xy}) ## @deftypefnx {Function File} {} gplot (@var{A}, @var{xy}, @var{line_style}) ## @deftypefnx {Function File} {[@var{x}, @var{y}] =} gplot (@var{A}, @var{xy}) ## Plot a graph defined by @var{A} and @var{xy} in the graph theory sense. ## ## @var{A} is the adjacency matrix of the array to be plotted and @var{xy} is ## an @var{n}-by-2 matrix containing the coordinates of the nodes of the graph. ## ## The optional parameter @var{line_style} defines the output style for the ## plot. Called with no output arguments the graph is plotted directly. ## Otherwise, return the coordinates of the plot in @var{x} and @var{y}. ## @seealso{treeplot, etreeplot, spy} ## @end deftypefn function [x, y] = gplot (A, xy, line_style) if (nargin < 2 || nargin > 3 || nargout > 2) print_usage (); endif if (nargin == 2) line_style = "-"; endif [i, j] = find (A); xcoord = [xy(i,1), xy(j,1), NaN(length(i),1) ]'(:); ycoord = [xy(i,2), xy(j,2), NaN(length(i),1) ]'(:); if (nargout == 0) plot (xcoord, ycoord, line_style); else x = xcoord; y = ycoord; endif endfunction %!demo %! ## Binary Tree Representation %! A = [0 1 0 0 0 0 0 %! 1 0 1 1 0 0 0 %! 0 1 0 0 0 0 0 %! 0 1 0 0 1 0 0 %! 0 0 0 1 0 1 1 %! 0 0 0 0 1 0 0 %! 0 0 0 0 1 0 0]; %! %! xy = [1 , 0 %! 1.5, 1 %! 2 , 0 %! 2.5, 2 %! 3.5, 1 %! 3 , 0 %! 4 , 0]; %! %! clf; %! gplot (A, xy, "o-"); %! set (get (gca, ("children")), "markersize", 12); %! title ("gplot() of Binary Tree Adjacency matrix"); ## Mark graphical function as tested by demo block %!assert (1)