cylinder — Create or plot cylinder surface coordinates.
cylinder constructs X, Y, and Z grids for a unit-height cylinder with a configurable real radius profile and circumferential resolution. A call with no requested outputs plots through the existing surface renderer.
Syntax
X = cylinder
X = cylinder(r)
X = cylinder(r,n)
[X,Y] = cylinder
[X,Y] = cylinder(r)
[X,Y] = cylinder(r,n)All supported cylinder forms
X = cylinder
X = cylinder(r)
X = cylinder(r,n)
[X,Y] = cylinder
[X,Y] = cylinder(r)
[X,Y] = cylinder(r,n)
[X,Y,Z] = cylinder
[X,Y,Z] = cylinder(r)
[X,Y,Z] = cylinder(r,n)
cylinder
cylinder(r)
cylinder(r,n)
cylinder(r,n,Name,Value,...)
cylinder(Name,Value,...)
cylinder(ax,...)Inputs
r- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Real radius profile; a scalar repeats at the base and top.
n- Type
IntegerScalar- Required
- Yes
- Default
- —
- Description
- Positive number of equal circumference divisions.
r- Type
NumericArray- Required
- Yes
- Default
- —
- Description
- Real radius profile.
n- Type
IntegerScalar- Required
- Yes
- Default
- —
- Description
- Positive circumference division count.
Name,Value- Type
Any- Required
- Variadic
- Default
- —
- Description
- Supported surface property name/value pairs.
Name,Value- Type
Any- Required
- Variadic
- Default
- —
- Description
- Supported surface property name/value pairs for statement-form plotting.
ax- Type
Any- Required
- Yes
- Default
- —
- Description
- Existing target axes handle.
arguments- Type
Any- Required
- Variadic
- Default
- —
- Description
- Radius, resolution, and supported surface properties.
Returns
X- Type
NumericArray- Description
- Cylinder x coordinates.
Y- Type
NumericArray- Description
- Cylinder y coordinates.
Z- Type
NumericArray- Description
- Equally spaced heights from zero to one.
Returned values from cylinder depend on how many outputs the caller requests.
Errors
RunMat:cylinder:OutputCount- When
- More than three outputs are requested.
- Message
cylinder returns at most three coordinate arrays
RunMat:cylinder:InvalidArgument- When
- Radius, resolution, axes, or plot options are invalid.
- Message
cylinder input is invalid
RunMat:cylinder:OutOfMemory- When
- The coordinate geometry overflows or the exact host allocation cannot be admitted.
- Message
cylinder grid is too large
Coordinates and shapes
[X,Y,Z] = cylinder returns three 2-by-21 host Double matrices for a radius-one, unit-height cylinder. The final column closes the circumferential seam.
A vector profile r contributes one row per radius at equally spaced heights; scalar r is repeated at the base and top. With resolution n, the grids are m-by-(n+1), with m=2 for scalar r.
One-, two-, and three-output calls return the leading coordinate grids without plotting. An empty profile retains a 0-by-(n+1) coordinate shape but cannot be plotted.
Plot forms and placement
Statement-form cylinder, cylinder(r), and cylinder(r,n) publish a surface in the current axes. cylinder(ax,...) targets an existing axes; supported surface name-value pairs are accepted only on the plotting forms.
The radius is a real host scalar or vector and n is a finite positive whole scalar. Typed integer n is a gated RunMat extension decoded exactly for the structural extent. Coordinate values remain Double.
No cylinder provider kernel or automatic upload is registered. Explicit GPU radius or resolution inputs reject before a readback, while resident arrays in other plot calls retain their existing owners.
Examples
Construct tapered cylinder coordinates
[X,Y,Z] = cylinder([1 0.5 1],12);
size(X)
size(Y)
size(Z)Expected output:
ans =
3 13Plot the default unit cylinder
cylinder;
axis equal;Using cylinder with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how cylinder changes the result.
Run a small cylinder example, explain the result, then change one input and compare the output.
FAQ
What is the default output size?⌄
Each of X, Y, and Z is 2-by-21; a vector of m radii and count n gives m-by-(n+1) grids.
Does a call without outputs return coordinates?⌄
No. Statement form plots; assign outputs to obtain coordinate arrays.
Related Plotting functions
2D Charts
area · bar · errorbar · heatmap · hist · histogram · loglog · pie · plot · scatter · semilogx · semilogy · stairs · stem
Other
addpoints · ancestor · animatedline · autumn · axes · barh · bone · caxis · cla · clf · clim · colorcube · colororder · cool · copper · copyobj · daspect · datacursormode · dataTipTextRow · drawnow · fcontour · figure · fill · fill3 · findobj · fsurf · gobjects · gray · groot · hgload · hgsave · hidden · histogram2 · hold · hot · inferno · isgraphics · ishandle · jet · line · lines · linkaxes · magma · openfig · opengl · pan · parula · patch · pink · plasma · plotmatrix · plotyy · polarhistogram · polarplot · polarscatter · print · quiver3 · ribbon · saveas · savefig · sphere · spring · stackedplot · subtitle · summer · suptitle · text · textscatter · textscatter3 · triplot · turbo · viridis · waitbar · winter · wordcloud · xlabel · xlim · xline · xscale · xtickangle · xtickformat · xticklabels · xticks · ylabel · ylim · yline · yscale · ytickangle · ytickformat · yticklabels · yticks · zlim · zoom
Source you can read
Every RunMat function's source is public. Read exactly how cylinder is executed, line by line, in Rust.
- View the source for cylinder in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.