RunMat
  • Pricing
RunMat
GitHub
GitHub
Sign inTry in browser
DesktopRuntimePhysicsCADAdministrationAgent

Get RunMat updates

New releases, guides and examples.

Product+
  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download
Math+
  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting
Physics+
  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA
Industries+
  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance
Learn+
  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students
Compare+
  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons
Company+
  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms

Product

  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download

Math

  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting

Physics

  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA

Industries

  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance

Learn

  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students

Compare

  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons

Company

  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms
GitHubXLinkedIn

© Dystr, Inc. · RunMat v0.7.1, Nov 17, 2026

RunMat® is a registered trademark of Dystr, Inc. MATLAB® is a registered trademark of The MathWorks, Inc. RunMat is not affiliated with, endorsed by, or sponsored by The MathWorks, Inc.

/
See all docs
Builtin Reference
    • addlistener
    • addParameter
    • addprop
    • assignin
    • builtin
    • cancel
    • class
    • clear
    • clearAllMemoizedCaches
    • clearCache
    • clearvars
    • dbclear
    • dbstack
    • dbstatus
    • dbtype
    • eval
    • evalc
    • evalin
    • feval
    • findprop
    • func2str
    • functions
    • get.p
    • getcallinfo
    • getmethod
    • inputname
    • inputParser
    • isa
    • ischar
    • isdeployed
    • iskeyword
    • ismethod
    • isobject
    • isstring
    • isUnderlyingType
    • isvalid
    • keyboard
    • loadobj
    • localfunctions
    • matlab.metadata.DynamicProperty.delete
    • memoize
    • metaclass
    • mfilename
    • mislocked
    • mlock
    • munlock
    • namelengthmax
    • narginchk
    • nargoutchk
    • new_object
    • notify
    • numArgumentsFromSubscript
    • onCleanup
    • parse
    • saveobj
    • set.p
    • stats
    • str2func
    • subsasgn
    • subsref
    • superclasses
    • underlyingType
    • verLessThan
    • version
    • which
    • who
    • whos

cancel — Deactivate cleanup or request cancellation of an execution handle.

cancel(target) deactivates an onCleanup callback without invoking it, or asks the selected execution service to cancel a future, task, job, or supported parallel future aggregate. status = cancel(target) returns host double scalar zero after the request succeeds. This status-returning lifecycle/typed-handle form is a RunMat contract, not a claim of identical MATLAB signatures.

Syntax

cancel(target)
status = cancel(target)

Inputs

target
Type
Any
Required
Yes
Default
—
Description
onCleanup handle, typed Future/Task/Job, parallel.FevalFuture scalar/array, or parallel.FevalOnAllFuture task aggregate.
NameTypeRequiredDefaultDescription
targetAnyYes—onCleanup handle, typed Future/Task/Job, parallel.FevalFuture scalar/array, or parallel.FevalOnAllFuture task aggregate.

Returns

status
Type
NumericScalar
Description
Host double scalar zero after the operation succeeds.
NameTypeDescription
statusNumericScalarHost double scalar zero after the operation succeeds.

Errors

RunMat:onCleanup:InvalidObject
When
A cleanup operation targets a value that is not an onCleanup object.
Message
onCleanup: invalid cleanup object
RunMat:onCleanup:GcFailure
When
The cleanup target cannot be allocated, rooted, registered, or mutated.
Message
onCleanup: internal object storage failed
RunMat:onCleanup:LifecycleHostUnavailable
When
No explicit session lifecycle host owns cleanup callback dispatch.
Message
onCleanup: lifecycle host is unavailable
IdentifierWhenMessage
RunMat:onCleanup:InvalidObjectA cleanup operation targets a value that is not an onCleanup object.onCleanup: invalid cleanup object
RunMat:onCleanup:GcFailureThe cleanup target cannot be allocated, rooted, registered, or mutated.onCleanup: internal object storage failed
RunMat:onCleanup:LifecycleHostUnavailableNo explicit session lifecycle host owns cleanup callback dispatch.onCleanup: lifecycle host is unavailable
RunMat:parallel:RuntimeContextUnavailableAn execution target is cancelled without the selected runtime context.cancel: no selected runtime context
RunMat:cancel:ExecutionServiceThe selected execution service rejects cancellation of a future, task, or job.cancel: execution service failed
RunMat:cancel:TooManyOutputsMore than one output is requested, before cancellation has any effect.cancel: at most one output is supported

