Mercurial > hg > octave-lyh

diff scripts/plot/ezmesh.m @ 16993:78f57b14535c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Overhaul ez* family of plot functions. * scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezpolar.m, scripts/plot/ezsurfc.m: Redo docstring. Match function output names to docstring. * scripts/plot/ezplot.m: Add %!demo block with sinc function. Redo docstring. Match function output names to docstring. scripts/plot/ezplot3.m: Add %!demo block showing 'animate' option. Redo docstring. Match function output names to docstring. * scripts/plot/ezsurf.m: Add %!demo block showing 'circ' argument. Redo docstring. Match function output names to docstring. * scripts/plot/private/__ezplot__.m: Implement 'circ' option for ezsurf, ezmesh. Implement 'animate' option for ezplot3. Implement new algorithm for finding valid axis setting for mesh, surf, contour plots based on function gradient. Eliminate complex Z values along with singularities because these are not plottable by mesh, surf. Implement Matlab-compatible 2-pass approach to finding valid domain for plot. Use 500 points for point-style plot functions ezplot, ezplot3, ezpolar rather than previous 60 for a smoother plot. Use better regexprep() calls to format "pretty print" title string. Relax input checking and allow 3rd parametric function to be a function of 1 variable only. Clean up code and use Octave coding conventions.
author Rik <rik@octave.org>
date Wed, 17 Jul 2013 10:09:44 -0700
parents 5d3a684236b0
children eaab03308c0b
line wrap: on
line diff
--- a/scripts/plot/ezmesh.m
+++ b/scripts/plot/ezmesh.m
@@ -22,31 +22,36 @@
 ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{dom})
 ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{n})
 ## @deftypefnx {Function File} {} ezmesh (@dots{}, "circ")
-## @deftypefnx {Function File} {} ezmesh (@var{h}, @dots{})
+## @deftypefnx {Function File} {} ezmesh (@var{hax}, @dots{})
 ## @deftypefnx {Function File} {@var{h} =} ezmesh (@dots{})
 ##
-## Plot the mesh defined by a function.  @var{f} is a string, inline
-## function or function handle with two arguments defining the function.  By
-## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi} and
-## @code{-2*pi < @var{y} < 2*pi} with 60 points in each dimension.
+## Plot the mesh defined by a function.
 ##
-## If @var{dom} is a two element vector, it represents the minimum and maximum
-## value of both @var{x} and @var{y}.  If @var{dom} is a four element vector,
-## then the minimum and maximum value of @var{x} and @var{y} are specify
-## separately.
-##
-## @var{n} is a scalar defining the number of points to use in each dimension.
+## @var{f} is a string, inline function, or function handle with two arguments
+## defining the function.  By default the plot is over the meshed domain
+## @code{-2*pi <= @var{x} | @var{y} <= 2*pi} with 60 points in each dimension.
 ##
 ## If three functions are passed, then plot the parametrically defined
 ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}),
 ## @var{fz} (@var{s}, @var{t})]}.
 ##
+## If @var{dom} is a two element vector, it represents the minimum and maximum
+## values of both @var{x} and @var{y}.  If @var{dom} is a four element vector,
+## then the minimum and maximum values are @code{[xmin xmax ymin ymax]}.
+##
+## @var{n} is a scalar defining the number of points to use in each dimension.
+##
 ## If the argument "circ" is given, then the function is plotted over a disk
 ## centered on the middle of the domain @var{dom}.
 ##
+## If the first argument is an axis handle, @var{hax}, then plot into this
+## axis rather than the current axis handle returned by @code{gca}.
+##
 ## The optional return value @var{h} is a graphics handle to the created 
 ## surface object.
 ##
+## Example 1: 2-argument function
+##
 ## @example
 ## @group
 ## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2);
@@ -54,7 +59,7 @@
 ## @end group
 ## @end example
 ##
-## An example of a parametrically defined function is
+## Example 2: parametrically defined function
 ##
 ## @example
 ## @group
@@ -65,19 +70,19 @@
 ## @end group
 ## @end example
 ##
-## @seealso{ezplot, ezmeshc, ezsurf, ezsurfc}
+## @seealso{mesh, ezmeshc, ezplot, ezsurf, ezsurfc, hidden}
 ## @end deftypefn
 
-function retval = ezmesh (varargin)
+function h = ezmesh (varargin)
 
-  [h, needusage] = __ezplot__ ("mesh", varargin{:});
+  [htmp, needusage] = __ezplot__ ("mesh", varargin{:});
 
   if (needusage)
     print_usage ();
   endif
 
   if (nargout > 0)
-    retval = h;
+    h = htmp;
   endif
 
 endfunction