octave_packages/m/plot/ezpolar.m

   1 ## Copyright (C) 2007-2012 David Bateman
   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} {} ezpolar (@var{f})
  21 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{dom})
  22 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{n})
  23 ## @deftypefnx {Function File} {} ezpolar (@var{h}, @dots{})
  24 ## @deftypefnx {Function File} {@var{h} =} ezpolar (@dots{})
  25 ##
  26 ## Plot a function in polar coordinates.  The function @var{f} is either
  27 ## a string, inline function or function handle with one arguments defining
  28 ## the function.  By default the plot is over the domain @code{0 < @var{x} <
  29 ## 2*pi} with 60 points.
  30 ##
  31 ## If @var{dom} is a two element vector, it represents the minimum and maximum
  32 ## value of both @var{t}.  @var{n} is a scalar defining the number of points to
  33 ## use.
  34 ##
  35 ## The optional return value @var{h} is a graphics handle to the created plot.
  36 ##
  37 ## @example
  38 ## ezpolar (@@(t) 1 + sin (t));
  39 ## @end example
  40 ##
  41 ## @seealso{polar, ezplot, ezsurf, ezmesh}
  42 ## @end deftypefn
  43
  44 function retval = ezpolar (varargin)
  45
  46   [h, needusage] = __ezplot__ ("polar", varargin{:});
  47
  48   if (needusage)
  49     print_usage ();
  50   endif
  51
  52   if (nargout > 0)
  53     retval = h;
  54   endif
  55 endfunction
  56
  57
  58 %!demo
  59 %! clf
  60 %! ezpolar (@(t) 1 + sin (t));
  61