Mercurial > hg > octave-nkf
annotate scripts/plot/ezmeshc.m @ 19669:c2031ad6dbe7
Fix octave header includes in audiodevinfo
* audiodevinfo.cc: change includes to use local octave headers
author | Vytautas Jančauskas <unaudio@gmail.com> |
---|---|
date | Wed, 11 Sep 2013 21:32:14 +0300 |
parents | bc924baa2c4e |
children |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14092
diff
changeset
|
1 ## Copyright (C) 2007-2012 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} {} ezmeshc (@var{f}) |
7337 | 21 ## @deftypefnx {Function File} {} ezmeshc (@var{fx}, @var{fy}, @var{fz}) |
22 ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{dom}) | |
23 ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{n}) | |
14359
7277fe922e99
doc: Use Octave preference for double quote in docstrings in scripts/
Rik <octave@nomad.inbox5.com>
parents:
14335
diff
changeset
|
24 ## @deftypefnx {Function File} {} ezmeshc (@dots{}, "circ") |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
25 ## @deftypefnx {Function File} {} ezmeshc (@var{hax}, @dots{}) |
7337 | 26 ## @deftypefnx {Function File} {@var{h} =} ezmeshc (@dots{}) |
27 ## | |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
28 ## Plot the mesh and contour lines defined by a function. |
7337 | 29 ## |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
30 ## @var{f} is a string, inline function, or function handle with two arguments |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
31 ## defining the function. By default the plot is over the meshed domain |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
32 ## @code{-2*pi <= @var{x} | @var{y} <= 2*pi} with 60 points in each dimension. |
7337 | 33 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
34 ## 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
|
35 ## 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
|
36 ## @var{fz} (@var{s}, @var{t})]}. |
7337 | 37 ## |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
38 ## If @var{dom} is a two element vector, it represents the minimum and maximum |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
39 ## values of both @var{x} and @var{y}. If @var{dom} is a four element vector, |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
40 ## then the minimum and maximum values are @code{[xmin xmax ymin ymax]}. |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
41 ## |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
42 ## @var{n} is a scalar defining the number of points to use in each dimension. |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
43 ## |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
44 ## If the argument @qcode{"circ"} is given, then the function is plotted over |
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
45 ## a disk centered on the middle of the domain @var{dom}. |
7337 | 46 ## |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16993
diff
changeset
|
47 ## If the first argument @var{hax} is an axes handle, then plot into this axis, |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16993
diff
changeset
|
48 ## rather than the current axes returned by @code{gca}. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
16993
diff
changeset
|
49 ## |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
50 ## The optional return value @var{h} is a 2-element vector with a graphics |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
51 ## handle for the created mesh plot and a second handle for the created contour |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
52 ## plot. |
7337 | 53 ## |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
54 ## Example: 2-argument function |
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
55 ## |
7337 | 56 ## @example |
57 ## @group | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 ## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2); |
7337 | 59 ## ezmeshc (f, [-3, 3]); |
60 ## @end group | |
61 ## @end example | |
62 ## | |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
63 ## @seealso{meshc, ezmesh, ezplot, ezsurf, ezsurfc, hidden} |
7337 | 64 ## @end deftypefn |
65 | |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
66 function h = ezmeshc (varargin) |
7337 | 67 |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
68 [htmp, needusage] = __ezplot__ ("meshc", varargin{:}); |
7337 | 69 |
70 if (needusage) | |
71 print_usage (); | |
72 endif | |
73 | |
74 if (nargout > 0) | |
16993
78f57b14535c
Overhaul ez* family of plot functions.
Rik <rik@octave.org>
parents:
14359
diff
changeset
|
75 h = htmp; |
7337 | 76 endif |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
77 |
7337 | 78 endfunction |
79 | |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
80 |
7337 | 81 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
82 %! clf; |
14247
c4fa5e0b6193
test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
83 %! colormap ('default'); |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
84 %! f = @(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2); |
7337 | 85 %! ezmeshc (f, [-3, 3]); |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
86 |