annotate scripts/control/system/cellidx.m @ 7136:59dcf01bb3e3

[project @ 2007-11-08 20:18:25 by jwe]
author jwe
date Thu, 08 Nov 2007 20:18:26 +0000
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2000, 2004, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Auburn University. All rights reserved.
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
3 ##
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
5 ##
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
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: 6046
diff changeset
9 ## your option) any later version.
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
10 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
14 ## General Public License for more details.
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
15 ##
f105000ab25c [project @ 2004-02-17 02:34:33 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: 6046
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: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
19
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4779
diff changeset
21 ## @deftypefn {Function File} {[@var{idxvec}, @var{errmsg}] =} cellidx (@var{listvar}, @var{strlist})
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
22 ## Return indices of string entries in @var{listvar} that match strings
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
23 ## in @var{strlist}.
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
24 ##
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
25 ## Both @var{listvar} and @var{strlist} may be passed as strings or
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
26 ## string matrices. If they are passed as string matrices, each entry
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
27 ## is processed by @code{deblank} prior to searching for the entries.
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
28 ##
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
29 ## The first output is the vector of indices in @var{listvar}.
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
30 ##
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
31 ## If @var{strlist} contains a string not in @var{listvar}, then
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
32 ## an error message is returned in @var{errmsg}. If only one output
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 4779
diff changeset
33 ## argument is requested, then @var{cellidx} prints @var{errmsg} to the
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
34 ## screen and exits with an error.
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
35 ## @end deftypefn
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
36
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
37 function [idxvec,errmsg] = cellidx (listvar, strlist)
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
38
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
39 if (nargin != 2)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
40 print_usage ();
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
41 endif
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
42
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
43 if (ischar (strlist))
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
44 tmp = strlist;
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
45 strlist = {};
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
46 for kk = 1:rows(tmp)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
47 strlist{kk} = deblank (tmp(kk,:));
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
48 endfor
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
49 endif
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
50
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
51 if (ischar (listvar))
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
52 tmp = listvar;
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
53 listvar = {};
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
54 for kk = 1:rows(tmp)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
55 listvar{kk} = deblank (tmp(kk,:));
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
56 endfor
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
57 endif
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
58
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
59 ## initialize size of idxvec (for premature return)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
60 idxvec = zeros (length(strlist), 1);
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
61
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
62 errmsg = "";
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
63 if (! is_signal_list (listvar))
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
64 errmsg = "listvar must be a list of strings";
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
65 elseif (! is_signal_list (strlist))
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
66 errmsg = "strlist must be a list of strings";
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
67 endif
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
68
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
69 if (length (errmsg))
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
70 if (nargout < 2)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
71 error (errmsg);
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
72 else
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
73 return;
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
74 endif
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
75 endif
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
76
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
77 nsigs = length(listvar);
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
78 for idx = 1:length(strlist)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
79 signame = strlist{idx};
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
80 for jdx = 1:nsigs
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
81 if (strcmp (signame, listvar{jdx}) )
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
82 if (idxvec(idx) != 0)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
83 warning ("Duplicate signal name %s (%d,%d)\n",
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
84 listvar{jdx}, jdx, idxvec(idx));
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
85 else
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
86 idxvec(idx) = jdx;
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
87 endif
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
88 endif
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
89 endfor
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
90 if (idxvec(idx) == 0)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
91 errmsg = sprintf ("Did not find %s", signame);
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
92 if (nargout == 1)
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
93 error (errmsg);
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
94 else
7136
59dcf01bb3e3 [project @ 2007-11-08 20:18:25 by jwe]
jwe
parents: 7017
diff changeset
95 break;
4779
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
96 endif
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
97 endif
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
98 endfor
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
99
f105000ab25c [project @ 2004-02-17 02:34:33 by jwe]
jwe
parents:
diff changeset
100 endfunction