Mercurial > octave-nkf
view scripts/plot/cylinder.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 |
line wrap: on
line source
## Copyright (C) 2007-2012 Michael Goffioul and Kai Habel ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} cylinder ## @deftypefnx {Function File} {} cylinder (@var{r}) ## @deftypefnx {Function File} {} cylinder (@var{r}, @var{n}) ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} cylinder (@dots{}) ## @deftypefnx {Function File} {} cylinder (@var{ax}, @dots{}) ## Generate three matrices in @code{meshgrid} format, such that ## @code{surf (@var{x}, @var{y}, @var{z})} generates a unit cylinder. ## The matrices are of size @code{@var{n}+1}-by-@code{@var{n}+1}. ## @var{r} is a vector containing the radius along the z-axis. ## If @var{n} or @var{r} are omitted then default values of 20 or [1 1] ## are assumed. ## ## Called with no return arguments, @code{cylinder} calls directly ## @code{surf (@var{x}, @var{y}, @var{z})}. If an axes handle @var{ax} ## is passed as the first argument, the surface is plotted to this set ## of axes. ## ## Examples: ## ## @example ## @group ## [x, y, z] = cylinder (10:-1:0, 50); ## surf (x, y, z); ## title ("a cone"); ## @end group ## @end example ## @seealso{sphere} ## @end deftypefn function [xx, yy, zz] = cylinder (varargin) [ax, args, nargs] = __plt_get_axis_arg__ ((nargout > 0), "cylinder", varargin{:}); if (nargs == 0) n = 20; r = [1, 1]; elseif (nargs == 1) n = 20; r = args{1}; elseif (nargs == 2) r = args{1}; n = args{2}; else print_usage (); endif if (length (r) < 2) error ("cylinder: length(R) must be larger than 2"); endif phi = linspace (0, 2*pi, n+1); idx = 1:length(r); [phi, idx] = meshgrid(phi, idx); z = (idx - 1) / (length(r) - 1); r = r(idx); [x, y] = pol2cart (phi, r); if (nargout > 0) xx = x; yy = y; zz = z; else surf (ax, x, y, z); endif endfunction %!demo %! clf %! [x, y, z] = cylinder (10:-1:0,50); %! surf (x, y, z); %! title ("a cone")