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
    • acceptancesa
    • annealingboltz
    • annealingfast
    • coneprog
    • crossoverarithmetic
    • crossoverheuristic
    • crossoverintermediate
    • crossoverlaplace
    • crossoverscattered
    • crossoversinglepoint
    • crossovertwopoint
    • eqnproblem
    • EquationProblem.solve
    • EquationProblem.subsasgn
    • EquationProblem.subsref
    • evaluate
    • fgoalattain
    • fitscalingprop
    • fitscalingrank
    • fitscalingshiftlinear
    • fitscalingtop
    • fminbnd
    • fmincon
    • fminimax
    • fminsearch
    • fminunc
    • fseminf
    • fsolve
    • fzero
    • ga
    • gacreationlinearfeasible
    • gacreationnonlinearfeasible
    • gacreationsobol
    • gacreationuniform
    • gacreationuniformint
    • gaplotbestf
    • gaplotbestindiv
    • gaplotdistance
    • gaplotexpectation
    • gaplotgenealogy
    • gaplotmaxconstr
    • gaplotrange
    • gaplotscorediversity
    • gaplotscores
    • gaplotselection
    • gaplotstopping
    • integerConstraint
    • integral
    • intlinprog
    • linprog
    • lsqcurvefit
    • lsqlin
    • LsqlinWarmStart.subsasgn
    • LsqlinWarmStart.subsref
    • lsqnonlin
    • lsqnonneg
    • mutationadaptfeasible
    • mutationgaussian
    • mutationpositivebasis
    • mutationpower
    • mutationuniform
    • optimexpr
    • optimget
    • OptimizationConstraint.evaluate
    • OptimizationConstraint.subsasgn
    • OptimizationConstraint.subsref
    • OptimizationExitflag.double
    • OptimizationExitflag.eq
    • OptimizationExitflag.ne
    • OptimizationExitflag.string
    • OptimizationExpression.acos
    • OptimizationExpression.acosh
    • OptimizationExpression.acot
    • OptimizationExpression.acoth
    • OptimizationExpression.acsc
    • OptimizationExpression.acsch
    • OptimizationExpression.asec
    • OptimizationExpression.asech
    • OptimizationExpression.asin
    • OptimizationExpression.asinh
    • OptimizationExpression.atan
    • OptimizationExpression.atanh
    • OptimizationExpression.cat
    • OptimizationExpression.cos
    • OptimizationExpression.cosh
    • OptimizationExpression.cot
    • OptimizationExpression.coth
    • OptimizationExpression.csc
    • OptimizationExpression.csch
    • OptimizationExpression.ctranspose
    • OptimizationExpression.cumprod
    • OptimizationExpression.cumsum
    • OptimizationExpression.diag
    • OptimizationExpression.diff
    • OptimizationExpression.dot
    • OptimizationExpression.eq
    • OptimizationExpression.evaluate
    • OptimizationExpression.exp
    • OptimizationExpression.ge
    • OptimizationExpression.horzcat
    • OptimizationExpression.ldivide
    • OptimizationExpression.le
    • OptimizationExpression.log
    • OptimizationExpression.mean
    • OptimizationExpression.minus
    • OptimizationExpression.mldivide
    • OptimizationExpression.mpower
    • OptimizationExpression.mrdivide
    • OptimizationExpression.mtimes
    • OptimizationExpression.norm
    • OptimizationExpression.plus
    • OptimizationExpression.power
    • OptimizationExpression.prod
    • OptimizationExpression.rdivide
    • OptimizationExpression.reshape
    • OptimizationExpression.sec
    • OptimizationExpression.sech
    • OptimizationExpression.sin
    • OptimizationExpression.sinh
    • OptimizationExpression.sqrt
    • OptimizationExpression.subsasgn
    • OptimizationExpression.subsref
    • OptimizationExpression.sum
    • OptimizationExpression.tan
    • OptimizationExpression.tanh
    • OptimizationExpression.times
    • OptimizationExpression.trace
    • OptimizationExpression.transpose
    • OptimizationExpression.uminus
    • OptimizationExpression.uplus
    • OptimizationExpression.vertcat
    • OptimizationExpression.zeros
    • OptimizationExpression.zerosLike
    • OptimizationProblem.solve
    • OptimizationProblem.subsasgn
    • OptimizationProblem.subsref
    • OptimizationVariable.subsasgn
    • OptimizationVariable.subsref
    • optimoptions
    • optimplotconstrviolation
    • optimplotfirstorderopt
    • optimplotfunccount
    • optimplotfval
    • optimplotfvalconstr
    • optimplotmilp
    • optimplotstepsize
    • optimplotx
    • optimproblem
    • optimset
    • optimvar
    • optimwarmstart
    • particleswarm
    • patternsearch
    • psplotbestf
    • psplotbestx
    • psplotfuncount
    • psplotmaxconstr
    • psplotmeshsize
    • pswcreationuniform
    • pswplotbestf
    • quad
    • quadprog
    • QuadprogWarmStart.subsasgn
    • QuadprogWarmStart.subsref
    • saplotbestf
    • saplotbestx
    • saplotf
    • saplotstopping
    • saplottemperature
    • saplotx
    • savemilpsolutions
    • secondordercone
    • selectionremainder
    • selectionroulette
    • selectionstochunif
    • selectiontournament
    • selectionuniform
    • simulannealbnd
    • solve
    • surrogateopt
    • surrogateoptplot
    • temperatureboltz
    • temperatureexp
    • temperaturefast

