home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts.fat / plot / stairs.m < prev    next >
Text File  |  1999-12-24  |  3KB  |  110 lines

  1. ## Copyright (C) 1996, 1997 John W. Eaton
  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 2, or (at your option)
  8. ## 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, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} stairs (@var{x}, @var{y})
  22. ## Given two vectors of x-y data, bar produces a `stairstep' plot.
  23. ## 
  24. ## If only one argument is given, it is taken as a vector of y-values
  25. ## and the x coordinates are taken to be the indices of the elements.
  26. ## 
  27. ## If two output arguments are specified, the data are generated but
  28. ## not plotted.  For example,
  29. ## 
  30. ## @example
  31. ## stairs (x, y);
  32. ## @end example
  33. ## 
  34. ## @noindent
  35. ## and
  36. ## 
  37. ## @example
  38. ## [xs, ys] = stairs (x, y);
  39. ## plot (xs, ys);
  40. ## @end example
  41. ## 
  42. ## @noindent
  43. ## are equivalent.
  44. ## @end deftypefn
  45.  
  46. ## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour,
  47. ##           bar, gplot, gsplot, replot, xlabel, ylabel, title
  48.  
  49. ## Author: jwe
  50.  
  51. function [xs, ys] = stairs (x, y)
  52.  
  53.  
  54.   if (nargin == 1)
  55.     if (is_vec (x))
  56.       len = 2 * length (x);
  57.       tmp_xs = tmp_ys = zeros (len, 1);
  58.       k = 0;
  59.       for i = 1:2:len
  60.         tmp_xs(i) = k++;
  61.         tmp_ys(i) = x(k);
  62.         tmp_ys(i+1) = x(k);
  63.         tmp_xs(i+1) = k;
  64.       endfor
  65.     else
  66.       error ("stairs: argument must be a vector");
  67.     endif
  68.   elseif (nargin == 2)
  69.     if (is_vec (x) && is_vec (y))
  70.       xlen = length (x);
  71.       ylen = length (y);
  72.       if (xlen == ylen)
  73.         len = 2 * xlen;
  74.         tmp_xs = tmp_ys = zeros (len, 1);
  75.     k = 1;
  76.         len_m2 = len - 2;
  77.     for i = 1:2:len_m2
  78.       tmp_xs(i) = x(k);
  79.       tmp_ys(i) = y(k);
  80.       tmp_ys(i+1) = y(k);
  81.           k++;
  82.       tmp_xs(i+1) = x(k);
  83.           if (x(k) < x(k-1))
  84.             error ("stairs: x vector values must be in ascending order");
  85.           endif
  86.     endfor
  87.         tmp_xs(len-1) = x(xlen);
  88.         delta = x(xlen) - x(xlen-1);
  89.         tmp_xs(len) = x(xlen) + delta;
  90.         tmp_ys(len-1) = y(ylen);
  91.         tmp_ys(len) = y(ylen);
  92.       else
  93.         error ("stairs: arguments must be the same length");
  94.       endif
  95.     else
  96.       error ("stairs: arguments must be vectors");
  97.     endif
  98.   else
  99.     usage ("[xs, ys] = stairs (x, y)");
  100.   endif
  101.  
  102.   if (nargout == 0)
  103.     plot (tmp_xs, tmp_ys);
  104.   else
  105.     xs = tmp_xs;
  106.     ys = tmp_ys;
  107.   endif
  108.  
  109. endfunction
  110.