Mercurial > octave
annotate scripts/legacy/findstr.m @ 26376:00f796120a6d stable
maint: Update copyright dates in all source files.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 02 Jan 2019 16:32:43 -0500 |
parents | 2ccad4396afc |
children | b442ec6dda5c |
rev | line source |
---|---|
26376
00f796120a6d
maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents:
25760
diff
changeset
|
1 ## Copyright (C) 1996-2019 Kurt Hornik |
2325 | 2 ## |
2313 | 3 ## This file is part of Octave. |
4 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
5 ## Octave is free software: you can redistribute it and/or modify it |
2313 | 6 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
7 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
8 ## (at your option) any later version. |
2313 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## GNU General Public License for more details. |
2313 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
17 ## <https://www.gnu.org/licenses/>. |
2272 | 18 |
3361 | 19 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
20 ## @deftypefn {} {} findstr (@var{s}, @var{t}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
21 ## @deftypefnx {} {} findstr (@var{s}, @var{t}, @var{overlap}) |
25760
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
22 ## |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
23 ## This function is obsolete. Use @code{strfind} instead. |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
24 ## |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19957
diff
changeset
|
25 ## Return the vector of all positions in the longer of the two strings @var{s} |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19957
diff
changeset
|
26 ## and @var{t} where an occurrence of the shorter of the two starts. |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19957
diff
changeset
|
27 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19957
diff
changeset
|
28 ## If the optional argument @var{overlap} is true (default), the returned |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19957
diff
changeset
|
29 ## vector can include overlapping positions. For example: |
3426 | 30 ## |
3361 | 31 ## @example |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
32 ## @group |
3361 | 33 ## findstr ("ababab", "a") |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
34 ## @result{} [1, 3, 5]; |
3361 | 35 ## findstr ("abababa", "aba", 0) |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
36 ## @result{} [1, 5] |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7411
diff
changeset
|
37 ## @end group |
3361 | 38 ## @end example |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
39 ## |
25760
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
40 ## @strong{Caution:} @code{findstr} is obsolete. Use @code{strfind} in all new |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
41 ## code. |
19957
e78c0514523d
restore strmatch function; backout changeset f9959972949a
John W. Eaton <jwe@octave.org>
parents:
19833
diff
changeset
|
42 ## @seealso{strfind, strmatch, strcmp, strncmp, strcmpi, strncmpi, find} |
3361 | 43 ## @end deftypefn |
2272 | 44 |
3891 | 45 ## Note that this implementation swaps the strings if second one is longer |
46 ## than the first, so try to put the longer one first. | |
25760
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
47 |
5428 | 48 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> |
2355 | 49 ## Adapted-By: jwe |
2314 | 50 |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
51 function v = findstr (s, t, overlap = true) |
2275 | 52 |
25760
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
53 persistent warned = false; |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
54 if (! warned) |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
55 warned = true; |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
56 warning ("Octave:legacy-function", |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
57 "findstr is obsolete; use strfind instead\n"); |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
58 endif |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
59 |
2275 | 60 if (nargin < 2 || nargin > 3) |
6046 | 61 print_usage (); |
2275 | 62 endif |
63 | |
5348 | 64 if (all (size (s) > 1) || all (size (t) > 1)) |
65 error ("findstr: arguments must have only one non-singleton dimension"); | |
3891 | 66 endif |
67 | |
68 ## Make S be the longer string. | |
69 if (length (s) < length (t)) | |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
70 [s, t] = deal (t, s); |
3891 | 71 endif |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
72 |
3891 | 73 l_s = length (s); |
74 l_t = length (t); | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
75 |
3891 | 76 if (l_t == 0) |
4321 | 77 ## zero length target: return empty set |
78 v = []; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
79 |
3891 | 80 elseif (l_t == 1) |
81 ## length one target: simple find | |
82 v = find (s == t); | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
83 |
3891 | 84 elseif (l_t == 2) |
85 ## length two target: find first at i and second at i+1 | |
86 v = find (s(1:l_s-1) == t(1) & s(2:l_s) == t(2)); | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
87 |
3891 | 88 else |
89 ## length three or more: match the first three by find then go through | |
90 ## the much smaller list to determine which of them are real matches | |
91 limit = l_s - l_t + 1; | |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
92 v = find ( s(1:limit) == t(1) |
10549 | 93 & s(2:limit+1) == t(2) |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
94 & s(3:limit+2) == t(3)); |
3891 | 95 endif |
3759 | 96 |
3891 | 97 ## Need to search the index vector if our find was too short |
98 ## (target length > 3), or if we don't allow overlaps. Note though | |
99 ## that there cannot be any overlaps if the first character in the | |
100 ## target is different from the remaining characters in the target, | |
101 ## so a single character, two different characters, or first character | |
102 ## different from the second two don't need to be searched. | |
103 if (l_t >= 3 || (! overlap && l_t > 1 && any (t(1) == t(2:l_t)))) | |
104 ## force strings to be both row vectors or both column vectors | |
105 if (all (size (s) != size (t))) | |
106 t = t.'; | |
107 endif | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
108 |
3891 | 109 ## determine which ones to keep |
110 keep = zeros (size (v)); | |
111 ind = 0:l_t-1; | |
112 if (overlap) | |
113 for idx = 1:length (v) | |
10549 | 114 keep(idx) = all (s(v(idx) + ind) == t); |
3891 | 115 endfor |
2272 | 116 else |
8506 | 117 ## First possible position for next non-overlapping match. |
118 next = 1; | |
3891 | 119 for idx = 1:length (v) |
10549 | 120 if (v(idx) >= next && s(v(idx) + ind) == t) |
121 keep(idx) = 1; | |
122 ## Skip to the next possible match position. | |
123 next = v(idx) + l_t; | |
124 else | |
125 keep(idx) = 0; | |
126 endif | |
3891 | 127 endfor |
2272 | 128 endif |
3891 | 129 if (! isempty (v)) |
130 v = v(find (keep)); | |
131 endif | |
132 endif | |
5400 | 133 |
134 if (isempty (v)) | |
135 v = []; | |
136 endif | |
137 | |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
138 ## Always return a row vector, because that's what the old one did. |
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
139 if (iscolumn (v)) |
3891 | 140 v = v.'; |
2272 | 141 endif |
142 | |
143 endfunction | |
7411 | 144 |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
145 |
25760
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
146 ## First test is necessary to provoke 1-time legacy warning |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
147 %!test |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
148 %! warning ("off", "Octave:legacy-function", "local"); |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
149 %! findstr ("", ""); |
2ccad4396afc
findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
150 |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
151 %!assert (findstr ("abababa", "a"), [1, 3, 5, 7]) |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
152 %!assert (findstr ("abababa", "aba"), [1, 3, 5]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
153 %!assert (findstr ("aba", "abababa", 0), [1, 5]) |
7411 | 154 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
155 ## Test input validation |
13177
17b702fae303
findstr.m: Use more modern code practices in function.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
156 %!error findstr () |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
157 %!error findstr ("foo", "bar", 3, 4) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
158 %!error <must have only one non-singleton dimension> findstr (["AB" ; "CD"], "C") |