optimget — Read an optimization option or return a default when it is unset.

optimget(options,parameter) returns a stored option value. optimget(options,parameter,default) substitutes the supplied default for an absent or numeric-empty setting; without a supplied default, an unset option returns [].

Syntax

value = optimget(options,parameter)
value = optimget(options,parameter,default)

Inputs

options
Type
Any
Required
Yes
Default
—
Description
Scalar optimization options struct or numeric [].
parameter
Type
StringScalar
Required
Yes
Default
—
Description
Case-insensitive option name or unambiguous leading abbreviation.
default
Type
Any
Required
No
Default
[]
Description
Value returned when the parameter is absent or numeric [].
NameTypeRequiredDefaultDescription
optionsAnyYes—Scalar optimization options struct or numeric [].
parameterStringScalarYes—Case-insensitive option name or unambiguous leading abbreviation.
defaultAnyNo[]Value returned when the parameter is absent or numeric [].

Returns

value
Type
Any
Description
Unchanged stored value, supplied default or [].
NameTypeDescription
valueAnyUnchanged stored value, supplied default or [].

Errors

RunMat:optimget:InvalidArgument
When
Invalid argument/output count, options container or unknown/ambiguous parameter name.
Message
optimget: invalid argument
IdentifierWhenMessage
RunMat:optimget:InvalidArgumentInvalid argument/output count, options container or unknown/ambiguous parameter name.optimget: invalid argument

Names and defaults

Parameter names ignore case and accept enough leading characters to identify one supported parameter uniquely. Exact names and modern aliases resolve before abbreviations. Shared canonical names such as OutputFcn and TolX count once even when both legacy and modern option identities recognize them. Ambiguous abbreviations, unknown parameter names, non-text names and non-scalar option containers raise an error.

The known parameter namespace is the same typed namespace consumed by optimset: legacy fminsearch controls and supported modern controls. Examples include Display, FunValCheck, MaxFunEvals, MaxIter, OutputFcn, PlotFcns, TolFun, TolX, Algorithm, SpecifyObjectiveGradient and ConstraintTolerance/TolCon where available. Supported aliases identify their canonical option field; unique abbreviations apply to canonical parameter names, not arbitrary extension keys.

For an unprofiled options struct, abbreviations use the legacy and shared option namespace; solver-specific global-optimization controls do not make ordinary legacy names ambiguous. A single recognized scalar Solver field additionally selects that solver's published option names, such as patternsearch MaxIterations and ga MaxGenerations. Exact known aliases remain available. A solver profile is never inferred from the other stored fields or values.

Use a scalar options struct, or numeric [] for no stored settings. A missing field or numeric [] setting returns the supplied default unchanged, or [] without a default. Zero, false and empty text are stored values, not numeric-empty default markers. This is not an arbitrary struct-field accessor; custom extension fields retained by optimset do not create new recognized parameter names. Duplicate fields that identify the same canonical parameter reject rather than selecting an arbitrary value.

Value ownership and execution

The chosen setting or default keeps its original value class, shape, resident-array carrier and callable/capture identity. optimget does not evaluate defaults, invoke callbacks, gather resident data, round native integers or validate a stored value against a particular solver. Solver admission still decides whether that option/value is supported.

