octave-nkf: scripts/deprecated/cellidx.m annotate

annotate scripts/deprecated/cellidx.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	d5bd2766c640
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	1 ## Copyright (C) 2000-2012 Auburn University. All rights reserved.
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	2 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	3 ## This file is part of Octave.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	4 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	5 ## 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	6 ## 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	7 ## 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	8 ## your option) any later version.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	9 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	13 ## General Public License for more details.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	14 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	15 ## 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	16 ## along with Octave; see the file COPYING. If not, see
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	18
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	19 ## -- texinfo --
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	20 ## @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	21 ## 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	22 ## in @var{strlist}.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	23 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	24 ## 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	25 ## 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	26 ## 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	27 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	28 ## 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	29 ##
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	30 ## 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	31 ## 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	32 ## 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	33 ## screen and exits with an error.
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	34 ## @end deftypefn
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	35
9868 7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	36 ## deprecated in version 3.4
7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	37
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	38 function [idxvec,errmsg] = cellidx (listvar, strlist)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	39
9868 7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	40 persistent warned = false;
7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	41 if (! warned)
7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	42 warned = true;
7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	43 warning ("Octave:deprecated-function",
11588 d5bd2766c640 style fixes for warning and error messages in script files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44 "cellidx is obsolete and will be removed from a future version of Octave; use ismember instead");
9868 7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	45 endif
7f4939e76684 deprecate cellidx Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	46
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	47 if (nargin != 2)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	48 print_usage ();
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 (strlist))
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	52 tmp = strlist;
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	53 strlist = {};
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 strlist{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 if (ischar (listvar))
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	60 tmp = listvar;
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	61 listvar = {};
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	62 for kk = 1:rows(tmp)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	63 listvar{kk} = deblank (tmp(kk,:));
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	64 endfor
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	65 endif
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	66
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	67 ## initialize size of idxvec (for premature return)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	68 idxvec = zeros (length(strlist), 1);
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	69
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	70 errmsg = "";
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	71 if (! iscellstr (listvar))
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	72 errmsg = "listvar must be a list of strings";
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	73 elseif (! iscellstr (strlist))
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	74 errmsg = "strlist must be a list of strings";
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 if (length (errmsg))
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	78 if (nargout < 2)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	79 error (errmsg);
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	80 else
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	81 return;
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	82 endif
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	83 endif
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	84
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	85 nsigs = length(listvar);
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	86 for idx = 1:length(strlist)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	87 signame = strlist{idx};
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	88 for jdx = 1:nsigs
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7989 diff changeset	89 if (strcmp (signame, listvar{jdx}))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	90 if (idxvec(idx) != 0)
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	91 warning ("Duplicate signal name %s (%d,%d)\n",
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	92 listvar{jdx}, jdx, idxvec(idx));
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	93 else
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	94 idxvec(idx) = jdx;
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	95 endif
7989 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 endfor
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	98 if (idxvec(idx) == 0)
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	99 errmsg = sprintf ("Did not find %s", signame);
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	100 if (nargout == 1)
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	101 error (errmsg);
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	102 else
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9868 diff changeset	103 break;
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	104 endif
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	105 endif
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	106 endfor
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	107
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: diff changeset	108 endfunction

Mercurial > octave-nkf

annotate scripts/deprecated/cellidx.m @ 14138:72c96de7a403 stable