octave-nkf: scripts/optimization/optimset.m annotate

annotate scripts/optimization/optimset.m @ 17338:1c89599167a6

maint: End m-files with 1 blank line. Simplifies automated grammarchecking script. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/close.m, scripts/@ftp/delete.m, scripts/@ftp/dir.m, scripts/@ftp/display.m, scripts/@ftp/ftp.m, scripts/@ftp/loadobj.m, scripts/@ftp/mget.m, scripts/@ftp/mkdir.m, scripts/@ftp/mput.m, scripts/@ftp/rename.m, scripts/@ftp/rmdir.m, scripts/@ftp/saveobj.m, scripts/audio/lin2mu.m, scripts/audio/loadaudio.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/saveaudio.m, scripts/audio/setaudio.m, scripts/deprecated/__error_text__.m, scripts/deprecated/cut.m, scripts/deprecated/error_text.m, scripts/deprecated/isstr.m, scripts/deprecated/polyderiv.m, scripts/deprecated/studentize.m, scripts/deprecated/sylvester_matrix.m, scripts/general/bicubic.m, scripts/general/celldisp.m, scripts/general/colon.m, scripts/general/cplxpair.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/isdir.m, scripts/general/isequaln.m, scripts/general/loadobj.m, scripts/general/private/__isequal__.m, scripts/general/private/__splinen__.m, scripts/general/profexplore.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/repmat.m, scripts/general/saveobj.m, scripts/geometry/delaunay.m, scripts/help/__unimplemented__.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/print_usage.m, scripts/help/private/__additional_help_message__.m, scripts/help/private/__strip_html_tags__.m, scripts/help/type.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/image/private/__imfinfo__.m, scripts/image/private/__imread__.m, scripts/image/private/__imwrite__.m, scripts/image/private/imageIO.m, scripts/image/private/imwrite_filename.m, scripts/image/private/ind2x.m, scripts/io/beep.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/subspace.m, scripts/miscellaneous/bug_report.m, scripts/miscellaneous/bunzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dump_prefs.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isdeployed.m, scripts/miscellaneous/ismac.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mexext.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/namelengthmax.m, scripts/miscellaneous/news.m, scripts/miscellaneous/pack.m, scripts/miscellaneous/perl.m, scripts/miscellaneous/private/display_info_file.m, scripts/miscellaneous/python.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/run.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tempname.m, scripts/miscellaneous/untar.m, scripts/miscellaneous/unzip.m, scripts/miscellaneous/what.m, scripts/miscellaneous/zip.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/optimget.m, scripts/optimization/optimset.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/path/pathdef.m, scripts/pkg/pkg.m, scripts/pkg/private/build.m, scripts/pkg/private/describe.m, scripts/pkg/private/dirempty.m, scripts/pkg/private/get_forge_download.m, scripts/pkg/private/get_forge_pkg.m, scripts/pkg/private/get_unsatisfied_deps.m, scripts/pkg/private/install.m, scripts/pkg/private/is_architecture_dependent.m, scripts/pkg/private/list_forge_packages.m, scripts/pkg/private/rebuild.m, scripts/pkg/private/shell.m, scripts/pkg/private/uninstall.m, scripts/plot/axes.m, scripts/plot/box.m, scripts/plot/closereq.m, scripts/plot/diffuse.m, scripts/plot/ezpolar.m, scripts/plot/findfigs.m, scripts/plot/gco.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/linkprop.m, scripts/plot/peaks.m, scripts/plot/print.m, scripts/plot/private/__add_datasource__.m, scripts/plot/private/__axis_label__.m, scripts/plot/private/__clabel__.m, scripts/plot/private/__color_str_rgb__.m, scripts/plot/private/__contour__.m, scripts/plot/private/__default_plot_options__.m, scripts/plot/private/__errcomm__.m, scripts/plot/private/__file_filter__.m, scripts/plot/private/__fltk_file_filter__.m, scripts/plot/private/__getlegenddata__.m, scripts/plot/private/__gnuplot_open_stream__.m, scripts/plot/private/__gnuplot_print__.m, scripts/plot/private/__go_draw_axes__.m, scripts/plot/private/__interp_cube__.m, scripts/plot/private/__is_function__.m, scripts/plot/private/__line__.m, scripts/plot/private/__marching_cube__.m, scripts/plot/private/__next_line_style__.m, scripts/plot/private/__patch__.m, scripts/plot/private/__pie__.m, scripts/plot/private/__pltopt__.m, scripts/plot/private/__quiver__.m, scripts/plot/private/__scatter__.m, scripts/plot/private/__stem__.m, scripts/plot/private/__uigetdir_fltk__.m, scripts/plot/private/__uigetfile_fltk__.m, scripts/plot/private/__uiobject_split_args__.m, scripts/plot/private/__uiputfile_fltk__.m, scripts/plot/refresh.m, scripts/plot/saveas.m, scripts/plot/shg.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/uicontextmenu.m, scripts/plot/uicontrol.m, scripts/plot/uipanel.m, scripts/plot/uipushtool.m, scripts/plot/uiresume.m, scripts/plot/uitoggletool.m, scripts/plot/uitoolbar.m, scripts/plot/uiwait.m, scripts/plot/waitforbuttonpress.m, scripts/polynomial/pchip.m, scripts/polynomial/polyeig.m, scripts/polynomial/ppval.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/private/loadprefs.m, scripts/prefs/private/prefsfile.m, scripts/prefs/private/saveprefs.m, scripts/prefs/setpref.m, scripts/set/private/validargs.m, scripts/set/unique.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arch_test.m, scripts/signal/arma_rnd.m, scripts/signal/durbinlevinson.m, scripts/signal/fractdiff.m, scripts/signal/freqz.m, scripts/signal/freqz_plot.m, scripts/signal/hurst.m, scripts/signal/periodogram.m, scripts/signal/private/rectangle_lw.m, scripts/signal/private/rectangle_sw.m, scripts/signal/private/triangle_sw.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/yulewalker.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/spdiags.m, scripts/sparse/sprandn.m, scripts/specfun/bessel.m, scripts/specfun/betaln.m, scripts/specfun/expint.m, scripts/special-matrix/gallery.m, scripts/startup/__finish__.m, scripts/statistics/base/qqplot.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/logistic_regression.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/bartlett_test.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/hotelling_test_2.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m, scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m, scripts/testfun/__run_test_suite__.m, scripts/time/clock.m, scripts/time/datenum.m, scripts/ui/errordlg.m, scripts/ui/private/message_dialog.m: End m-files with 1 blank line.

