annotate scripts/plot/cylinder.m @ 14868:5d3a684236b0

maint: Use Octave coding conventions for cuddling parentheses in scripts directory * lin2mu.m, loadaudio.m, wavread.m, accumarray.m, bicubic.m, celldisp.m, colon.m, cplxpair.m, dblquad.m, divergence.m, genvarname.m, gradient.m, int2str.m, interp1.m, interp1q.m, interp2.m, interpn.m, loadobj.m, nthargout.m, __isequal__.m, __splinen__.m, quadgk.m, quadl.m, quadv.m, rat.m, rot90.m, rotdim.m, saveobj.m, subsindex.m, triplequad.m, delaunay3.m, griddata.m, inpolygon.m, tsearchn.m, voronoi.m, get_first_help_sentence.m, which.m, gray2ind.m, pink.m, dlmwrite.m, strread.m, textread.m, textscan.m, housh.m, ishermitian.m, issymmetric.m, krylov.m, logm.m, null.m, rref.m, compare_versions.m, copyfile.m, dump_prefs.m, edit.m, fileparts.m, getappdata.m, isappdata.m, movefile.m, orderfields.m, parseparams.m, __xzip__.m, rmappdata.m, setappdata.m, swapbytes.m, unpack.m, ver.m, fminbnd.m, fminunc.m, fsolve.m, glpk.m, lsqnonneg.m, qp.m, sqp.m, configure_make.m, copy_files.m, describe.m, get_description.m, get_forge_pkg.m, install.m, installed_packages.m, is_architecture_dependent.m, load_package_dirs.m, print_package_description.m, rebuild.m, repackage.m, save_order.m, shell.m, allchild.m, ancestor.m, area.m, axes.m, axis.m, clabel.m, close.m, colorbar.m, comet.m, comet3.m, contour.m, cylinder.m, ezmesh.m, ezsurf.m, findobj.m, fplot.m, hist.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, mesh.m, meshz.m, pareto.m, pcolor.m, peaks.m, plot3.m, plotmatrix.m, plotyy.m, polar.m, print.m, __add_datasource__.m, __add_default_menu__.m, __axes_limits__.m, __bar__.m, __clabel__.m, __contour__.m, __errcomm__.m, __errplot__.m, __ezplot__.m, __file_filter__.m, __fltk_print__.m, __ghostscript__.m, __gnuplot_print__.m, __go_draw_axes__.m, __go_draw_figure__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m, __pie__.m, __plt__.m, __print_parse_opts__.m, __quiver__.m, __scatter__.m, __stem__.m, __tight_eps_bbox__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiputfile_fltk__.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, ribbon.m, scatter.m, semilogy.m, shading.m, slice.m, subplot.m, surface.m, surfl.m, surfnorm.m, text.m, uigetfile.m, uiputfile.m, whitebg.m, deconv.m, mkpp.m, pchip.m, polyaffine.m, polyder.m, polygcd.m, polyout.m, polyval.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, splinefit.m, addpref.m, getpref.m, setpref.m, ismember.m, setxor.m, arch_fit.m, arch_rnd.m, arch_test.m, autoreg_matrix.m, diffpara.m, fftconv.m, filter2.m, hanning.m, hurst.m, periodogram.m, triangle_sw.m, sinc.m, spectral_xdf.m, spencer.m, stft.m, synthesis.m, unwrap.m, yulewalker.m, bicgstab.m, gmres.m, pcg.m, pcr.m, __sprand_impl__.m, speye.m, spfun.m, sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, bessel.m, factor.m, legendre.m, perms.m, primes.m, magic.m, toeplitz.m, corr.m, cov.m, mean.m, median.m, mode.m, qqplot.m, quantile.m, ranks.m, zscore.m, logistic_regression_likelihood.m, bartlett_test.m, chisquare_test_homogeneity.m, chisquare_test_independence.m, kolmogorov_smirnov_test.m, run_test.m, u_test.m, wilcoxon_test.m, z_test.m, z_test_2.m, bin2dec.m, dec2base.m, mat2str.m, strcat.m, strchr.m, strjust.m, strtok.m, substr.m, untabify.m, assert.m, demo.m, example.m, fail.m, speed.m, test.m, now.m: Use Octave coding conventions for cuddling parentheses in scripts directory.
author Rik <octave@nomad.inbox5.com>
date Tue, 17 Jul 2012 07:08:39 -0700
parents ce2b59a6d0e5
children 3e1b24a2454a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 Michael Goffioul and Kai Habel
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
2 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
4 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
9 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
14 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
18
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} cylinder
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} cylinder (@var{r})
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} cylinder (@var{r}, @var{n})
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} cylinder (@dots{})
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {} cylinder (@var{ax}, @dots{})
12575
d0b799dafede Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents: 12129
diff changeset
25 ## Generate three matrices in @code{meshgrid} format, such that
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
26 ## @code{surf (@var{x}, @var{y}, @var{z})} generates a unit cylinder.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
27 ## The matrices are of size @code{@var{n}+1}-by-@code{@var{n}+1}.
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
28 ## @var{r} is a vector containing the radius along the z-axis.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
29 ## If @var{n} or @var{r} are omitted then default values of 20 or [1 1]
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
30 ## are assumed.
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
31 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
32 ## Called with no return arguments, @code{cylinder} calls directly
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7245
diff changeset
33 ## @code{surf (@var{x}, @var{y}, @var{z})}. If an axes handle @var{ax}
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
34 ## is passed as the first argument, the surface is plotted to this set
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
35 ## of axes.
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
36 ##
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
37 ## Examples:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
38 ##
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
39 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
40 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41 ## [x, y, z] = cylinder (10:-1:0, 50);
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
42 ## surf (x, y, z);
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43 ## title ("a cone");
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
44 ## @end group
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
45 ## @end example
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
46 ## @seealso{sphere}
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
47 ## @end deftypefn
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
48
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
49 function [xx, yy, zz] = cylinder (varargin)
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
50
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
51 [ax, args, nargs] = __plt_get_axis_arg__ ((nargout > 0), "cylinder",
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
52 varargin{:});
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
53
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
54 if (nargs == 0)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
55 n = 20;
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
56 r = [1, 1];
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
57 elseif (nargs == 1)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
58 n = 20;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
59 r = args{1};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
60 elseif (nargs == 2)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
61 r = args{1};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
62 n = args{2};
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
63 else
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
64 print_usage ();
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
65 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
66
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
67 if (length (r) < 2)
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
68 error ("cylinder: length (R) must be larger than 2");
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
69 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
70
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
71 phi = linspace (0, 2*pi, n+1);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
72 idx = 1:length (r);
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
73 [phi, idx] = meshgrid (phi, idx);
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
74 z = (idx - 1) / (length (r) - 1);
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
75 r = r(idx);
7182
71579d54d4b9 [project @ 2007-11-26 18:16:40 by jwe]
jwe
parents: 7181
diff changeset
76 [x, y] = pol2cart (phi, r);
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
77
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
78 if (nargout > 0)
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
79 xx = x;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
80 yy = y;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
81 zz = z;
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
82 else
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7187
diff changeset
83 surf (ax, x, y, z);
7181
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
84 endif
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
85
8d0e90d4caf6 [project @ 2007-11-26 18:14:52 by jwe]
jwe
parents:
diff changeset
86 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
87
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
88
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
89 %!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
90 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
91 %! colormap ('default');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
92 %! [x, y, z] = cylinder (10:-1:0,50);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7215
diff changeset
93 %! surf (x, y, z);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
94 %! title ('a cone');
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
95