optimoptions — Create or update solver-specific optimization options.
optimoptions(solver, name, value, ...) builds solver-specific optimization metadata, and optimoptions(existing, ...) copies and updates an existing RunMat options struct.
Syntax
options = optimoptions(solver)
options = optimoptions(solver, name, value, ...)
options = optimoptions(oldopts, name, value, ...)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
solver | StringScalar | Yes | — | Solver name, such as coneprog, fminbnd, fminunc, fzero, fsolve, lsqcurvefit, or lsqnonlin. |
name | StringScalar | No | — | Option field name. |
value | Any | Variadic | — | Option value(s) and additional name/value pairs. |
oldopts | Any | Yes | — | Existing options struct to update. |
value | Any | Variadic | — | Option value(s), additional name/value pairs, or another options struct. |
Returns
| Name | Type | Description |
|---|---|---|
options | Any | Options struct for optimization solvers. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:optimoptions:InvalidArgument | Argument grammar does not match supported optimoptions forms. | optimoptions: invalid argument |
RunMat:optimoptions:InvalidSolver | The solver argument is not one of the supported optimization builtins. | optimoptions: invalid solver |
RunMat:optimoptions:InvalidOptionName | An option name is not a text scalar. | optimoptions: invalid option name |
RunMat:optimoptions:MissingOptionValue | A name-value option key is not followed by a value. | optimoptions: missing option value |
RunMat:optimoptions:UnknownOption | An option name is not supported by the selected solver. | optimoptions: unknown option |
RunMat:optimoptions:InvalidOptionValue | An option value fails type or domain validation. | optimoptions: invalid option value |
RunMat:optimoptions:Flow | Nested flow fails while gathering input values. | optimoptions: flow failure |
How optimoptions works
- RunMat implements a compatibility subset for its optimization solvers and currently returns a struct rather than MATLAB's solver-options object class.
- Recognized option names, defaults, aliases, and validation depend on the selected solver.
- Native integer option values are independently gated RunMat extensions because documented numeric options use floating classes.
- Integer tolerances must be exactly representable before normalization to double. Integer iteration and evaluation limits are parsed as exact structural counts, and accepted 0/1 flag values become logical fields.
- Automatically resident option values gather into host metadata. Explicit gpuArray option values are rejected in compatibility mode before gather.
Example
Create options for a nonlinear solver
opts = optimoptions("fsolve", "TolX", 1e-8, "Display", "off")Expected output:
opts is a RunMat options struct for fsolveUsing optimoptions with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how optimoptions changes the result.
Run a small optimoptions example, explain the result, then change one input and compare the output.
Related Math functions
Optim
coneprog · fminbnd · fminunc · fsolve · fzero · integral · linprog · lsqcurvefit · lsqnonlin · optimset · quad · secondordercone
Elementwise
abs · angle · bsxfun · complex · conj · double · erf · erfcinv · exp · expm1 · factorial · flintmax · gamma · gammaln · heaviside · hypot · idivide · imag · intmax · intmin · ldivide · log · log10 · log1p · log2 · minus · nextpow2 · plus · pow2 · power · rdivide · real · realmax · realmin · realsqrt · rescale · sign · single · sqrt · swapbytes · times · typecast · uint16 · uint32 · uint8
Trigonometry
acos · acosh · asin · asinh · atan · atan2 · 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
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
Ops
cross · ctranspose · dot · mldivide · mpower · mrdivide · mtimes · pagemtimes · pagetranspose · trace · transpose
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how optimoptions is executed, line by line, in Rust.
- View the source for optimoptions in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 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.