Mercurial > octave-antonio

annotate scripts/strings/index.m @ 10793:be55736a0783

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents a87afd063e7d
children 693e22af08ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
1 ## Copyright (C) 1996, 1999, 2000, 2002, 2004, 2005, 2006, 2007, 2008, 2009
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Kurt Hornik
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
3 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## 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
7 ## 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
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: 6901
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## 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
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 6901
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: 6901
diff changeset
18 ## <http://www.gnu.org/licenses/>.
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 -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10409
diff changeset
21 ## @deftypefn {Function File} {} index (@var{s}, @var{t})
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
22 ## @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
23 ## 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
24 ## 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
25 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
26 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## @group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
28 ## index ("Teststring", "t")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
29 ## @result{} 4
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## @end group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
31 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
32 ##
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
33 ## 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
34 ## 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
35 ## 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
36 ## @var{direction} set to @samp{"last"}.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
37 ##
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
38 ## @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
39 ## character strings.
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
40 ## @seealso{find, rindex}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3240
diff changeset
41 ## @end deftypefn
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
42
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
43 ## 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
44 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
45
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
46 function n = index (s, t, direction)
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
47
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 2276
diff changeset
48 ## 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
49
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
50 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
51 print_usage ();
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
52 elseif (nargin < 3)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
53 direction = "first";
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
54 endif
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
55 direction = lower (direction);
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
56
10409
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
57 f = strfind (s, t);
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
58 if (iscell (f))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
59 f(cellfun ("isempty", f)) = {0};
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
60 elseif (isempty (f))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
61 f = 0;
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
62 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
63
10409
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
64 if (strcmp (direction, "last"))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
65 if (iscell (f))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
66 n = cellfun (@min, f);
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
67 else
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
68 n = f(end);
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
69 endif
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
70 elseif (strcmp (direction, "first"))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
71 if (iscell (f))
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
72 n = cellfun (@max, f);
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
73 else
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
74 n = f(1);
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
75 endif
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
76 else
10409
a87afd063e7d optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
77 error ("index: direction must be either \"first\" or \"last\"");
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3759
diff changeset
78 endif
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
79 endfunction
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
80
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
81 ## Test the function out
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
82 %!assert(index("astringbstringcstring", "s"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
83 %!assert(index("astringbstringcstring", "st"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
84 %!assert(index("astringbstringcstring", "str"), 2)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
85 %!assert(index("astringbstringcstring", "string"), 2)
6901
0baa196d93b5 [project @ 2007-09-14 17:16:42 by jwe]
jwe
parents: 6749
diff changeset
86 %!assert(index("abc---", "abc+++"), 0)
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
87
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
88 ## test everything out in reverse
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
89 %!assert(index("astringbstringcstring", "s", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
90 %!assert(index("astringbstringcstring", "st", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
91 %!assert(index("astringbstringcstring", "str", "last"), 16)
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
92 %!assert(index("astringbstringcstring", "string", "last"), 16)
6901
0baa196d93b5 [project @ 2007-09-14 17:16:42 by jwe]
jwe
parents: 6749
diff changeset
93 %!assert(index("abc---", "abc+++", "last"), 0)
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
94
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
95
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
96 %!assert(index ("foobarbaz", "b") == 4 && index ("foobarbaz", "z") == 9);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
97
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
98 %!error index ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
99
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
100 %!error index ("foo", "bar", 3);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
101