octave_packages/m/sparse/gplot.m

   1 ## Copyright (C) 2005-2012 Ivana Varekova
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} gplot (@var{A}, @var{xy})
  21 ## @deftypefnx {Function File} {} gplot (@var{A}, @var{xy}, @var{line_style})
  22 ## @deftypefnx {Function File} {[@var{x}, @var{y}] =} gplot (@var{A}, @var{xy})
  23 ## Plot a graph defined by @var{A} and @var{xy} in the graph theory
  24 ## sense.  @var{A} is the adjacency matrix of the array to be plotted
  25 ## and @var{xy} is an @var{n}-by-2 matrix containing the coordinates of
  26 ## the nodes of the graph.
  27 ##
  28 ## The optional parameter @var{line_style} defines the output style for
  29 ## the plot.  Called with no output arguments the graph is plotted
  30 ## directly.  Otherwise, return the coordinates of the plot in @var{x}
  31 ## and @var{y}.
  32 ## @seealso{treeplot, etreeplot, spy}
  33 ## @end deftypefn
  34
  35 function [x, y] = gplot (A, xy, line_style)
  36
  37   if (nargin < 2 || nargin > 3 || nargout > 2)
  38     print_usage ();
  39   endif
  40
  41   if (nargin == 2)
  42     line_style = "-";
  43   endif
  44
  45   [i, j] = find (A);
  46   xcoord = [xy(i,1), xy(j,1), NaN(length(i),1) ]'(:);
  47   ycoord = [xy(i,2), xy(j,2), NaN(length(i),1) ]'(:);
  48
  49   if (nargout == 0)
  50     plot (xcoord, ycoord, line_style);
  51   else
  52     x = xcoord;
  53     y = ycoord;
  54   endif
  55
  56 endfunction
  57
  58
  59 %!demo
  60 %! ## Binary Tree Representation
  61 %! A = [0 1 0 0 0 0 0
  62 %!      1 0 1 1 0 0 0
  63 %!      0 1 0 0 0 0 0
  64 %!      0 1 0 0 1 0 0
  65 %!      0 0 0 1 0 1 1
  66 %!      0 0 0 0 1 0 0
  67 %!      0 0 0 0 1 0 0];
  68 %!
  69 %! xy = [1, 0
  70 %!       1.5, 1
  71 %!       2, 0
  72 %!       2.5, 2
  73 %!       3.5, 1
  74 %!       3, 0
  75 %!       4, 0];
  76 %!
  77 %! clf;
  78 %! gplot (A, xy, "o-");
  79 %! set (get (gca, ("children")), "markersize", 12);
  80 %! title ("gplot() of Binary Tree Adjacency matrix");
  81
  82 %% Mark graphical function as tested by demo block
  83 %!assert (1);
  84