Mercurial > hg > octave-nkf
annotate scripts/optimization/optimset.m @ 19790:446c46af4b42 stable
strip trailing whitespace from most source files
* Makefile.am, NEWS, build-aux/common.mk, configure.ac,
doc/Makefile.am, doc/doxyhtml/Makefile.am,
doc/interpreter/Makefile.am, doc/interpreter/arith.txi,
doc/interpreter/audio.txi, doc/interpreter/basics.txi,
doc/interpreter/bugs.txi, doc/interpreter/container.txi,
doc/interpreter/cp-idx.txi, doc/interpreter/data.txi,
doc/interpreter/debug.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README,
doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi,
doc/interpreter/errors.txi, doc/interpreter/eval.txi,
doc/interpreter/expr.txi, doc/interpreter/external.txi,
doc/interpreter/fn-idx.txi, doc/interpreter/func.txi,
doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m,
doc/interpreter/gpl.txi, doc/interpreter/grammar.txi,
doc/interpreter/gui.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/interpimages.m, doc/interpreter/intro.txi,
doc/interpreter/io.txi, doc/interpreter/java.txi,
doc/interpreter/linalg.txi, doc/interpreter/macros.texi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi,
doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1,
doc/interpreter/octave.texi, doc/interpreter/oop.txi,
doc/interpreter/op-idx.txi, doc/interpreter/optim.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/poly.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/set.txi,
doc/interpreter/signal.txi, doc/interpreter/sparse.txi,
doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m,
doc/interpreter/stats.txi, doc/interpreter/stmt.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/testfun.txi, doc/interpreter/tips.txi,
doc/interpreter/var.txi, doc/interpreter/vectorize.txi,
doc/liboctave/Makefile.am, doc/liboctave/array.texi,
doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi,
doc/liboctave/dae.texi, doc/liboctave/diffeq.texi,
doc/liboctave/error.texi, doc/liboctave/factor.texi,
doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi,
doc/liboctave/install.texi, doc/liboctave/intro.texi,
doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi,
doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi,
doc/liboctave/ode.texi, doc/liboctave/optim.texi,
doc/liboctave/preface.texi, doc/liboctave/quad.texi,
doc/liboctave/range.texi, doc/refcard/Makefile.am,
doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2,
etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog,
etc/OLD-ChangeLogs/doc-ChangeLog,
etc/OLD-ChangeLogs/scripts-ChangeLog,
etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog,
etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW,
etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am,
examples/@polynomial/end.m, examples/@polynomial/subsasgn.m,
examples/Makefile.am, examples/standalonebuiltin.cc,
libgui/Makefile.am, libgui/qterminal/libqterminal/README,
libgui/qterminal/libqterminal/unix/BlockArray.cpp,
libgui/qterminal/libqterminal/unix/BlockArray.h,
libgui/qterminal/libqterminal/unix/Character.h,
libgui/qterminal/libqterminal/unix/CharacterColor.h,
libgui/qterminal/libqterminal/unix/Emulation.cpp,
libgui/qterminal/libqterminal/unix/Emulation.h,
libgui/qterminal/libqterminal/unix/Filter.cpp,
libgui/qterminal/libqterminal/unix/Filter.h,
libgui/qterminal/libqterminal/unix/History.cpp,
libgui/qterminal/libqterminal/unix/History.h,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.h,
libgui/qterminal/libqterminal/unix/LineFont.h,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h,
libgui/qterminal/libqterminal/unix/Screen.cpp,
libgui/qterminal/libqterminal/unix/Screen.h,
libgui/qterminal/libqterminal/unix/ScreenWindow.cpp,
libgui/qterminal/libqterminal/unix/ScreenWindow.h,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h,
libgui/qterminal/libqterminal/unix/Vt102Emulation.h,
libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp,
libgui/qterminal/qterminal/main.cpp,
libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc,
libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc,
libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc,
libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy,
libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc,
libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc,
libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl,
libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add,
libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs,
libinterp/mkops, libinterp/octave-value/ov-java.cc,
libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/octave.gperf, liboctave/Makefile.am,
liboctave/array/Array.cc, liboctave/array/module.mk,
liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f,
liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f,
liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f,
liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f,
liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f,
liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f,
liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f,
liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f,
liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f,
liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f,
liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f,
liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f,
liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f,
liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f,
liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f,
liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f,
liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk,
liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f,
liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f,
liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f,
liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f,
liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f,
liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc,
liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f,
liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f,
liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f,
liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f,
liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc,
liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for,
liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f,
liboctave/cruft/slatec-fn/datanh.f,
liboctave/cruft/slatec-fn/xgmainc.f,
liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk,
liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops,
liboctave/operators/sparse-mk-ops.awk,
liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops,
liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m,
scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m,
scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m,
scripts/deprecated/java_new.m,
scripts/deprecated/java_unsigned_conversion.m,
scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m,
scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m,
scripts/general/display.m, scripts/general/fieldnames.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/isa.m,
scripts/general/methods.m, scripts/general/sortrows.m,
scripts/geometry/convhull.m, scripts/geometry/delaunay.m,
scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m,
scripts/geometry/griddata.m, scripts/geometry/griddatan.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/gui/guihandles.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m,
scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m,
scripts/image/bone.m, scripts/image/cmpermute.m,
scripts/image/cmunique.m, scripts/image/colorcube.m,
scripts/image/colormap.m, scripts/image/contrast.m,
scripts/image/gray2ind.m, scripts/image/image.m,
scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m,
scripts/image/rgb2ntsc.m, scripts/image/spinmap.m,
scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m,
scripts/io/textscan.m, scripts/java/java_get.m,
scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m,
scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m,
scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m,
scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m,
scripts/mk-pkg-add, scripts/mkdoc.pl,
scripts/optimization/fminsearch.m, scripts/optimization/optimset.m,
scripts/optimization/sqp.m, scripts/pkg/pkg.m,
scripts/pkg/private/create_pkgadddel.m,
scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m,
scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m,
scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m,
scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m,
scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m,
scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m,
scripts/plot/draw/area.m, scripts/plot/draw/bar.m,
scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m,
scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m,
scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m,
scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m,
scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m,
scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m,
scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m,
scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m,
scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m,
scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m,
scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m,
scripts/plot/draw/private/__contour__.m,
scripts/plot/draw/private/__errplot__.m,
scripts/plot/draw/private/__ezplot__.m,
scripts/plot/draw/private/__patch__.m,
scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m,
scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m,
scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m,
scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m,
scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m,
scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m,
scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m,
scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m,
scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m,
scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m,
scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m,
scripts/plot/util/__gnuplot_drawnow__.m,
scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m,
scripts/plot/util/clf.m, scripts/plot/util/copyobj.m,
scripts/plot/util/figure.m, scripts/plot/util/gcbo.m,
scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m,
scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m,
scripts/plot/util/print.m,
scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/private/__fltk_print__.m,
scripts/plot/util/private/__gnuplot_print__.m,
scripts/plot/util/private/__print_parse_opts__.m,
scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m,
scripts/polynomial/conv.m, scripts/polynomial/poly.m,
scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m,
scripts/polynomial/polyval.m,
scripts/polynomial/private/__splinefit__.m,
scripts/polynomial/spline.m, scripts/prefs/prefdir.m,
scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m,
scripts/prefs/rmpref.m, scripts/signal/freqz.m,
scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m,
scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m,
scripts/specfun/expint.m, scripts/specfun/factor.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m,
scripts/special-matrix/toeplitz.m, scripts/startup/inputrc,
scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m,
scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m,
scripts/statistics/distributions/betarnd.m,
scripts/statistics/distributions/binoinv.m,
scripts/statistics/distributions/binopdf.m,
scripts/statistics/distributions/binornd.m,
scripts/statistics/distributions/cauchy_rnd.m,
scripts/statistics/distributions/chi2rnd.m,
scripts/statistics/distributions/discrete_pdf.m,
scripts/statistics/distributions/discrete_rnd.m,
scripts/statistics/distributions/empirical_rnd.m,
scripts/statistics/distributions/exprnd.m,
scripts/statistics/distributions/frnd.m,
scripts/statistics/distributions/gamrnd.m,
scripts/statistics/distributions/geornd.m,
scripts/statistics/distributions/hygernd.m,
scripts/statistics/distributions/kolmogorov_smirnov_cdf.m,
scripts/statistics/distributions/laplace_cdf.m,
scripts/statistics/distributions/laplace_pdf.m,
scripts/statistics/distributions/logistic_cdf.m,
scripts/statistics/distributions/logistic_pdf.m,
scripts/statistics/distributions/lognrnd.m,
scripts/statistics/distributions/nbincdf.m,
scripts/statistics/distributions/nbininv.m,
scripts/statistics/distributions/nbinpdf.m,
scripts/statistics/distributions/nbinrnd.m,
scripts/statistics/distributions/normrnd.m,
scripts/statistics/distributions/poissinv.m,
scripts/statistics/distributions/poissrnd.m,
scripts/statistics/distributions/tinv.m,
scripts/statistics/distributions/trnd.m,
scripts/statistics/distributions/unidcdf.m,
scripts/statistics/distributions/unidpdf.m,
scripts/statistics/distributions/unidrnd.m,
scripts/statistics/distributions/unifrnd.m,
scripts/statistics/distributions/wblrnd.m,
scripts/statistics/models/module.mk,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/strings/base2dec.m, scripts/strings/deblank.m,
scripts/strings/dec2base.m, scripts/strings/dec2bin.m,
scripts/strings/dec2hex.m, scripts/strings/mat2str.m,
scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m,
scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjoin.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m,
scripts/testfun/test.m, scripts/time/asctime.m,
scripts/time/datenum.m, scripts/time/datevec.m,
scripts/time/weekday.m, src/Makefile.am, test/Makefile.am,
test/build-bc-overload-tests.sh, test/build-sparse-tests.sh,
test/jit.tst, test/line-continue.tst: Strip trailing whitespace.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 20 Jan 2015 08:26:57 -0500 |
| parents | d63878346099 |
| children | 0e1f5a750d00 |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17338
diff
changeset
|
1 ## Copyright (C) 2007-2013 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: |
|
14366
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
28 ## |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
29 ## @table @asis |
|
13797
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
30 ## @item AutoScaling |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
31 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
32 ## @item ComplexEqn |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
33 ## |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
34 ## @item Display |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
35 ## Request verbose display of results from optimizations. Values are: |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
36 ## |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
37 ## @table @asis |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
38 ## @item @qcode{"off"} [default] |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
39 ## No display. |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
40 ## |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
41 ## @item @qcode{"iter"} |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
42 ## Display intermediate results for every loop iteration. |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
43 ## |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
44 ## @item @qcode{"final"} |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
45 ## Display the result of the final loop iteration. |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
46 ## |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
47 ## @item @qcode{"notify"} |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
48 ## Display the result of the final loop iteration if the function has |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
49 ## failed to converge. |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
50 ## @end table |
|
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
51 ## |
|
13797
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
52 ## @item FinDiffType |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
53 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
54 ## @item FunValCheck |
|
14387
966ec84e7858
doc: Update optimset docstring with details of FunValCheck option.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
55 ## When enabled, display an error if the objective function returns an invalid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
56 ## value (a complex number, NaN, or Inf). Must be set to @qcode{"on"} or |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
57 ## @qcode{"off"} [default]. Note: the functions @code{fzero} and |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
58 ## @code{fminbnd} correctly handle Inf values and only complex values or NaN |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
59 ## will cause an error in this case. |
|
13797
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
60 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
61 ## @item GradObj |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
62 ## When set to @qcode{"on"}, the function to be minimized must return a |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
63 ## second argument which is the gradient, or first derivative, of the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
64 ## function at the point @var{x}. If set to @qcode{"off"} [default], the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
65 ## gradient is computed via finite differences. |
|
13797
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
66 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
67 ## @item Jacobian |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
68 ## When set to @qcode{"on"}, the function to be minimized must return a |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
69 ## second argument which is the Jacobian, or first derivative, of the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
70 ## function at the point @var{x}. If set to @qcode{"off"} [default], the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
16674
diff
changeset
|
71 ## Jacobian is computed via finite differences. |
|
13797
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 MaxFunEvals |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
74 ## 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
|
75 ## Must be a positive integer. |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
76 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
77 ## @item MaxIter |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
78 ## 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
|
79 ## Must be a positive integer. |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
80 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
81 ## @item OutputFcn |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
82 ## 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
|
83 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
84 ## @item TolFun |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
85 ## 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
|
86 ## 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
|
87 ## 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
|
88 ## scalar. |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
89 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
90 ## @item TolX |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
91 ## 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
|
92 ## 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
|
93 ## 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
|
94 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
95 ## @item TypicalX |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
96 ## |
|
5289d7c2460d
optimset.m: Document valid parameters for optimization functions.
Carnë Draug <carandraug+dev@gmail.com>
parents:
11523
diff
changeset
|
97 ## @item Updating |
|
14898
f8bb15f6a19b
doc: Add "Display" option to optimset documentation.
Andy Adler <andy@analyti.ca>
parents:
14387
diff
changeset
|
98 ## @end table |
| 6226 | 99 ## @end deftypefn |
| 100 | |
| 101 function retval = optimset (varargin) | |
| 102 | |
| 103 nargs = nargin (); | |
| 104 | |
| 105 ## Add more as needed. | |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
106 opts = __all_opts__ (); |
| 6226 | 107 |
| 108 if (nargs == 0) | |
| 109 if (nargout == 0) | |
| 110 ## Display possibilities. | |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
111 puts ("\nAll possible optimization options:\n\n"); |
|
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
112 printf (" %s\n", opts{:}); |
|
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
113 puts ("\n"); |
| 6226 | 114 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
|
115 ## 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
|
116 retval = cell2struct (repmat ({[]}, size (opts)), opts, 2); |
| 6226 | 117 endif |
| 118 elseif (nargs == 1 && ischar (varargin{1})) | |
| 119 ## Return defaults for named function. | |
| 120 fcn = varargin{1}; | |
|
8596
8833c0b18eb2
enable default settings queries in optim funcs
Jaroslav Hajek <highegg@gmail.com>
parents:
8304
diff
changeset
|
121 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
|
122 retval = feval (fcn, "defaults"); |
|
8596
8833c0b18eb2
enable default settings queries in optim funcs
Jaroslav Hajek <highegg@gmail.com>
parents:
8304
diff
changeset
|
123 catch |
|
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
124 error ("optimset: no defaults for function '%s'", fcn); |
| 8598 | 125 end_try_catch |
| 6226 | 126 elseif (nargs == 2 && isstruct (varargin{1}) && isstruct (varargin{2})) |
| 127 ## Set slots in old from nonempties in new. Should we be checking | |
| 128 ## to ensure that the field names are expected? | |
| 129 old = varargin{1}; | |
| 130 new = varargin{2}; | |
| 6227 | 131 fnames = fieldnames (old); |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
132 ## skip validation if we're in the internal query |
|
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
133 validation = ! isempty (opts); |
| 6226 | 134 for [val, key] = new |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
135 if (validation) |
|
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
136 ## Case insensitive lookup in all options. |
|
16674
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
137 i = strncmpi (opts, key, length (key)); |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
138 nmatch = sum (i); |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
139 ## Validate option. |
|
16674
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
140 if (nmatch == 1) |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
141 key = opts{find (i)}; |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
142 elseif (nmatch == 0) |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
143 warning ("unrecognized option: %s", key); |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
144 else |
|
16674
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
145 fmt = sprintf ("ambiguous option: %%s (%s%%s)", |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
146 repmat ("%s, ", 1, nmatch-1)); |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
147 warning (fmt, key, opts{i}); |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
148 endif |
| 6226 | 149 endif |
| 6227 | 150 old.(key) = val; |
| 6226 | 151 endfor |
| 152 retval = old; | |
| 153 elseif (rem (nargs, 2) && isstruct (varargin{1})) | |
| 154 ## 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
|
155 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
|
156 retval = optimset (varargin{1}, cell2struct (pairs(2, :), pairs(1, :), 2)); |
| 6226 | 157 elseif (rem (nargs, 2) == 0) |
| 158 ## Create struct. Default values are replaced by those specified by | |
| 159 ## 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
|
160 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
|
161 retval = optimset (struct (), cell2struct (pairs(2, :), pairs(1, :), 2)); |
| 6226 | 162 else |
| 163 print_usage (); | |
| 164 endif | |
| 165 | |
| 166 endfunction | |
|
8647
06f5dd901f30
implement registering of optimization options
Jaroslav Hajek <highegg@gmail.com>
parents:
8598
diff
changeset
|
167 |
|
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
|
168 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
169 %!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
|
170 %!assert (isfield (optimset ("tolFun", 1e-3), "TolFun")) |
|
16674
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
171 %!warning (optimset ("Max", 10)); |
|
bc79ac595a05
allow abbreviations for optimset and optimget (bug #38999)
John W. Eaton <jwe@octave.org>
parents:
15467
diff
changeset
|
172 %!warning (optimset ("foobar", 13)); |
|
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
|
173 |
|
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
|
174 %!error (optimset ("%NOT_A_REAL_FUNCTION_NAME%")) |
|
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
175 |