Mercurial > octave
view scripts/optimization/optimget.m @ 31551:fd29c7a50a78 stable
maint: use commas, semicolons consistently with Octave conventions.
* makeValidName.m: Remove %!test and move BIST %!asserts to column 1.
* base64decode.m, base64encode.m, which.m, logm.m, uniquetol.m, perms.m:
Delete semicolon (';') at end of %!assert BIST.
* lin2mu.m, interp2.m, interpn.m, lsqnonneg.m, pqpnonneg.m, uniquetol.m,
betainc.m, normalize.m: Add semicolon (';') to end of assert statement within
%!test BIST.
* __memoize__.m, tar_is_bsd.m, publish.m: Add semicolon (';') to line with
keyword "persistent".
* stft.m: Use comma (',') after "case" keyword when code immediately follows.
* gallery.m: Align commas used in case statements in massive switch block.
Remove unnecessary parentheses around a numeric case argument.
* ranks.m: Remove semicolon (';') from case statemnt argument.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 26 Nov 2022 06:32:08 -0800 |
parents | 5d3faba0342e |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2008-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{optval} =} optimget (@var{options}, @var{optname}) ## @deftypefnx {} {@var{optval} =} optimget (@var{options}, @var{optname}, @var{default}) ## Return the specific option @var{optname} from the optimization options ## structure @var{options} created by @code{optimset}. ## ## If @var{optname} is not defined then return @var{default} if supplied, ## otherwise return an empty matrix. ## @seealso{optimset} ## @end deftypefn function optval = optimget (options, optname, default) if (nargin < 2 || ! isstruct (options) || ! ischar (optname)) print_usage (); endif ## Expand partial-length names into full names opts = __all_opts__ (); idx = strncmpi (opts, optname, length (optname)); nmatch = sum (idx); if (nmatch == 1) optname = opts{idx}; elseif (nmatch == 0) warning ("optimget: unrecognized option: %s", optname); else fmt = sprintf ("optimget: ambiguous option: %%s (%s%%s)", repmat ("%s, ", 1, nmatch-1)); warning (fmt, optname, opts{idx}); endif if (isfield (options, optname) && ! isempty (options.(optname))) optval = options.(optname); elseif (nargin > 2) optval = default; else optval = []; endif endfunction %!shared opts %! opts = optimset ("tolx", 0.1, "maxit", 100); %!assert (optimget (opts, "TolX"), 0.1) %!assert (optimget (opts, "maxit"), 100) %!assert (optimget (opts, "MaxITer"), 100) %!assert (optimget (opts, "TolFun"), []) %!assert (optimget (opts, "TolFun", 1e-3), 1e-3) ## Test input validation %!error <Invalid call> optimget () %!error <Invalid call> optimget (1) %!error optimget (1, "name") %!error optimget (struct (), 2) %!warning <unrecognized option: foobar> (optimget (opts, "foobar")); %!warning <ambiguous option: Max> (optimget (opts, "Max"));