Mercurial > hg > octave-lyh
annotate scripts/plot/ezmesh.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 06 Dec 2011 13:09:17 -0800 |
| parents | c792872f8942 |
| children | b0cdd60db5e5 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 2007-2011 David Bateman |
| 7337 | 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 -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
20 ## @deftypefn {Function File} {} ezmesh (@var{f}) |
| 7337 | 21 ## @deftypefnx {Function File} {} ezmesh (@var{fx}, @var{fy}, @var{fz}) |
| 22 ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{dom}) | |
| 23 ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{n}) | |
| 24 ## @deftypefnx {Function File} {} ezmesh (@dots{}, 'circ') | |
| 25 ## @deftypefnx {Function File} {} ezmesh (@var{h}, @dots{}) | |
| 26 ## @deftypefnx {Function File} {@var{h} =} ezmesh (@dots{}) | |
| 27 ## | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7337
diff
changeset
|
28 ## Plots the mesh defined by a function. @var{f} is a string, inline |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
29 ## function or function handle with two arguments defining the function. By |
| 7337 | 30 ## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi} and |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
31 ## @code{-2*pi < @var{y} < 2*pi} with 60 points in each dimension. |
| 7337 | 32 ## |
| 33 ## If @var{dom} is a two element vector, it represents the minimum and maximum | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
7337
diff
changeset
|
34 ## value of both @var{x} and @var{y}. If @var{dom} is a four element vector, |
| 7337 | 35 ## then the minimum and maximum value of @var{x} and @var{y} are specify |
| 36 ## separately. | |
| 37 ## | |
| 38 ## @var{n} is a scalar defining the number of points to use in each dimension. | |
| 39 ## | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
40 ## If three functions are passed, then plot the parametrically defined |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
41 ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}), |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
42 ## @var{fz} (@var{s}, @var{t})]}. |
| 7337 | 43 ## |
| 44 ## If the argument 'circ' is given, then the function is plotted over a disk | |
| 45 ## centered on the middle of the domain @var{dom}. | |
| 46 ## | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
47 ## The optional return value @var{h} is a graphics handle to the created |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
48 ## surface object. |
| 7337 | 49 ## |
| 50 ## @example | |
| 51 ## @group | |
| 52 ## f = @@(x,y) sqrt(abs(x .* y)) ./ (1 + x.^2 + y.^2); | |
| 53 ## ezmesh (f, [-3, 3]); | |
| 54 ## @end group | |
| 55 ## @end example | |
| 56 ## | |
| 57 ## An example of a parametrically defined function is | |
| 58 ## | |
| 59 ## @example | |
| 60 ## @group | |
| 61 ## fx = @@(s,t) cos (s) .* cos(t); | |
| 62 ## fy = @@(s,t) sin (s) .* cos(t); | |
| 63 ## fz = @@(s,t) sin(t); | |
| 64 ## ezmesh (fx, fy, fz, [-pi, pi, -pi/2, pi/2], 20); | |
| 65 ## @end group | |
| 66 ## @end example | |
| 67 ## | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
68 ## @seealso{ezplot, ezmeshc, ezsurf, ezsurfc} |
| 7337 | 69 ## @end deftypefn |
| 70 | |
| 71 function retval = ezmesh (varargin) | |
| 72 | |
| 73 [h, needusage] = __ezplot__ ("mesh", varargin{:}); | |
| 74 | |
| 75 if (needusage) | |
| 76 print_usage (); | |
| 77 endif | |
| 78 | |
| 79 if (nargout > 0) | |
| 80 retval = h; | |
| 81 endif | |
| 82 endfunction | |
| 83 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
84 |
| 7337 | 85 %!demo |
| 86 %! f = @(x,y) sqrt(abs(x .* y)) ./ (1 + x.^2 + y.^2); | |
| 87 %! ezmesh (f, [-3, 3]); | |
| 88 | |
| 89 %!demo | |
| 90 %! fx = @(s,t) cos (s) .* cos(t); | |
| 91 %! fy = @(s,t) sin (s) .* cos(t); | |
| 92 %! fz = @(s,t) sin (t); | |
| 93 %! ezmesh (fx, fy, fz, [-pi,pi,-pi/2,pi/2], 20); | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
94 |