Mercurial > hg > octave-lyh

comparison scripts/plot/ezmesh.m @ 7337:e70789e0cd92

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-12-28 21:04:44 by jwe]
author jwe
date Fri, 28 Dec 2007 21:06:43 +0000
parents
children dbd0c77e575e
comparison
equal deleted inserted replaced
7336:745a8299c2b5 7337:e70789e0cd92
1 ## Copyright (C) 2007 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} {} ezmesh (@var{f})
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 ##
28 ## Plots the mesh defined by a function. @var{f} is a string, inline
29 ## function or function handle with two arguments defining the function. By
30 ## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi} and
31 ## @code{-2*pi < @var{y} < 2*pi} with 60 points in each dimension.
32 ##
33 ## If @var{dom} is a two element vector, it represents the minimum and maximum
34 ## value of both @var{x} and @var{y}. If @var{dom} is a four element vector,
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 ##
40 ## If three functions are passed, then plot the parametrically defined
41 ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}),
42 ## @var{fz} (@var{s}, @var{t})]}.
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 ##
47 ## The optional return value @var{h} provides a list of handles to the
48 ## the parts of the vector field (body, arrow and marker).
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 ##
68 ## @seealso{ezplot, ezsurf, ezsurfc, ezmeshc}
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
84 %!demo
85 %! f = @(x,y) sqrt(abs(x .* y)) ./ (1 + x.^2 + y.^2);
86 %! ezmesh (f, [-3, 3]);
87
88 %!demo
89 %! fx = @(s,t) cos (s) .* cos(t);
90 %! fy = @(s,t) sin (s) .* cos(t);
91 %! fz = @(s,t) sin (t);
92 %! ezmesh (fx, fy, fz, [-pi,pi,-pi/2,pi/2], 20);