Mercurial > hg > octave-lyh
annotate scripts/plot/ezcontourf.m @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 04 Feb 2012 22:12:50 -0800 |
| parents | 72c96de7a403 |
| children | ce2b59a6d0e5 |
| 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} {} ezcontourf (@var{f}) |
| 7337 | 21 ## @deftypefnx {Function File} {} ezcontourf (@dots{}, @var{dom}) |
| 22 ## @deftypefnx {Function File} {} ezcontourf (@dots{}, @var{n}) | |
| 23 ## @deftypefnx {Function File} {} ezcontourf (@var{h}, @dots{}) | |
| 24 ## @deftypefnx {Function File} {@var{h} =} ezcontourf (@dots{}) | |
| 25 ## | |
|
14038
b0cdd60db5e5
doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
14001
diff
changeset
|
26 ## Plot the filled contour lines of 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
|
27 ## function or function handle with two arguments defining the function. By |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
28 ## default the plot is over the domain @code{-2*pi < @var{x} < 2*pi} and |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
29 ## @code{-2*pi < @var{y} < 2*pi} with 60 points in each dimension. |
| 7337 | 30 ## |
| 31 ## 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
|
32 ## value of both @var{x} and @var{y}. If @var{dom} is a four element vector, |
| 7337 | 33 ## then the minimum and maximum value of @var{x} and @var{y} are specify |
| 34 ## separately. | |
| 35 ## | |
| 36 ## @var{n} is a scalar defining the number of points to use in each dimension. | |
| 37 ## | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
38 ## The optional return value @var{h} is a graphics handle to the created plot. |
| 7337 | 39 ## |
| 40 ## @example | |
| 41 ## @group | |
|
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
42 ## f = @@(x,y) sqrt (abs (x .* y)) ./ (1 + x.^2 + y.^2); |
| 7337 | 43 ## ezcontourf (f, [-3, 3]); |
| 44 ## @end group | |
| 45 ## @end example | |
| 46 ## | |
| 47 ## @seealso{ezplot, ezcontour, ezsurfc, ezmeshc} | |
| 48 ## @end deftypefn | |
| 49 | |
| 50 function retval = ezcontourf (varargin) | |
| 51 | |
| 52 [h, needusage] = __ezplot__ ("contourf", varargin{:}); | |
| 53 | |
| 54 if (needusage) | |
| 55 print_usage (); | |
| 56 endif | |
| 57 | |
| 58 if (nargout > 0) | |
| 59 retval = h; | |
| 60 endif | |
| 61 endfunction | |
| 62 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
63 |
| 7337 | 64 %!demo |
|
14092
22c50cbad2ce
Add clf() to all plot demos.
Ben Abbott <bpabbott@mac.com>
parents:
14038
diff
changeset
|
65 %! clf |
| 7337 | 66 %! f = @(x,y) sqrt(abs(x .* y)) ./ (1 + x.^2 + y.^2); |
| 67 %! ezcontourf (f, [-3, 3]); |