optimplotfval — Plot the objective function value against iteration.
Plot the objective function value against iteration.
Syntax
stop = optimplotfval(x,optimValues,state)Inputs
x- Type
Any- Required
- Yes
- Default
- —
- Description
- Current solver point. optimplotx reads finite real floating coordinates in column-major order; scalar-history helpers do not read x.
optimValues- Type
Any- Required
- Yes
- Default
- —
- Description
- Scalar struct with iteration, and funccount or fval for the corresponding history chart.
state- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- init resets this chart, iter updates it, done leaves the final chart without duplicating its last iteration.
Returns
stop- Type
Any- Description
- Logical false after a successful real chart update; execution cancellation remains a typed error.
Errors
RunMat:optimplotfval:InvalidArgument- When
- Callback arguments, iteration or scalar fval, state or output count are invalid, or a needed resident operand has explicit or unproven device intent.
- Message
optimplotfval: invalid callback argument
Callback contract
These are real predefined optimization plot callbacks with signature stop=helper(x,optimValues,state). optimplotx shows the current coordinates as bars; optimplotfunccount and optimplotfval show scalar histories against iteration. A successful call returns logical false. Custom PlotFcns may return true to stop a solver; these predefined visualizers do not manufacture a numerical stopping condition.
state is init, iter or done. init resets only this helper's chart on the current axes, iter updates its payload, and done retains the final chart. Repeated calls for the same last iteration replace that scalar point rather than duplicating it. The helper kinds have separate receiver-backed slots per axes. Solver PlotFcns layouts assign one axes per callback; standalone calls use the current axes.
optimValues must be a scalar struct with a nonnegative, platform-representable scalar floating iteration. optimplotfunccount additionally reads nonnegative integer funccount; optimplotfval reads scalar floating fval, or [] before an objective value is available. NaN/Inf fval values are retained as plotting data rather than clamped or converted into solver success. Additional fields are not inspected or downloaded. Only optimplotx reads x: it plots finite real single/double coordinates in column-major variable order. An empty x means no point is available yet. The history helpers do not convert or copy x.
Constrained progress
optimplotconstrviolation, optimplotstepsize and optimplotfirstorderopt read their corresponding scalar optimValues fields. They do not read x or unrelated fields.
optimplotfvalconstr reads fval and constrviolation. Its default feasibility tolerance is 1e-6. An explicit finite nonnegative constraintTolerance field selects a different nonlinear tolerance and permits signed raw constraint maxima. The chart retains separately colored feasible/infeasible histories and the best finite feasible value.
When fval is [], the constrained chart uses constrviolation as its measured value. An optional nonnegative integer feasibleCount then supplies the feasible-solutions title. Empty metrics initialize axes without adding a zero sample; later missing metrics retain preceding chart data. Empty initialization retires only this helper's payloads, preserving unrelated charts on the same axes. All histories remain ordinary receiver-backed scene payloads.
Graphics and execution
Charts are ordinary line/bar scene payloads with exact figure, axes and child receivers. Histories are not retained in a solver store or global function-name map. Axes clearing drops their slots and payloads; closing a figure retires its receivers. A solver's retained layout never silently recreates a retired target.
Needed floating operands may be transparently gathered only from authenticated automatic residency through the original execution context. Explicit/unproven device intent refuses before any needed transfer; call gather explicitly for host data. Unused fields and captures have no readback side effect. Native integer/logical/complex plot data is not implicitly accepted as floating callback data.
Finite host-memory execution refuses before transfers or scene work because progress history, labels and graphics scenes have no complete allocation certificate. CPU scans cooperate with the original invocation; typed cancellation and graphics/provider failures propagate without retry or fake stop values. plot-core and UI capability are required.
RunMat uses its normal plot renderer and cancellation controls. It does not provide MATLAB-specific optimization Pause/Stop widgets or claim identical plot-window layout. Original execution cancellation remains cancellation, distinct from a custom plot callback's logical true stop result.
Example
Update objective-value history
v.iteration=0; v.fval=4; stop=optimplotfval([],v,'init'); v.iteration=1; v.fval=1; optimplotfval([],v,'iter'); optimplotfval([],v,'done');Using optimplotfval with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how optimplotfval changes the result.
Run a small optimplotfval 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 · 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 · 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
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
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
Ops
cross · ctranspose · dot · mldivide · mpower · mrdivide · mtimes · pagemtimes · pagetranspose · trace · transpose
Interpolation
griddedInterpolant · griddedInterpolant.subsref · interp1 · interp1q · interp2 · pchip · ppval · spline
Integer Division
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.