Mercurial > hg > octave-lyh

annotate scripts/general/cellidx.m @ 7989:23c248d415b5

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