octave_packages/m/plot/ezplot.m

   1 ## Copyright (C) 2008-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} {} ezplot (@var{f})
  21 ## @deftypefnx {Function File} {} ezplot (@var{fx}, @var{fy})
  22 ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{dom})
  23 ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{n})
  24 ## @deftypefnx {Function File} {} ezplot (@var{h}, @dots{})
  25 ## @deftypefnx {Function File} {@var{h} =} ezplot (@dots{})
  26 ##
  27 ## Plot the curve defined by @var{f} in two dimensions.  The function
  28 ## @var{f} may be a string, inline function or function handle and can
  29 ## have either one or two variables.  If @var{f} has one variable, then
  30 ## the function is plotted over the domain @code{-2*pi < @var{x} < 2*pi}
  31 ## with 500 points.
  32 ##
  33 ## If @var{f} has two variables then @code{@var{f}(@var{x},@var{y}) = 0}
  34 ## is calculated over the meshed domain @code{-2*pi < @var{x} | @var{y}
  35 ## < 2*pi} with 60 by 60 in the mesh.  For example:
  36 ##
  37 ## @example
  38 ## ezplot (@@(@var{x}, @var{y}) @var{x}.^2 - @var{y}.^2 - 1)
  39 ## @end example
  40 ##
  41 ## If two functions are passed as strings, inline functions or function
  42 ## handles, then the parametric function
  43 ##
  44 ## @example
  45 ## @group
  46 ## @var{x} = @var{fx} (@var{t})
  47 ## @var{y} = @var{fy} (@var{t})
  48 ## @end group
  49 ## @end example
  50 ##
  51 ## @noindent
  52 ## is plotted over the domain @code{-2*pi < @var{t} < 2*pi} with 500
  53 ## points.
  54 ##
  55 ## If @var{dom} is a two element vector, it represents the minimum and maximum
  56 ## value of @var{x}, @var{y} and @var{t}.  If it is a four element
  57 ## vector, then the minimum and maximum values of @var{x} and @var{t}
  58 ## are determined by the first two elements and the minimum and maximum
  59 ## of @var{y} by the second pair of elements.
  60 ##
  61 ## @var{n} is a scalar defining the number of points to use in plotting
  62 ## the function.
  63 ##
  64 ## The optional return value @var{h} is a graphics handle to the created plot.
  65 ##
  66 ## @seealso{plot, ezplot3}
  67 ## @end deftypefn
  68
  69 function retval = ezplot (varargin)
  70
  71   [h, needusage] = __ezplot__ ("plot", varargin{:});
  72
  73   if (needusage)
  74     print_usage ();
  75   endif
  76
  77   if (nargout > 0)
  78     retval = h;
  79   endif
  80 endfunction
  81
  82
  83 %!demo
  84 %! clf
  85 %! ezplot (@cos, @sin)
  86
  87 %!demo
  88 %! clf
  89 %! ezplot ("1/x")
  90
  91 %!demo
  92 %! clf
  93 %! ezplot (inline ("x^2 - y^2 = 1"))
  94