Mercurial > hg > octave-nkf

annotate scripts/strings/strfind.m @ 8920:eb63fbe60fab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents 502e58a0d44f
children 58604c45ca74
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: 8442
diff changeset
1 ## Copyright (C) 2004, 2006, 2007, 2009 by Alois Schloegl
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
3 ## This file is part of Octave.
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
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: 6046
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## General Public License for more details.
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
14 ##
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
18
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{idx} =} strfind (@var{str}, @var{pattern})
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{idx} =} strfind (@var{cellstr}, @var{pattern})
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
22 ## Search for @var{pattern} in the string @var{str} and return the
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
23 ## starting index of every such occurrence in the vector @var{idx}.
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
24 ## If there is no such occurrence, or if @var{pattern} is longer
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
25 ## than @var{str}, then @var{idx} is the empty array @code{[]}.
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
26 ##
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
27 ## If the cell array of strings @var{cellstr} is specified instead of the
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
28 ## string @var{str}, then @var{idx} is a cell array of vectors, as specified
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
29 ## above. Examples:
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
30 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
31 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
32 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
33 ## strfind ("abababa", "aba")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
34 ## @result{} [1, 3, 5]
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
35 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
36 ## strfind (@{"abababa", "bebebe", "ab"@}, "aba")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
37 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
38 ## @{
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
39 ## [1,1] =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
40 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
41 ## 1 3 5
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
42 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
43 ## [1,2] = [](1x0)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
44 ## [1,3] = [](1x0)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
45 ## @}
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
46 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
47 ## @end example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
48 ## @seealso{findstr, strmatch, strcmp, strncmp, strcmpi, strncmpi, find}
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
49 ## @end deftypefn
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
50
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
51 ## Author: alois schloegl <a.schloegl@ieee.org>
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
52 ## Created: 1 November 2004
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
53 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
54
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
55 function idx = strfind (text, pattern)
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
56
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
57 if (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5720
diff changeset
58 print_usage ();
5678
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
59 elseif (! ischar (pattern))
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
60 error ("strfind: pattern must be a string value");
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
61 endif
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
62
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
63 lp = length (pattern);
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
64
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
65 if (ischar (text))
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
66 idx = __strfind_string__ (text, pattern, lp);
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
67 elseif (iscellstr (text))
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
68 idx = cell (size (text));
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
69 for i = 1:(numel (text))
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
70 idx{i} = __strfind_string__ (text{i}, pattern, lp);
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
71 endfor
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
72 else
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
73 error ("strfind: text must be a string or cell array of strings");
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
74 endif
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
75
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
76 ### endfunction
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
77
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
78 function idx = __strfind_string__ (text, pattern, lp)
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
79
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
80 idx = 1:(length (text) - lp + 1);
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
81 k = 0;
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
82 while (k < lp && ! isempty (idx))
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
83 idx = idx(text(idx + k) == pattern(++k));
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
84 endwhile
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
85
52323f13c86b [project @ 2006-03-16 06:45:08 by jwe]
jwe
parents:
diff changeset
86 ### endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
87
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
88 %!error <Invalid call to strfind> strfind ();
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
89 %!error <Invalid call to strfind> strfind ("foo", "bar", 1);
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
90 %!error <pattern must be a string value> strfind ("foo", 100);
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
91 %!error <text must be a string or cell array of string> strfind (100, "foo");
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
92
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
93 %!assert (strfind ("abababa", "aba"), [1, 3, 5]);
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
94 %!assert (strfind ({"abababa", "bla", "bla"}, "a"), {[1, 3, 5, 7], 3, 3});