Mercurial > hg > octave-lyh
annotate scripts/optimization/optimset.m @ 14363:f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
* wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m,
asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m,
csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m,
accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m,
celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m,
cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m,
flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m,
interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m,
isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m,
narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m,
randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m,
structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m,
griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m,
get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m,
imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m,
textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m,
duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m,
issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m,
qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m,
bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m,
fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m,
ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m,
news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m,
setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m,
warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m,
pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m,
__plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m,
colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m,
ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m,
ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m,
legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m,
orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m,
refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m,
stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m,
deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m,
polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m,
ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m,
autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m,
fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m,
sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m,
pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m,
sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m,
beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m,
nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m,
realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m,
vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m,
iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m,
median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m,
range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m,
statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m,
betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m,
cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m,
chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m,
empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m,
expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m,
gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m,
hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m,
laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m,
logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m,
lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m,
norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m,
poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m,
tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m,
unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m,
wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m,
strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m,
substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m,
asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m,
eomday.m, etime.m, is_leap_year.m, now.m:
Use Octave coding conventions in all m-file %!test blocks
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 13 Feb 2012 07:29:44 -0800 |
parents | 72c96de7a403 |
children | b76f0740940e |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13836
diff
changeset
|
1 ## Copyright (C) 2007-2012 John W. Eaton |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
2 ## Copyright (C) 2009 VZLU Prague |
6226 | 3 ## |
4 ## This file is part of Octave. | |
5 ## | |
6 ## Octave is free software; you can redistribute it and/or modify it | |
7 ## under the terms of the GNU General Public License as published by | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
6226 | 10 ## |
11 ## Octave is distributed in the hope that it will be useful, but | |
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 ## General Public License for more details. | |
15 ## | |
16 ## You should have received a copy of the GNU General Public License | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
6226 | 19 |
20 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10635
diff
changeset
|
21 ## @deftypefn {Function File} {} optimset () |
6226 | 22 ## @deftypefnx {Function File} {} optimset (@var{par}, @var{val}, @dots{}) |
23 ## @deftypefnx {Function File} {} optimset (@var{old}, @var{par}, @var{val}, @dots{}) | |
24 ## @deftypefnx {Function File} {} optimset (@var{old}, @var{new}) | |
25 ## Create options struct for optimization functions. | |
13797
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
26 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
27 ## Valid parameters are: |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
28 ## @itemize @bullet |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
29 ## @item AutoScaling |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
30 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
31 ## @item ComplexEqn |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
32 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
33 ## @item FinDiffType |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
34 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
35 ## @item FunValCheck |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
36 ## When enabled, display an error if the objective function returns a complex |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
37 ## value or NaN@. Must be set to "on" or "off" [default]. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
38 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
39 ## @item GradObj |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
40 ## When set to "on", the function to be minimized must return a second argument |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
41 ## which is the gradient, or first derivative, of the function at the point |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
42 ## @var{x}. If set to "off" [default], the gradient is computed via finite |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
43 ## differences. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
44 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
45 ## @item Jacobian |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
46 ## When set to "on", the function to be minimized must return a second argument |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
47 ## which is the Jacobian, or first derivative, of the function at the point |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
48 ## @var{x}. If set to "off" [default], the Jacobian is computed via finite |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
49 ## differences. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
50 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
51 ## @item MaxFunEvals |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
52 ## Maximum number of function evaluations before optimization stops. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
53 ## Must be a positive integer. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
54 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
55 ## @item MaxIter |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
56 ## Maximum number of algorithm iterations before optimization stops. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
57 ## Must be a positive integer. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
58 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
59 ## @item OutputFcn |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
60 ## A user-defined function executed once per algorithm iteration. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
61 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
62 ## @item TolFun |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
63 ## Termination criterion for the function output. If the difference in the |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
64 ## calculated objective function between one algorithm iteration and the next |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
65 ## is less than @code{TolFun} the optimization stops. Must be a positive |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
66 ## scalar. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
67 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
68 ## @item TolX |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
69 ## Termination criterion for the function input. If the difference in @var{x}, |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
70 ## the current search point, between one algorithm iteration and the next is |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
71 ## less than @code{TolX} the optimization stops. Must be a positive scalar. |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
72 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
73 ## @item TypicalX |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
74 ## |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
75 ## @item Updating |
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
76 ## @end itemize |
6226 | 77 ## @end deftypefn |
78 | |
79 function retval = optimset (varargin) | |
80 | |
81 nargs = nargin (); | |
82 | |
83 ## Add more as needed. | |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
84 opts = __all_opts__ (); |
6226 | 85 |
86 if (nargs == 0) | |
87 if (nargout == 0) | |
88 ## Display possibilities. | |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
89 puts ("\nAll possible optimization options:\n\n"); |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
90 printf (" %s\n", opts{:}); |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
91 puts ("\n"); |
6226 | 92 else |
13183
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
93 ## Return struct with all options initialized to [] |
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
94 retval = cell2struct (repmat ({[]}, size (opts)), opts, 2); |
6226 | 95 endif |
96 elseif (nargs == 1 && ischar (varargin{1})) | |
97 ## Return defaults for named function. | |
98 fcn = varargin{1}; | |
8596
8833c0b18eb2
enable default settings queries in optim funcs
Jaroslav Hajek <highegg@gmail.com>
parents:
8304
diff
changeset
|
99 try |
11407
ed827ffa5a43
optimset, optimget, __all_opts__: consistently use lower case for storing and searching options
John W. Eaton <jwe@octave.org>
parents:
11346
diff
changeset
|
100 retval = feval (fcn, "defaults"); |
8596
8833c0b18eb2
enable default settings queries in optim funcs
Jaroslav Hajek <highegg@gmail.com>
parents:
8304
diff
changeset
|
101 catch |
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
102 error ("optimset: no defaults for function `%s'", fcn); |
8598 | 103 end_try_catch |
6226 | 104 elseif (nargs == 2 && isstruct (varargin{1}) && isstruct (varargin{2})) |
105 ## Set slots in old from nonempties in new. Should we be checking | |
106 ## to ensure that the field names are expected? | |
107 old = varargin{1}; | |
108 new = varargin{2}; | |
6227 | 109 fnames = fieldnames (old); |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
110 ## skip validation if we're in the internal query |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
111 validation = ! isempty (opts); |
11407
ed827ffa5a43
optimset, optimget, __all_opts__: consistently use lower case for storing and searching options
John W. Eaton <jwe@octave.org>
parents:
11346
diff
changeset
|
112 lopts = tolower (opts); |
6226 | 113 for [val, key] = new |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
114 if (validation) |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
115 ## Case insensitive lookup in all options. |
11451
48cb431db87b
optimset: remove "i" option from call to lookup
John W. Eaton <jwe@octave.org>
parents:
11407
diff
changeset
|
116 i = lookup (lopts, tolower (key)); |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
117 ## Validate option. |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
118 if (i > 0 && strcmpi (opts{i}, key)) |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
119 ## Use correct case. |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
120 key = opts{i}; |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
121 else |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
122 warning ("unrecognized option: %s", key); |
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
123 endif |
6226 | 124 endif |
6227 | 125 old.(key) = val; |
6226 | 126 endfor |
127 retval = old; | |
128 elseif (rem (nargs, 2) && isstruct (varargin{1})) | |
129 ## Set values in old from name/value pairs. | |
11121
134d357e1c03
optimization/optimset.m: Use cell2struct instead of struct to handle cell arrays as options
Olaf Till <olaf.till@uni-jena.de>
parents:
10793
diff
changeset
|
130 pairs = reshape (varargin(2:end), 2, []); |
134d357e1c03
optimization/optimset.m: Use cell2struct instead of struct to handle cell arrays as options
Olaf Till <olaf.till@uni-jena.de>
parents:
10793
diff
changeset
|
131 retval = optimset (varargin{1}, cell2struct (pairs(2, :), pairs(1, :), 2)); |
6226 | 132 elseif (rem (nargs, 2) == 0) |
133 ## Create struct. Default values are replaced by those specified by | |
134 ## name/value pairs. | |
11121
134d357e1c03
optimization/optimset.m: Use cell2struct instead of struct to handle cell arrays as options
Olaf Till <olaf.till@uni-jena.de>
parents:
10793
diff
changeset
|
135 pairs = reshape (varargin, 2, []); |
134d357e1c03
optimization/optimset.m: Use cell2struct instead of struct to handle cell arrays as options
Olaf Till <olaf.till@uni-jena.de>
parents:
10793
diff
changeset
|
136 retval = optimset (struct (), cell2struct (pairs(2, :), pairs(1, :), 2)); |
6226 | 137 else |
138 print_usage (); | |
139 endif | |
140 | |
141 endfunction | |
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
142 |
13183
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
143 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
144 %!assert (optimget (optimset ("tolx", 1e-2), "tOLx"), 1e-2) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
145 %!assert (isfield (optimset ("tolFun", 1e-3), "TolFun")) |
13183
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
146 |
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
147 %!error (optimset ("%NOT_A_REAL_FUNCTION_NAME%")) |
cc1fd6a58151
optimset.m: When called with 1 output argument, return a struct with all possible options initialized to [].
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
148 |