Supported targets

An onCleanup handle is deactivated without executing its callback. Its aliases remain handles; later delete or final release does not replay the cancelled callback. An already invalid onCleanup handle is a successful no-op.

Typed Future, Task, and Job values are forwarded unchanged to the selected runtime execution service. Scope, generation, supported backend, and cancellation state are validated by that owner, not reconstructed from numbers or class-name strings.

parallel.FevalFuture objects and arrays created by parfeval carry actual task handles. parallel.FevalOnAllFuture carries the corresponding task aggregate. Every stored task representation is validated before any cancellation is requested, then tasks are visited in their existing order without a second task workspace. Scope and generation validation remain with the execution service for each request.

Cancellation requests can succeed after work has already completed. A zero status confirms that the selected service accepted the request; it does not promise that work never ran or that a remote job has synchronously stopped. A service failure stops traversal and retains its diagnostic; requests already accepted for earlier tasks are not rolled back.

Outputs, errors, and placement

Zero or one output is supported. Requesting more than one output fails before deactivation or execution-service calls. Automatic display is suppressed; an explicitly requested status is always scalar double zero.

Numeric values, including integer IDs and resident numeric arrays, are not handles. Unsupported target values reject without conversion or GPU gather. Execution targets require a selected runtime context; active cleanup targets also require their session lifecycle host. Service, scope, generation, and lifecycle failures propagate and never trigger GPU-gather retry.

The binding is impure, host-side, a fusion boundary, and requires the process execution stack. This cancellation call does not await completion or invoke a cleanup callback. Native and Wasm bindings use their existing execution/lifecycle services; availability of a particular task or job backend is determined by that service. Handles cannot be transferred as independent distributed worker data.

Examples

Disable a cleanup callback

cleanupObj = onCleanup(@() disp('cleanup')); status = cancel(cleanupObj); delete(cleanupObj);

Request cancellation of scheduled work

future = parfeval(@(x) x + 1, 1, 4); status = cancel(future);

Do not interpret integers as task IDs

cancel(uint64(1));

Using cancel with coding agents

Open a RunMat example with live inputs, then ask the agent to explain how cancel changes the result.

Run a small cancel example, explain the result, then change one input and compare the output.

FAQ

Does cancelling cleanup invoke its callback?⌄

No. Use delete(cleanupObj) to execute an active callback; cancel deactivates it without invocation.

Can I cancel using an integer task number?⌄

No. Pass the actual lifecycle or execution handle, preserving the owning scope and generation.

Does zero mean the task never ran?⌄

No. It means the cancellation request succeeded; completion and cancellation races belong to the execution service.

Related Introspection functions

addlistener · addParameter · addprop · assignin · builtin · class · clear · clearAllMemoizedCaches · clearCache · clearvars · dbclear · dbstack · dbstatus · dbtype · eval · evalc · evalin · feval · findprop · func2str · functions · get.p · getcallinfo · getmethod · inputname · inputParser · isa · ischar · isdeployed · iskeyword · ismethod · isobject · isstring · isUnderlyingType · isvalid · keyboard · loadobj · localfunctions · matlab.metadata.DynamicProperty.delete · memoize · metaclass · mfilename · mislocked · mlock · munlock · namelengthmax · narginchk · nargoutchk · new_object · notify · numArgumentsFromSubscript · onCleanup · parse · saveobj · set.p · stats · str2func · subsasgn · subsref · superclasses · underlyingType · verLessThan · version · which · who · whos

Source you can read

Every RunMat function's source is public. Read exactly how cancel is executed, line by line, in Rust.

  • View the source for cancel 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.

Getting started · Benchmarks · Pricing

Download RunMat

Download RunMat for full performance, or use RunMat in your browser for zero setup.

Download RunMatOpen Sandbox
On this page
  • Syntax
  • Inputs
  • Returns
  • Errors
  • Supported targets
  • Outputs, errors, and placement
  • Examples
  • Disable a cleanup callback
  • Request cancellation of scheduled work
  • Do not interpret integers as task IDs
  • Using cancel with coding agents
  • FAQ
  • Related Introspection functions
  • Source you can read
  • About RunMat