author	Rik <rik@octave.org>
date	Wed, 28 Aug 2013 08:33:02 -0700
parents	bc924baa2c4e
children	d63878346099

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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	3 ##
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	5 ##
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6227 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6227 diff changeset	9 ## your option) any later version.
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	10 ##
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	15 ##
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6227 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6227 diff changeset	18 ## <http://www.gnu.org/licenses/>.
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	19
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	22 ## @deftypefnx {Function File} {} optimset (@var{par}, @var{val}, @dots{})
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	23 ## @deftypefnx {Function File} {} optimset (@var{old}, @var{par}, @var{val}, @dots{})
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	24 ## @deftypefnx {Function File} {} optimset (@var{old}, @var{new})
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16674 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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	99 ## @end deftypefn
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	100
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	101 function retval = optimset (varargin)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	102
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	103 nargs = nargin ();
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	104
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	107
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	108 if (nargs == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	109 if (nargout == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	117 endif
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	118 elseif (nargs == 1 && ischar (varargin{1}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	119 ## Return defaults for named function.
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 11cf7bc4a871 fix invalid block end Jaroslav Hajek <highegg@gmail.com> parents: 8596 diff changeset	125 end_try_catch
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	126 elseif (nargs == 2 && isstruct (varargin{1}) && isstruct (varargin{2}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	127 ## Set slots in old from nonempties in new. Should we be checking
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	128 ## to ensure that the field names are expected?
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	129 old = varargin{1};
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	130 new = varargin{2};
6227 4c252a611d47 [project @ 2007-01-05 20:23:59 by jwe] jwe parents: 6226 diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	149 endif
6227 4c252a611d47 [project @ 2007-01-05 20:23:59 by jwe] jwe parents: 6226 diff changeset	150 old.(key) = val;
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	151 endfor
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	152 retval = old;
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	153 elseif (rem (nargs, 2) && isstruct (varargin{1}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	157 elseif (rem (nargs, 2) == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	158 ## Create struct. Default values are replaced by those specified by
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	162 else
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	163 print_usage ();
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	164 endif
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	165
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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

Mercurial > octave-nkf

annotate scripts/optimization/optimset.m @ 17338:1c89599167a6