annotate scripts/strings/index.m @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents 48a39e2b2ab7
children 2a16423e4aa0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
1 ## Copyright (C) 1996 Kurt Hornik
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
2 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4946
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4946
diff changeset
18 ## 02110-1301, USA.
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
19
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
20 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
21 ## @deftypefn {Function File} {} index (@var{s}, @var{t})
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
22 ## Return the position of the first occurrence of the string @var{t} in the
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
23 ## string @var{s}, or 0 if no occurrence is found. For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
24 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
25 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
26 ## index ("Teststring", "t")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
27 ## @result{} 4
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
28 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
29 ##
4946
48a39e2b2ab7 [project @ 2004-08-31 17:27:04 by jwe]
jwe
parents: 3911
diff changeset
30 ## @strong{Caution:} This function does not work for arrays of strings.
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
31 ## @end deftypefn
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
32
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
33 ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
34 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
35
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
36 function n = index (s, t)
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
37
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 2276
diff changeset
38 ## This is patterned after the AWK function of the same name.
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
39
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
40 if (nargin != 2)
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
41 usage ("index (s, t)");
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
42 endif
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
43
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
44 if (!isstr (s) || !isstr (t) || all (size (s) > 1) || all (size (t) > 1) )
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
45 error ("index: expecting string arguments");
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
46 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
47
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
48 l_s = length (s);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
49 l_t = length (t);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
50
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
51 if ( l_s == 0 || l_s < l_t )
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
52 ## zero length source, or target longer than source
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
53 v = [];
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
54
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
55 elseif ( l_t == 0 )
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
56 ## zero length target: return first
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
57 v = 1;
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
58
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
59 elseif ( l_t == 1 )
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
60 ## length one target: simple find
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
61 v = find (s==t);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
62
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
63 elseif ( l_t == 2 )
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
64 ## length two target: find first at i and second at i+1
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
65 v = find (s (1 : l_s-1) == t (1) & s (2 : l_s) == t (2));
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
66
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
67 else
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
68 ## length three or more: match the first three by find then go through
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
69 ## the much smaller list to determine which of them are real matches
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
70 limit = l_s - l_t + 1;
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
71 v = find (s (1 : limit) == t(1) & s (2 : limit+1) == t (2)
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
72 & s (3 : limit+2) == t(3) );
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
73 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
74
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
75 if (l_t > 3)
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
76
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
77 ## force strings to be both row vectors or both column vectors
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
78 if (all (size (s) != size (t)))
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
79 t = t.';
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
80 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
81
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
82 ## search index vector for a match
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
83 ind = 0 : l_t - 1;
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
84 n = 0; # return 0 if loop terminates without finding any match
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
85 for idx = 1:length(v)
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
86 if (s (v(idx) + ind) == t)
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
87 n = v(idx);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
88 break;
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
89 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
90 endfor
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
91
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
92 elseif (length(v) > 0)
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
93 n = v(1);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
94
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
95 else
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
96 n = 0;
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
97
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
98 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
99
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
100 endfunction