annotate scripts/miscellaneous/parseparams.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 49dfdb54bb2b
children a1dbe9d80eee
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5997
diff changeset
7 ## 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
8 ## your option) any later version.
5981
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5997
diff changeset
16 ## 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
17 ## <http://www.gnu.org/licenses/>.
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
18
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
20 ## @deftypefn {Function File} {[@var{reg}, @var{prop}] =} parseparams (@var{params})
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
21 ## 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
22 ## string element and in @var{prop} all remaining elements beginning
5997
49dfdb54bb2b [project @ 2006-09-23 13:29:18 by dbateman]
dbateman
parents: 5996
diff changeset
23 ## with the first string element. For example
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
24 ##
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
25 ## @example
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
26 ## @group
5981
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 =
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
29 ## @{
5981
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
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
32 ## @}
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
33 ## prop =
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
34 ## @{
5981
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
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
37 ## @}
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
38 ## @end group
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
39 ## @end example
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
40 ##
5996
bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman]
dbateman
parents: 5981
diff changeset
41 ## The parseparams function may be used to separate 'regular'
5981
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
42 ## arguments and additional arguments given as property/value pairs of
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
43 ## the @var{varargin} cell array.
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
44 ## @seealso{varargin}
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
45 ## @end deftypefn
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
46
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
47 ## Author: Alexander Barth <abarth93@users.sourceforge.net>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
48 ## Author: Aida Alvera Azcarate <aida@netecho.info>
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
49
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
50 function [reg, prop] = parseparams (params)
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
51
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
52 i = 1;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
53
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
54 while (i <= numel (params))
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
55 if (ischar (params{i}))
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
56 break;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
57 endif
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
58 i++;
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
59 endwhile
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
60
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
61 reg = params(1:i-1);
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
62 prop = params(i:end);
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
63
dadcfe8b7ba4 [project @ 2006-09-05 15:33:24 by jwe]
jwe
parents:
diff changeset
64 endfunction