No device numerical kernel or elementwise fusion is used; this is a synchronous metadata query with canonical result-root ownership. Finite host-memory execution is currently unsupported and refused at ingress before text normalization or result-root metadata allocation. No finite-memory certificate is implied by returning an existing setting.

Examples

Read a setting with a unique abbreviation

options=optimset('Display','iter','TolX',1e-7);
mode=optimget(options,'dIsP');
tol=optimget(options,'TolX')

Supply a default for an unset parameter

options=optimset();
mode=optimget(options,'Display','final');
limit=optimget(options,'MaxIterations',300)

Using optimget with coding agents

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

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

Related Math functions

Optim

acceptancesa · annealingboltz · annealingfast · coneprog · crossoverarithmetic · crossoverheuristic · crossoverintermediate · crossoverlaplace · crossoverscattered · crossoversinglepoint · crossovertwopoint · eqnproblem · EquationProblem.solve · EquationProblem.subsasgn · EquationProblem.subsref · evaluate · fgoalattain · fitscalingprop · fitscalingrank · fitscalingshiftlinear · fitscalingtop · fminbnd · fmincon · fminimax · fminsearch · fminunc · fseminf · fsolve · fzero · ga · gacreationlinearfeasible · gacreationnonlinearfeasible · gacreationsobol · gacreationuniform · gacreationuniformint · gaplotbestf · gaplotbestindiv · gaplotdistance · gaplotexpectation · gaplotgenealogy · gaplotmaxconstr · gaplotrange · gaplotscorediversity · gaplotscores · gaplotselection · gaplotstopping · integerConstraint · integral · intlinprog · linprog · lsqcurvefit · lsqlin · LsqlinWarmStart.subsasgn · LsqlinWarmStart.subsref · lsqnonlin · lsqnonneg · mutationadaptfeasible · mutationgaussian · mutationpositivebasis · mutationpower · mutationuniform · optimexpr · OptimizationConstraint.evaluate · OptimizationConstraint.subsasgn · OptimizationConstraint.subsref · OptimizationExitflag.double · OptimizationExitflag.eq · OptimizationExitflag.ne · OptimizationExitflag.string · OptimizationExpression.acos · OptimizationExpression.acosh · OptimizationExpression.acot · OptimizationExpression.acoth · OptimizationExpression.acsc · OptimizationExpression.acsch · OptimizationExpression.asec · OptimizationExpression.asech · OptimizationExpression.asin · OptimizationExpression.asinh · OptimizationExpression.atan · OptimizationExpression.atanh · OptimizationExpression.cat · OptimizationExpression.cos · OptimizationExpression.cosh · OptimizationExpression.cot · OptimizationExpression.coth · OptimizationExpression.csc · OptimizationExpression.csch · OptimizationExpression.ctranspose · OptimizationExpression.cumprod · OptimizationExpression.cumsum · OptimizationExpression.diag · OptimizationExpression.diff · OptimizationExpression.dot · OptimizationExpression.eq · OptimizationExpression.evaluate · OptimizationExpression.exp · OptimizationExpression.ge · OptimizationExpression.horzcat · OptimizationExpression.ldivide · OptimizationExpression.le · OptimizationExpression.log · OptimizationExpression.mean · OptimizationExpression.minus · OptimizationExpression.mldivide · OptimizationExpression.mpower · OptimizationExpression.mrdivide · OptimizationExpression.mtimes · OptimizationExpression.norm · OptimizationExpression.plus · OptimizationExpression.power · OptimizationExpression.prod · OptimizationExpression.rdivide · OptimizationExpression.reshape · OptimizationExpression.sec · OptimizationExpression.sech · OptimizationExpression.sin · OptimizationExpression.sinh · OptimizationExpression.sqrt · OptimizationExpression.subsasgn · OptimizationExpression.subsref · OptimizationExpression.sum · OptimizationExpression.tan · OptimizationExpression.tanh · OptimizationExpression.times · OptimizationExpression.trace · OptimizationExpression.transpose · OptimizationExpression.uminus · OptimizationExpression.uplus · OptimizationExpression.vertcat · OptimizationExpression.zeros · OptimizationExpression.zerosLike · OptimizationProblem.solve · OptimizationProblem.subsasgn · OptimizationProblem.subsref · OptimizationVariable.subsasgn · OptimizationVariable.subsref · optimoptions · optimplotconstrviolation · optimplotfirstorderopt · optimplotfunccount · optimplotfval · optimplotfvalconstr · optimplotmilp · optimplotstepsize · optimplotx · optimproblem · optimset · optimvar · optimwarmstart · particleswarm · patternsearch · psplotbestf · psplotbestx · psplotfuncount · psplotmaxconstr · psplotmeshsize · pswcreationuniform · pswplotbestf · quad · quadprog · QuadprogWarmStart.subsasgn · QuadprogWarmStart.subsref · saplotbestf · saplotbestx · saplotf · saplotstopping · saplottemperature · saplotx · savemilpsolutions · secondordercone · selectionremainder · selectionroulette · selectionstochunif · selectiontournament · selectionuniform · simulannealbnd · solve · surrogateopt · surrogateoptplot · temperatureboltz · temperatureexp · temperaturefast

