octave: scripts/optimization/optimset.m annotate

annotate scripts/optimization/optimset.m @ 15466:d174210ce1ec stable

use ' instead of ` in error messages, warnings and most comments * intro.txi, io.txi, munge-texi.cc, octave.texi, cmd-edit.cc, data-conv.cc, file-ops.cc, glob-match.h, kpse.cc, oct-env.cc, oct-locbuf.h, oct-md5.cc, oct-rand.cc, general/interp2.m, doc.m, get_first_help_sentence.m, help.m, print_usage.m, __additional_help_message__.m, type.m, unimplemented.m, which.m, cast.m, dir.m, license.m, mkoctfile.m, recycle.m, tempdir.m, optimset.m, pkg/pkg.m, closereq.m, colstyle.m, __fltk_print__.m, __gnuplot_print__.m, __go_draw_figure__.m, __pie__.m, __pltopt__.m, __print_parse_opts__.m, uigetdir.m, uigetfile.m, uiputfile.m, stft.m, mean.m, anova.m, cor_test.m, t_test_regression.m, __magick_read__.cc, dlmread.cc, schur.cc, data.cc, debug.cc, defun-dld.h, defun.cc, defun.h, dynamic-ld.cc, error.cc, error.h, gl-render.cc, graphics.cc, gripes.cc, input.cc, lex.ll, load-path.cc, load-save.cc, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-ascii.cc, ls-oct-binary.cc, oct-hist.cc, oct-parse.yy, oct-stream.cc, oct-stream.h, octave.cc, ov-base-diag.cc, ov-base.cc, ov-class.cc, ov-colon.h, ov-struct.cc, ov-typeinfo.cc, ov.cc, pager.cc, pr-output.cc, pt-binop.cc, pt-eval.cc, pt-id.cc, pt-idx.cc, pt-misc.cc, pt-unop.cc, symtab.cc, symtab.h, toplev.cc, txt-eng-ft.cc, utils.cc, variables.cc, test_eval-catch.m, test_try.m: Use ' instead of ` in error messages, warnings, and most comments.

author	John W. Eaton <jwe@octave.org>
date	Mon, 01 Oct 2012 17:18:49 -0400
parents	72c96de7a403
children	049e8bbff782

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:
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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	77 ## @end deftypefn
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	78
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	79 function retval = optimset (varargin)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	80
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	81 nargs = nargin ();
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	82
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	85
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	86 if (nargs == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	87 if (nargout == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	95 endif
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	96 elseif (nargs == 1 && ischar (varargin{1}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	97 ## Return defaults for named function.
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	102 error ("optimset: no defaults for function '%s'", fcn);
8598 11cf7bc4a871 fix invalid block end Jaroslav Hajek <highegg@gmail.com> parents: 8596 diff changeset	103 end_try_catch
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	104 elseif (nargs == 2 && isstruct (varargin{1}) && isstruct (varargin{2}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	105 ## 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	106 ## to ensure that the field names are expected?
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	107 old = varargin{1};
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	108 new = varargin{2};
6227 4c252a611d47 [project @ 2007-01-05 20:23:59 by jwe] jwe parents: 6226 diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	124 endif
6227 4c252a611d47 [project @ 2007-01-05 20:23:59 by jwe] jwe parents: 6226 diff changeset	125 old.(key) = val;
6226 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	126 endfor
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	127 retval = old;
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	128 elseif (rem (nargs, 2) && isstruct (varargin{1}))
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	132 elseif (rem (nargs, 2) == 0)
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	133 ## Create struct. Default values are replaced by those specified by
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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 984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	137 else
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	138 print_usage ();
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	139 endif
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	140
984d85191d0d [project @ 2007-01-05 18:41:24 by jwe] jwe parents: diff changeset	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
8647 06f5dd901f30 implement registering of optimization options Jaroslav Hajek <highegg@gmail.com> parents: 8598 diff changeset	144 %!assert (optimget (optimset ('tolx', 1e-2), 'tOLx'), 1e-2)
06f5dd901f30 implement registering of optimization options Jaroslav Hajek <highegg@gmail.com> parents: 8598 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

Mercurial > octave

annotate scripts/optimization/optimset.m @ 15466:d174210ce1ec stable