annotate scripts/strings/index.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 0baa196d93b5
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
1 ## Copyright (C) 1996, 2006 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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6901
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: 6901
diff changeset
8 ## your option) any later version.
2313
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6901
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: 6901
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
19 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
20 ## @deftypefn {Function File} {} index (@var{s}, @var{t})
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
21 ## @deftypefnx {Function File} {} index (@var{s}, @var{t}, @var{direction})
3361
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 ##
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
30 ## If @var{direction} is @samp{"first"}, return the first element found.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
31 ## If @var{direction} is @samp{"last"}, return the last element found.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
32 ## The @code{rindex} function is equivalent to @code{index} with
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
33 ## @var{direction} set to @samp{"last"}.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
34 ##
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
35 ## @strong{Caution:} This function does not work for arrays of
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
36 ## character strings.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
37 ## @seealso{find, rindex}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
38 ## @end deftypefn
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
39
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
40 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
41 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
42
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
43 function n = index (s, t, direction)
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
44
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 2276
diff changeset
45 ## 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
46
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
47 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
48 print_usage ();
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
49 elseif (nargin < 3)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
50 direction = "first";
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
51 endif
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
52 direction = lower (direction);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
53
6749
f7fdea19da88 [project @ 2007-06-20 18:10:04 by jwe]
jwe
parents: 6139
diff changeset
54 if (! (ischar (s) && ischar (t)))
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
55 error ("index: expecting character string arguments");
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
56 elseif (! strcmp (direction, {"first", "last"}))
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
57 error ("index: direction must be either \"first\" or \"last\"");
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
58 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
59
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
60 l_s = length (s);
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
61 l_t = length (t);
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
62
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
63 n = 0;
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
64 if (l_s == 0 || l_s < l_t)
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
65 ## zero length source, or target longer than source
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
66 ## return 0
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
67 v = [];
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
68
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
69 elseif (l_t == 0)
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
70 ## zero length target: return first
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
71 v = 1;
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
72
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
73 elseif (l_t == 1)
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
74 ## length one target: simple find
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
75 v = find (s==t, 1, direction);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
76
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
77 elseif (l_t == 2)
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
78 ## length two target: find first at i and second at i+1
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
79 v = find (s (1:l_s-1) == t(1) & s(2:l_s) == t(2), 1, direction);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
80
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
81 else
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
82 ## 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
83 ## 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
84 limit = l_s - l_t + 1;
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
85 v = find (s (1:limit) == t(1)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
86 & s (2:limit+1) == t(2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
87 & s (3:limit+2) == t(3));
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
88 if (strcmp (direction, "last"))
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
89 v = v(length(v):-1:1);
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
90 endif
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
91
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
92 if (l_t > 3)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
93
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
94 ## force strings to be both row vectors or both column vectors
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
95 if (all (size (s) != size (t)))
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
96 t = t.';
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
97 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
98
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
99 ## search index vector for a match
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
100 ind = 0:l_t-1;
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
101 ## return 0 if loop terminates without finding any match
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
102 for idx = 1:length(v)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
103 if (s (v(idx) + ind) == t)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
104 n = v(idx);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
105 break;
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
106 endif
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
107 endfor
6901
0baa196d93b5 [project @ 2007-09-14 17:16:42 by jwe]
jwe
parents: 6749
diff changeset
108 v = [];
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
109 endif
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
110
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
111 endif
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
112
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
113 if (n == 0 && ! isempty (v))
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
114 ## return the first found if n is not already set and v is not empty
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
115 n = v(1);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
116 endif
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
117
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
118 endfunction
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
119
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
120 ## Test the function out
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
121 %!assert(index("astringbstringcstring", "s"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
122 %!assert(index("astringbstringcstring", "st"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
123 %!assert(index("astringbstringcstring", "str"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
124 %!assert(index("astringbstringcstring", "string"), 2)
6901
0baa196d93b5 [project @ 2007-09-14 17:16:42 by jwe]
jwe
parents: 6749
diff changeset
125 %!assert(index("abc---", "abc+++"), 0)
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
126
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
127 ## test everything out in reverse
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
128 %!assert(index("astringbstringcstring", "s", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
129 %!assert(index("astringbstringcstring", "st", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
130 %!assert(index("astringbstringcstring", "str", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
131 %!assert(index("astringbstringcstring", "string", "last"), 16)
6901
0baa196d93b5 [project @ 2007-09-14 17:16:42 by jwe]
jwe
parents: 6749
diff changeset
132 %!assert(index("abc---", "abc+++", "last"), 0)