annotate scripts/miscellaneous/parseparams.m @ 5981:dadcfe8b7ba4

[project @ 2006-09-05 15:33:24 by jwe]
author jwe
date Tue, 05 Sep 2006 15:33:24 +0000
parents
children bd0507994409
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2006 Alexander Barth
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
2 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
4 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
9 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
14 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
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 -*-
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} [@var{reg}, @var{prop}] = parseparams (@var{params})
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
22 ## Return in @var{reg} the cell elements of @var{param} up to the first
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
23 ## string element and in @var{prop} all remaining elements beginning
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
24 ## with the first string element. For example
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
25 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
26 ## @example
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
27 ## [reg, prop] = parseparams (@{1, 2, "linewidth", 10@})
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
28 ## reg =
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
29 ## {
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
30 ## [1,1] = 1
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
31 ## [1,2] = 2
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
32 ## }
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
33 ## prop =
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
34 ## {
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
35 ## [1,1] = linewidth
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
36 ## [1,2] = 10
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
37 ## }
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
38 ## @end example
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
39 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
40 ## The parseparams function may be used to separate "regular"
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
41 ## arguments and additional arguments given as property/value pairs of
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
42 ## the @var{varargin} cell array.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
43 ## @seealso{varargin}
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
44 ## @end deftypefn
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
45
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
46 ## Author: Alexander Barth <abarth93@users.sourceforge.net>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
47 ## Author: Aida Alvera Azcarate <aida@netecho.info>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
48
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
49 function [reg, prop] = parseparams (params)
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
50
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
51 i = 1;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
52
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
53 while (i <= numel (params))
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
54 if (ischar (params{i}))
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
55 break;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
56 endif
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
57 i++;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
58 endwhile
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
59
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
60 reg = params(1:i-1);
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
61 prop = params(i:end);
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
62
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
63 endfunction