geometry.subtract — Remove one or more tool features from a base geometry feature.
feature = geometry.subtract(base, tool1, tool2, ...) returns a geometry.Feature for base with the volume of every tool removed.
Syntax
feature = geometry.subtract(base, tool1, tool2, ...)Inputs
base- Type
Any- Required
- Yes
- Default
- —
- Description
- geometry.Feature to cut.
tool- Type
Any- Required
- Variadic
- Default
- —
- Description
- One or more geometry.Feature tools.
Returns
feature- Type
Any- Description
- geometry.Feature for base with every tool removed.
Errors
RunMat:geometry:subtract:InvalidInput- When
- The wrong number of arguments is passed. No tool is given, an operand is not a geometry.Feature, or the operand graphs define one feature identity differently. A value violates the feature-graph contract.
- Message
geometry.subtract: invalid input
Behavior
One base and at least one tool are required. All tools are removed in one operation. The feature graphs of all operands are merged so that shared features are kept once; conflicting definitions of one feature identity are rejected.
A tool that misses the base leaves the base unchanged when realized. Use geometry.hole or geometry.pocket when a cut must overlap the part.
The call records construction intent only. It appends one operation to an immutable, content-addressed feature graph and returns a new geometry.Feature; it does not run a CAD kernel, tessellate, or touch the filesystem. The graph is realized as exact B-rep topology when a .fea geometry declaration that imports the generating function is materialized for meshing or analysis.
Every failure, including the wrong number of arguments, a value of the wrong kind, and a value that violates the feature-graph contract (a nonpositive or non-finite length, radius, depth, distance, or angle, or an all-zero direction), raises the builtin's own RunMat:geometry:<name>:InvalidInput identifier, and no value is returned. Feature identities are derived from a digest of each operation, so repeating the same construction yields the same feature identity.
Use in a study
Return the finished part from a pure .m function: geometry.finish(feature) turns the final feature into a geometry.Generated product, and geometry.withRegion publishes typed selections under names. A .fea geometry declaration written as generated by function.<name> calls that function, realizes the exact geometry, and exposes each named selection as output.region.<name> for meshing, material assignment, constraints, and loads.
geometry.facesIntroducedBy(body) on the subtraction selects the faces the tools created, such as bore walls.
Errors
RunMat:geometry:subtract:InvalidInput reports every failure of the call: the wrong number of arguments, a call with no tool, an operand that is not a geometry.Feature, or conflicting feature definitions, or a value that violates the feature-graph contract, such as a zero or negative dimension, a non-finite value, or an all-zero direction. A failed call returns nothing, and earlier values are unchanged because builder values are immutable.
Examples
Bore a bracket and name its regions
stock = geometry.box(80e-3, 50e-3, 8e-3);
bore = geometry.cylinder(5e-3, 8e-3, [0 0 1], [40e-3 25e-3 0]);
body = geometry.subtract(stock, bore);
part = geometry.finish(body);
part = geometry.withRegion(part, "body", geometry.solid(body));
part = geometry.withRegion(part, "bore", geometry.facesIntroducedBy(body));
class(part)A base without a tool is rejected
stock = geometry.box(80e-3, 50e-3, 8e-3);
body = geometry.subtract(stock);Using geometry.subtract with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how geometry.subtract changes the result.
Run a small geometry.subtract example, explain the result, then change one input and compare the output.
FAQ
Can I display or mesh a feature directly in a script?⌄
Not yet. geometry.Feature and geometry.Generated are construction values; mesh and meshing.generate accept a loaded geometry.Asset. Realization happens when a .fea geometry declaration imports the generating function.
How do I enter millimeter dimensions?⌄
Convert to meters before the call, for example geometry.box(80e-3, 50e-3, 8e-3). When the function is called from a .fea declaration, length inputs already arrive in meters.
Related Geometry functions
Construction
geometry.box · geometry.chamfer · geometry.cylinder · geometry.edges · geometry.edgesIntroducedBy · geometry.extrude · geometry.faces · geometry.facesIntroducedBy · geometry.fillet · geometry.finish · geometry.hole · geometry.instance · geometry.intersect · geometry.pocket · geometry.revolve · geometry.solid · geometry.sphere · geometry.transform · geometry.union · geometry.withRegion
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how geometry.subtract is executed, line by line, in Rust.
- View the source for geometry.subtract 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.