changelog shortlog tags changeset files revisions annotate raw

scripts/optimization/optimset.m

changeset 10289: 4b124317dc38
parent:06f5dd901f30
author: John W. Eaton <jwe@octave.org>
date: Tue Feb 09 20:58:55 2010 -0500 (28 minutes ago)
permissions: -rw-r--r--
description: base_properties::set_children: account for hidden children 
     1## Copyright (C) 2007, 2008 John W. Eaton

     2## Copyright (C) 2009 VZLU Prague

     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

     8## the Free Software Foundation; either version 3 of the License, or (at

     9## your option) any later version.

    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

    17## along with Octave; see the file COPYING.  If not, see

    18## <http://www.gnu.org/licenses/>.

    19

    20## -*- texinfo -*-

    21## @deftypefn {Function File} {} optimset ()

    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.

    26## @end deftypefn

    27

    28function retval = optimset (varargin)

    29

    30  nargs = nargin ();

    31

    32  ## Add more as needed.

    33  opts = __all_opts__ ();

    34

    35  if (nargs == 0)

    36    if (nargout == 0)

    37      ## Display possibilities.

    38      puts ("\nAll possible optimization options:\n\n");

    39      printf ("  %s\n", opts{:});

    40      puts ("\n");

    41    else

    42      ## Return empty structure.

    43      ## We're incompatible with Matlab at this point.

    44      retval = struct ();

    45    endif

    46  elseif (nargs == 1 && ischar (varargin{1}))

    47    ## Return defaults for named function.

    48    fcn = varargin{1};

    49    try

    50      retval = feval (fcn, 'defaults');

    51    catch

    52      error ("no defaults for function `%s'", fcn);

    53    end_try_catch

    54  elseif (nargs == 2 && isstruct (varargin{1}) && isstruct (varargin{2}))

    55    ## Set slots in old from nonempties in new.  Should we be checking

    56    ## to ensure that the field names are expected?

    57    old = varargin{1};

    58    new = varargin{2};

    59    fnames = fieldnames (old);

    60    ## skip validation if we're in the internal query

    61    validation = ! isempty (opts);

    62    for [val, key] = new

    63      if (validation)

    64        ## Case insensitive lookup in all options.

    65        i = lookup (opts, key, "i");

    66        ## Validate option.

    67        if (i > 0 && strcmpi (opts{i}, key))

    68          ## Use correct case.

    69          key = opts{i};

    70        else

    71          warning ("unrecognized option: %s", key);

    72        endif

    73      endif

    74      old.(key) = val;

    75    endfor

    76    retval = old;

    77  elseif (rem (nargs, 2) && isstruct (varargin{1}))

    78    ## Set values in old from name/value pairs.

    79    retval = optimset (varargin{1}, struct (varargin{2:end}));

    80  elseif (rem (nargs, 2) == 0)

    81    ## Create struct.  Default values are replaced by those specified by

    82    ## name/value pairs.

    83    retval = optimset (struct (), struct (varargin{:}));

    84  else

    85    print_usage ();

    86  endif

    87

    88endfunction

    89

    90%!assert (optimget (optimset ('tolx', 1e-2), 'tOLx'), 1e-2)

    91%!assert (isfield (optimset ('tolFun', 1e-3), 'TolFun'))