Elementwise

abs · angle · besselj · bsxfun · complex · conj · double · eps · erf · erfcinv · exp · expm1 · flintmax · gamma · gammaln · heaviside · hypot · imag · int16 · int32 · int64 · int8 · intmax · intmin · ldivide · log · log10 · log1p · log2 · minus · nextpow2 · plus · pow2 · power · rdivide · real · realmax · realmin · realsqrt · rescale · sign · single · sqrt · times · typecast · uint16 · uint32 · uint64 · uint8

Trigonometry

acos · acosd · acosh · acotd · acscd · asecd · asin · asind · asinh · atan · atan2 · atan2d · atand · atanh · cos · cosd · cosh · cospi · deg2rad · pol2cart · rad2deg · sin · sind · sinh · sinpi · tan · tand · tanh

Reduction

all · any · bounds · cummax · cummin · cumprod · cumsum · cumtrapz · diff · gradient · max · maxk · mean · median · min · mink · movmax · movmean · movmedian · movmin · movprod · movstd · movsum · movvar · nnz · prod · rms · std · sum · trapz · var

Structure

bandwidth · isdiag · ishermitian · issymmetric · istril · istriu · symrcm

Bitwise

bitand · bitcmp · bitget · bitor · bitset · bitshift · bitxor · swapbytes

Signal

blackman · butter · buttord · cheb2ord · conv · conv2 · deconv · downsample · envelope · filter · filtfilt · fir1 · freqz · gauspuls · hamming · hann · hilbert · periodogram · pulstran · pwelch · rectpuls · resample · sawtooth · sinc · spectrogram · square · tripuls · unwrap · upsample · zplane

Rounding

ceil · fix · floor · mod · rem · round

Factor

chol · decomposition · decomposition.ctranspose · decomposition.mldivide · decomposition.mrdivide · decomposition.mtimes · decomposition.rdivide · decomposition.subsref · decomposition.times · decomposition.uminus · decomposition.uplus · eig · eigs · gmres · ichol · ilu · lu · ordeig · ordqz · ordschur · pcg · qr · qz · rsf2csf · schur · svd

Solve

cond · det · inv · linsolve · norm · null · pinv · rank · rcond · rref · vecnorm

Ops

cross · ctranspose · dot · mldivide · mpower · mrdivide · mtimes · pagemtimes · pagetranspose · trace · transpose

Symbolic

digits · int · limit · piecewise · sym · syms · vpa

Discrete

factor · factorial · gcd · isprime · lcm · primes

Fft

fft · fft2 · fftn · fftshift · ifft · ifft2 · ifftn · ifftshift

Interpolation

griddedInterpolant · griddedInterpolant.subsref · interp1 · interp1q · interp2 · pchip · ppval · spline

Integer Division

idivide

Ode

ode15s · ode23 · ode45 · odeset

Poly

poly · polyder · polyfit · polyint · polyval · roots

Source you can read

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

  • View the source for optimget 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
  • Names and defaults
  • Value ownership and execution
  • Examples
  • Read a setting with a unique abbreviation
  • Supply a default for an unset parameter
  • Using optimget with coding agents
  • Related Math functions
  • Optim
  • Elementwise
  • Trigonometry
  • Reduction
  • Structure
  • Bitwise
  • Signal
  • Rounding
  • Factor
  • Solve
  • Ops
  • Symbolic
  • Discrete
  • Fft
  • Interpolation
  • Integer Division
  • Ode
  • Poly
  • Source you can read
  • About RunMat