Mercurial > hg > octave-jordi

annotate scripts/miscellaneous/parseparams.m @ 21052:b702efa70fb5 draft default tip shane

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding --json-sock option; publishes octave_link events to a UNIX socket.
author Shane F. Carr <shane.carr@wustl.edu>
date Mon, 04 Jan 2016 08:51:31 +0000
parents 516bb87ea72e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19696
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19178
diff changeset
1 ## Copyright (C) 2006-2015 Alexander Barth
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
2 ## Copyright (C) 2010 VZLU Prague
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
3 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
5 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
dadcfe8b7ba4 [project @ 2006-09-05 15:33: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: 5997
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: 5997
diff changeset
9 ## your option) any later version.
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
10 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
15 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33: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: 5997
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: 5997
diff changeset
18 ## <http://www.gnu.org/licenses/>.
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
19
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
20851
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20163
diff changeset
21 ## @deftypefn {} {[@var{reg}, @var{prop}] =} parseparams (@var{params})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20163
diff changeset
22 ## @deftypefnx {} {[@var{reg}, @var{var1}, @dots{}] =} parseparams (@var{params}, @var{name1}, @var{default1}, @dots{})
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
23 ## Return in @var{reg} the cell elements of @var{param} up to the first
20163
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
24 ## string element and in @var{prop} all remaining elements beginning with the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
25 ## first string element.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
26 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
27 ## For example:
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
28 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
29 ## @example
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
30 ## @group
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
31 ## [reg, prop] = parseparams (@{1, 2, "linewidth", 10@})
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
32 ## reg =
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
33 ## @{
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
34 ## [1,1] = 1
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
35 ## [1,2] = 2
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
36 ## @}
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
37 ## prop =
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
38 ## @{
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
39 ## [1,1] = linewidth
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
40 ## [1,2] = 10
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
41 ## @}
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
42 ## @end group
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
43 ## @end example
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
44 ##
20163
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
45 ## The parseparams function may be used to separate regular numeric arguments
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
46 ## from additional arguments given as property/value pairs of the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
47 ## @var{varargin} cell array.
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
48 ##
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
49 ## In the second form of the call, available options are specified directly
20163
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
50 ## with their default values given as name-value pairs. If @var{params} do
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
51 ## not form name-value pairs, or if an option occurs that does not match any
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
52 ## of the available options, an error occurs.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
53 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
54 ## When called from an m-file function, the error is prefixed with the name
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
55 ## of the caller function.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19696
diff changeset
56 ##
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
57 ## The matching of options is case-insensitive.
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
58 ##
19178
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
59 ## @seealso{varargin, inputParser}
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
60 ## @end deftypefn
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
61
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
62 ## Author: Alexander Barth <abarth93@users.sourceforge.net>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
63 ## Author: Aida Alvera Azcarate <aida@netecho.info>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
64
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
65 function [reg, varargout] = parseparams (params, varargin)
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
66
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
67 strs = cellfun ("isclass", params, "char");
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
68 i = find (strs, 1);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
69 if (i)
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
70 reg = params(1:i-1);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
71 prop = params(i:end);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
72 else
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
73 reg = params;
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
74 prop = {};
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
75 endif
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
76
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
77 if (nargin == 1)
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
78 varargout = {prop};
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
79 else
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
80 names = varargin(1:2:end);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
81 defaults = varargin(2:2:end);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
82 if (! size_equal (names, defaults))
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
83 error ("parseparams: needs odd number of arguments");
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
84 endif
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
85 [names, sidx] = sort (names);
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
86
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
87 varargout = defaults;
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
88 if (i)
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
89 ## Let's parse the properties.
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
90 pnames = prop(1:2:end);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
91 values = prop(2:2:end);
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
92 if (! size_equal (pnames, values) || ! all (strs(i:2:end)))
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
93 error_as_caller ("options must be given as name-value pairs");
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
94 endif
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14359
diff changeset
95 idx = lookup (toupper (names), toupper (pnames), "m");
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
96 if (! all (idx))
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
97 error_as_caller ("unrecognized option: %s", pnames{find (idx == 0, 1)});
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
98 else
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
99 varargout(sidx(idx)) = values;
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
100 endif
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
101 endif
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
102 endif
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
103
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
104 endfunction
10308
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
105
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
106 function error_as_caller (msg, varargin)
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
107 stack = dbstack (1); # omit me
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
108 fname = stack(min (2, end)).name;
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
109 error ([fname, ": ", msg], varargin{:});
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
110 endfunction
0d928dd9eeb8 extend parseparams
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
111
19178
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
112
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
113 %!test
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
114 %! [reg, prop] = parseparams ({1, 2, "linewidth", 10});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
115 %! assert (reg, {[1], [2]});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
116 %! assert (prop, {"linewidth", 10});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
117 %!test
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
118 %! [reg, prop] = parseparams ({1, 2, 3});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
119 %! assert (reg, {[1], [2], [3]});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
120 %! assert (isempty (prop));
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
121 %!test
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
122 %! [reg, prop] = parseparams ({"prop1", "val1"});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
123 %! assert (isempty (reg));
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
124 %! assert (prop, {"prop1", "val1"});
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
125 %!test
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
126 %! [reg, prop1] = parseparams ({"linewidth", 5}, "linewidth", 10);
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
127 %! assert (isempty (reg));
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
128 %! assert (prop1, 5);
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
129
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
130 %!error <needs odd number of arguments> parseparams ({1}, "linewidth")
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
131 %!error <must be given as name-value pairs> parseparams ({1, "color"}, "linewidth", 5)
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
132 %!error <unrecognized option: color> parseparams ({1, "color", 5}, "linewidth", 5)
751d4a76c221 parseparams.m: Add BIST tests to function.
Rik <rik@octave.org>
parents: 17744
diff changeset
133