Mercurial > octave
view scripts/miscellaneous/parseparams.m @ 31247:3dae836c598c
doc: Expand and edit documentation for memoization (bug #60860)
author | Arun Giridhar <arungiridhar@gmail.com> |
---|---|
date | Fri, 30 Sep 2022 06:38:59 -0400 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2006-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{reg}, @var{prop}] =} parseparams (@var{params}) ## @deftypefnx {} {[@var{reg}, @var{var1}, @dots{}] =} parseparams (@var{params}, @var{name1}, @var{default1}, @dots{}) ## Return in @var{reg} the cell elements of @var{param} up to the first ## string element and in @var{prop} all remaining elements beginning with the ## first string element. ## ## For example: ## ## @example ## @group ## [reg, prop] = parseparams (@{1, 2, "linewidth", 10@}) ## reg = ## @{ ## [1,1] = 1 ## [1,2] = 2 ## @} ## prop = ## @{ ## [1,1] = linewidth ## [1,2] = 10 ## @} ## @end group ## @end example ## ## The parseparams function may be used to separate regular numeric arguments ## from additional arguments given as property/value pairs of the ## @var{varargin} cell array. ## ## In the second form of the call, available options are specified directly ## with their default values given as name-value pairs. If @var{params} do ## not form name-value pairs, or if an option occurs that does not match any ## of the available options, an error occurs. ## ## When called from an m-file function, the error is prefixed with the name ## of the caller function. ## ## The matching of options is case-insensitive. ## ## @seealso{varargin, inputParser} ## @end deftypefn function [reg, varargout] = parseparams (params, varargin) strs = cellfun ("isclass", params, "char"); i = find (strs, 1); if (i) reg = params(1:i-1); prop = params(i:end); else reg = params; prop = {}; endif if (nargin == 1) varargout = {prop}; else names = varargin(1:2:end); defaults = varargin(2:2:end); if (! size_equal (names, defaults)) error ("parseparams: needs odd number of arguments"); endif [names, sidx] = sort (toupper (names)); varargout = defaults; if (i) ## Let's parse the properties. pnames = prop(1:2:end); values = prop(2:2:end); if (! size_equal (pnames, values) || ! all (strs(i:2:end))) error_as_caller ("options must be given as name-value pairs"); endif idx = lookup (names, toupper (pnames), "m"); if (! all (idx)) error_as_caller ("unrecognized option: %s", pnames{find (idx == 0, 1)}); else varargout(sidx(idx)) = values; endif endif endif endfunction function error_as_caller (msg, varargin) stack = dbstack (1); # omit me fname = stack(min (2, end)).name; error ([fname, ": ", msg], varargin{:}); endfunction %!test %! [reg, prop] = parseparams ({1, 2, "linewidth", 10}); %! assert (reg, {[1], [2]}); %! assert (prop, {"linewidth", 10}); %!test %! [reg, prop] = parseparams ({1, 2, 3}); %! assert (reg, {[1], [2], [3]}); %! assert (isempty (prop)); %!test %! [reg, prop] = parseparams ({"prop1", "val1"}); %! assert (isempty (reg)); %! assert (prop, {"prop1", "val1"}); %!test %! [reg, prop1] = parseparams ({"linewidth", 5}, "linewidth", 10); %! assert (isempty (reg)); %! assert (prop1, 5); %!test <*58533> %! [foo, bar1, bar2] = parseparams ({ 0, "model", 1, "N", 2},"model", 4, "N", 5, "d", 6); %! assert (foo, {0}); %! assert (bar1, 1); %! assert (bar2, 2); %!error <needs odd number of arguments> parseparams ({1}, "linewidth") %!error <must be given as name-value pairs> parseparams ({1, "color"}, "linewidth", 5) %!error <unrecognized option: color> parseparams ({1, "color", 5}, "linewidth", 5)