annotate libinterp/corefcn/strfind.cc @ 27315:86c5dd1283b6

Add support for "ForceCellOutput" option to strfind (bug #56699). * strfind.cc (Fstrfind): Add new calling form to documentation. Add explanation of new "ForceCellOutput" option. Add example showing its use to docstring. Decode third input and if ForceCellOutput option is true, then call Cell() to return a cell object on output of internal strfind routine. Add BIST tests for new option.
author Guillaume Flandin <guillaume.offline@gmail.com>
date Mon, 05 Aug 2019 08:51:40 -0700
parents 396d17dcfb9f
children e7dd7d98a058
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 /*
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25760
diff changeset
3 Copyright (C) 2009-2019 Jaroslav Hajek
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 10840
diff changeset
4 Copyright (C) 2009-2010 VZLU Prague
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
6 This file is part of Octave.
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
7
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23577
diff changeset
8 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
9 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: 23577
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
11 (at your option) any later version.
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
12
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
13 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
16 GNU General Public License for more details.
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
19 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: 23577
diff changeset
20 <https://www.gnu.org/licenses/>.
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22 */
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21547
diff changeset
24 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
25 # include "config.h"
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 #endif
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 #include <algorithm>
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
29 #include <deque>
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
30 #include <limits>
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
31 #include <string>
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32
19269
65554f5847ac don't include oct-locbuf.h in header files unnecessarily
John W. Eaton <jwe@octave.org>
parents: 19062
diff changeset
33 #include "oct-locbuf.h"
65554f5847ac don't include oct-locbuf.h in header files unnecessarily
John W. Eaton <jwe@octave.org>
parents: 19062
diff changeset
34
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35 #include "Cell.h"
23454
30b6eccd6708 use builtin-defun-decls.h to ensure declarations of interpreter functions
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
36 #include "builtin-defun-decls.h"
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
37 #include "defun.h"
23454
30b6eccd6708 use builtin-defun-decls.h to ensure declarations of interpreter functions
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
38 #include "errwarn.h"
27130
396d17dcfb9f don't include error.h in ov-base.h
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
39 #include "error.h"
23454
30b6eccd6708 use builtin-defun-decls.h to ensure declarations of interpreter functions
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
40 #include "ov.h"
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 #include "unwind-prot.h"
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42 #include "utils.h"
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
44 // This allows safe indexing with char.
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
45 // In C++, char may be (and often is) signed!
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 #define ORD(ch) static_cast<unsigned char>(ch)
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
47 #define TABSIZE (std::numeric_limits<unsigned char>::max () + 1)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 // This is the quick search algorithm, as described at
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
50 // http://www-igm.univ-mlv.fr/~lecroq/string/node19.html
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
51 static void
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
52 qs_preprocess (const Array<char>& needle,
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
53 octave_idx_type *table)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
54 {
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 const char *x = needle.data ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 octave_idx_type m = needle.numel ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
57
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
58 for (octave_idx_type i = 0; i < TABSIZE; i++)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
59 table[i] = m + 1;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
60 for (octave_idx_type i = 0; i < m; i++)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
61 table[ORD(x[i])] = m - i;
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
62 }
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
64 static Array<octave_idx_type>
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65 qs_search (const Array<char>& needle,
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 const Array<char>& haystack,
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
67 const octave_idx_type *table,
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
68 bool overlaps = true)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
69 {
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
70 const char *x = needle.data ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
71 octave_idx_type m = needle.numel ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
72 const char *y = haystack.data ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
73 octave_idx_type n = haystack.numel ();
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
74
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
75 // We'll use deque because it typically has the most favorable properties for
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
76 // the operation we need.
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
77 std::deque<octave_idx_type> accum;
10133
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
78 if (m == 1)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
79 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
80 // Looking for a single character.
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
81 for (octave_idx_type i = 0; i < n; i++)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
82 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
83 if (y[i] == x[0])
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
84 accum.push_back (i);
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
85 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
86 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
87 else if (m == 2)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
88 {
10133
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
89 // Two characters.
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
90 if (overlaps)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
91 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
92 for (octave_idx_type i = 0; i < n-1; i++)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
93 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
94 if (y[i] == x[0] && y[i+1] == x[1])
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
95 accum.push_back (i);
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
96 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
97 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
98 else
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
99 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
100 for (octave_idx_type i = 0; i < n-1; i++)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
101 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
102 if (y[i] == x[0] && y[i+1] == x[1])
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
103 accum.push_back (i++);
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
104 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
105 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
106 }
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
107 else if (n >= m)
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
108 {
2e4fc7fdba15 optimize strfind with 1 or 2 characters
Jaroslav Hajek <highegg@gmail.com>
parents: 10086
diff changeset
109 // General case.
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
110 octave_idx_type j = 0;
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
111
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
112 if (overlaps)
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
113 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
114 while (j < n - m)
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
115 {
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
116 if (std::equal (x, x + m, y + j))
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
117 accum.push_back (j);
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
118 j += table[ORD(y[j + m])];
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
119 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
120 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
121 else
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
122 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
123 while (j < n - m)
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
124 {
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
125 if (std::equal (x, x + m, y + j))
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
126 {
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
127 accum.push_back (j);
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
128 j += m;
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
129 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
130 else
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
131 j += table[ORD(y[j + m])];
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
132 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
133 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
134
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
135 if (j == n - m && std::equal (x, x + m, y + j))
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
136 accum.push_back (j);
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
137 }
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
138
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
139 octave_idx_type nmatch = accum.size ();
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10133
diff changeset
140 octave_idx_type one = 1;
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10133
diff changeset
141 Array<octave_idx_type> result (dim_vector (std::min (one, nmatch), nmatch));
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
142 octave_idx_type k = 0;
22862
e365e87371a3 maint: Use C++ range feature to simplify some for loops in libinterp/corefcn.
Rik <rik@octave.org>
parents: 22755
diff changeset
143 for (const auto& idx : accum)
e365e87371a3 maint: Use C++ range feature to simplify some for loops in libinterp/corefcn.
Rik <rik@octave.org>
parents: 22755
diff changeset
144 result.xelem (k++) = idx;
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
145
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
146 return result;
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
147 }
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
148
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
149 DEFUN (strfind, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
150 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
151 @deftypefn {} {@var{idx} =} strfind (@var{str}, @var{pattern})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
152 @deftypefnx {} {@var{idx} =} strfind (@var{cellstr}, @var{pattern})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
153 @deftypefnx {} {@var{idx} =} strfind (@dots{}, "overlaps", @var{val})
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
154 @deftypefnx {} {@var{idx} =} strfind (@dots{}, "forcecelloutput", @var{val})
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
155 Search for @var{pattern} in the string @var{str} and return the starting
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
156 index of every such occurrence in the vector @var{idx}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
157
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
158 If there is no such occurrence, or if @var{pattern} is longer than
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
159 @var{str}, or if @var{pattern} itself is empty, then @var{idx} is the empty
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
160 array @code{[]}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
161
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
162 The optional argument @qcode{"overlaps"} determines whether the pattern
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
163 can match at every position in @var{str} (true), or only for unique
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
164 occurrences of the complete pattern (false). The default is true.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
165
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
166 If a cell array of strings @var{cellstr} is specified then @var{idx} is a
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
167 cell array of vectors, as specified above.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
168
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
169 The optional argument @qcode{"forcecelloutput"} forces @var{idx} to be
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
170 returned as a cell array of vectors. The default is false.
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
171
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
172 Examples:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
173
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
174 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
175 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
176 strfind ("abababa", "aba")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
177 @result{} [1, 3, 5]
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
178
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
179 strfind ("abababa", "aba", "overlaps", false)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
180 @result{} [1, 5]
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
181
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
182 strfind (@{"abababa", "bebebe", "ab"@}, "aba")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
183 @result{}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
184 @{
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
185 [1,1] =
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
186
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
187 1 3 5
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
188
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
189 [1,2] = [](1x0)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
190 [1,3] = [](1x0)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
191 @}
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
192
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
193 strfind ("abababa", "aba", "forcecelloutput", true)
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
194 @result{}
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
195 @{
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
196 [1,1] =
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
197
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
198 1 3 5
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
199 @}
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
200 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
201 @end example
25760
2ccad4396afc findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents: 25646
diff changeset
202 @seealso{regexp, regexpi, find}
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
203 @end deftypefn */)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
204 {
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
205 int nargin = args.length ();
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
206
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
207 if (nargin != 4 && nargin != 2)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
208 print_usage ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
209
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
210 bool overlaps = true;
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
211 bool forcecelloutput = false;
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
212 if (nargin == 4)
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
213 {
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
214 if (! args(2).is_string () || ! args(3).is_scalar_type ())
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
215 error ("strfind: invalid optional arguments");
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
216
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
217 std::string opt = args(2).string_value ();
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
218 std::transform (opt.begin (), opt.end (), opt.begin (), tolower);
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
219
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
220 if (opt == "overlaps")
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
221 overlaps = args(3).bool_value ();
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
222 else if (opt == "forcecelloutput")
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
223 forcecelloutput = args(3).bool_value ();
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
224 else
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
225 error ("strfind: unknown option: %s", opt.c_str ());
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
226 }
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
227
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
228 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
229
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
230 octave_value argstr = args(0);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
231 octave_value argpat = args(1);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
232
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
233 if (argpat.is_string ())
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
234 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
235 Array<char> needle = argpat.char_array_value ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
236 OCTAVE_LOCAL_BUFFER (octave_idx_type, table, TABSIZE);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
237 qs_preprocess (needle, table);
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
238
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
239 if (argstr.is_string ())
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
240 {
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
241 if (argpat.isempty ())
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
242 // Return a null matrix for null pattern for MW compatibility
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
243 retval = Matrix ();
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
244 else
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
245 retval = octave_value (qs_search (needle,
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
246 argstr.char_array_value (),
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
247 table, overlaps),
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
248 true, true);
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
249 if (forcecelloutput)
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
250 retval = Cell (retval);
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
251 }
23576
00e518162fda maint: Deprecate is_cell and replace with iscell.
Rik <rik@octave.org>
parents: 23454
diff changeset
252 else if (argstr.iscell ())
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
253 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
254 const Cell argsc = argstr.cell_value ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
255 Cell retc (argsc.dims ());
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
256 octave_idx_type ns = argsc.numel ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
257
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
258 for (octave_idx_type i = 0; i < ns; i++)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
259 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
260 octave_value argse = argsc(i);
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
261 if (! argse.is_string ())
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
262 error ("strfind: each element of CELLSTR must be a string");
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
263
23577
80c42f4cca13 maint: Deprecate is_empty and replace with isempty.
Rik <rik@octave.org>
parents: 23576
diff changeset
264 if (argpat.isempty ())
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
265 retc(i) = Matrix ();
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
266 else
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
267 retc(i) = octave_value (qs_search (needle,
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
268 argse.char_array_value (),
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
269 table, overlaps),
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
270 true, true);
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
271 }
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
272
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
273 retval = retc;
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
274 }
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
275 else
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
276 error ("strfind: first argument must be a string or cell array of strings");
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
277 }
23576
00e518162fda maint: Deprecate is_cell and replace with iscell.
Rik <rik@octave.org>
parents: 23454
diff changeset
278 else if (argpat.iscell ())
25646
4d565baa475e move libinterp/utils functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
279 retval = octave::do_simple_cellfun (Fstrfind, "strfind", args);
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
280 else
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
281 error ("strfind: PATTERN must be a string or cell array of strings");
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
282
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
283 return retval;
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
284 }
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
285
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
286 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
287 %!assert (strfind ("abababa", "aba"), [1, 3, 5])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
288 %!assert (strfind ("abababa", "aba", "overlaps", false), [1, 5])
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
289 %!assert (strfind ("abababa", "aba", "forcecelloutput", false), [1, 3, 5])
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
290 %!assert (strfind ("abababa", "aba", "forcecelloutput", true), {[1, 3, 5]})
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
291 %!assert (strfind ({"abababa", "bla", "bla"}, "a"), {[1, 3, 5, 7], 3, 3})
27315
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
292 %!assert (strfind ({"abababa", "bla", "bla"}, "a", "forcecelloutput", false), {[1, 3, 5, 7], 3, 3})
86c5dd1283b6 Add support for "ForceCellOutput" option to strfind (bug #56699).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 27130
diff changeset
293 %!assert (strfind ({"abababa", "bla", "bla"}, "a", "forcecelloutput", true), {[1, 3, 5, 7], 3, 3})
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
294 %!assert (strfind ("Linux _is_ user-friendly. It just isn't ignorant-friendly or idiot-friendly.", "friendly"), [17, 50, 68])
19386
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
295 %!assert (strfind ("abc", ""), [])
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
296 %!assert (strfind ("abc", {"", "b", ""}), {[], 2, []})
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
297 %!assert (strfind ({"abc", "def"}, ""), {[], []})
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
298
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
299 %!error strfind ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
300 %!error strfind ("foo", "bar", 1)
19386
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
301 %!error <unknown option: foobar> strfind ("foo", 100, "foobar", 1)
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
302 %!error <each element of CELLSTR must be a string> strfind ({"A", 1}, "foo")
f054112912df Change strfind to return empty array for empty pattern for compatibility (bug #43649).
Rik <rik@octave.org>
parents: 19269
diff changeset
303 %!error <first argument must be a string> strfind (100, "foo")
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
304 %!error <PATTERN must be a string> strfind ("foo", 100)
10022
a14dc255427f omitted file in last patch
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
305 */
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
306
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
307 static Array<char>
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
308 qs_replace (const Array<char>& str, const Array<char>& pat,
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
309 const Array<char>& rep,
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
310 const octave_idx_type *table,
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
311 bool overlaps = true)
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
312 {
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
313 Array<char> ret = str;
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
314
18100
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
315 octave_idx_type siz = str.numel ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
316 octave_idx_type psiz = pat.numel ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 17787
diff changeset
317 octave_idx_type rsiz = rep.numel ();
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
318
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
319 if (psiz != 0)
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
320 {
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
321 // Look up matches, without overlaps.
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
322 const Array<octave_idx_type> idx = qs_search (pat, str, table, overlaps);
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
323 octave_idx_type nidx = idx.numel ();
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
324
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
325 if (nidx)
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
326 {
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
327 // Compute result size.
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
328 octave_idx_type retsiz;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
329 if (overlaps)
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
330 {
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
331 retsiz = 0;
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21724
diff changeset
332 // OMG. Is this the "right answer" MW always looks for, or
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
333 // someone was just lazy?
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
334 octave_idx_type k = 0;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
335 for (octave_idx_type i = 0; i < nidx; i++)
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
336 {
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
337 octave_idx_type j = idx(i);
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
338 if (j >= k)
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
339 retsiz += j - k;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
340 retsiz += rsiz;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
341 k = j + psiz;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
342 }
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
343
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
344 retsiz += siz - k;
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
345 }
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
346 else
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
347 retsiz = siz + nidx * (rsiz - psiz);
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
348
18763
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
349 if (retsiz == 0)
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
350 ret.clear (dim_vector (0, 0));
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19386
diff changeset
351 else
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
352 {
18763
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
353 ret.clear (dim_vector (1, retsiz));
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
354 const char *src = str.data ();
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
355 const char *reps = rep.data ();
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
356 char *dest = ret.fortran_vec ();
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
357
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
358 octave_idx_type k = 0;
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
359 for (octave_idx_type i = 0; i < nidx; i++)
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
360 {
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
361 octave_idx_type j = idx(i);
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
362 if (j >= k)
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
363 dest = std::copy (src + k, src + j, dest);
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
364 dest = std::copy (reps, reps + rsiz, dest);
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
365 k = j + psiz;
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
366 }
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
367
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
368 std::copy (src + k, src + siz, dest);
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
369 }
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
370 }
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
371 }
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
372
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
373 return ret;
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
374 }
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
375
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14501
diff changeset
376 DEFUN (strrep, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
377 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
378 @deftypefn {} {@var{newstr} =} strrep (@var{str}, @var{ptn}, @var{rep})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
379 @deftypefnx {} {@var{newstr} =} strrep (@var{cellstr}, @var{ptn}, @var{rep})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
380 @deftypefnx {} {@var{newstr} =} strrep (@dots{}, "overlaps", @var{val})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
381 Replace all occurrences of the pattern @var{ptn} in the string @var{str}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
382 with the string @var{rep} and return the result.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
383
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
384 The optional argument @qcode{"overlaps"} determines whether the pattern
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
385 can match at every position in @var{str} (true), or only for unique
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
386 occurrences of the complete pattern (false). The default is true.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
387
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
388 @var{s} may also be a cell array of strings, in which case the replacement
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
389 is done for each element and a cell array is returned.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
390
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
391 Example:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
392
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
393 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
394 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
395 strrep ("This is a test string", "is", "&%$")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
396 @result{} "Th&%$ &%$ a test string"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
397 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
398 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
399
25760
2ccad4396afc findstr.m: Make m-file a legacy function.
Rik <rik@octave.org>
parents: 25646
diff changeset
400 @seealso{regexprep, strfind}
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
401 @end deftypefn */)
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
402 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
403 int nargin = args.length ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
404
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
405 if (nargin != 3 && nargin != 5)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
406 print_usage ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
407
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
408 bool overlaps = true;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
409
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
410 if (nargin == 5)
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
411 {
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
412 if (! args(3).is_string () || ! args(4).is_scalar_type ())
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
413 error ("strrep: invalid optional arguments");
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
414
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
415 std::string opt = args(3).string_value ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
416 if (opt == "overlaps")
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
417 overlaps = args(4).bool_value ();
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
418 else
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
419 error ("strrep: unknown option: %s", opt.c_str ());
10677
21defab4207c make strrep not skipping overlaps by default, allow an option in both strfind/strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
420 }
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
421
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
422 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
423
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
424 octave_value argstr = args(0);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
425 octave_value argpat = args(1);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
426 octave_value argrep = args(2);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
427
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
428 if (argpat.is_string () && argrep.is_string ())
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
429 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
430 const Array<char> pat = argpat.char_array_value ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
431 const Array<char> rep = argrep.char_array_value ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
432
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
433 OCTAVE_LOCAL_BUFFER (octave_idx_type, table, TABSIZE);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
434 qs_preprocess (pat, table);
10074
5e2b4b7967cc allow array of strings in strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10053
diff changeset
435
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
436 if (argstr.is_string ())
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
437 retval = qs_replace (argstr.char_array_value (), pat, rep,
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
438 table, overlaps);
23576
00e518162fda maint: Deprecate is_cell and replace with iscell.
Rik <rik@octave.org>
parents: 23454
diff changeset
439 else if (argstr.iscell ())
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
440 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
441 const Cell argsc = argstr.cell_value ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
442 Cell retc (argsc.dims ());
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
443 octave_idx_type ns = argsc.numel ();
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
444
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
445 for (octave_idx_type i = 0; i < ns; i++)
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
446 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
447 octave_value argse = argsc(i);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
448 if (argse.is_string ())
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
449 retc(i) = qs_replace (argse.char_array_value (), pat, rep,
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
450 table, overlaps);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
451 else
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
452 error ("strrep: each element of S must be a string");
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
453 }
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
454
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
455 retval = retc;
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
456 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
457 else
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
458 error ("strrep: S must be a string or cell array of strings");
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
459 }
23576
00e518162fda maint: Deprecate is_cell and replace with iscell.
Rik <rik@octave.org>
parents: 23454
diff changeset
460 else if (argpat.iscell () || argrep.iscell ())
25646
4d565baa475e move libinterp/utils functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
461 retval = octave::do_simple_cellfun (Fstrrep, "strrep", args);
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
462 else
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20172
diff changeset
463 error ("strrep: PTN and REP arguments must be strings or cell arrays of strings");
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
464
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
465 return retval;
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
466 }
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
467
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
468 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
469 %!assert (strrep ("This is a test string", "is", "&%$"),
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
470 %! "Th&%$ &%$ a test string")
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
471 %!assert (strrep ("abababc", "abab", "xyz"), "xyzxyzc")
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
472 %!assert (strrep ("abababc", "abab", "xyz", "overlaps", false), "xyzabc")
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
473
18763
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
474 %!assert (size (strrep ("a", "a", "")), [0 0])
86818f2c4a92 Return 0x0 empty matrix from strrep for Matlab compatibility (bug #42341).
Rik <rik@octave.org>
parents: 18100
diff changeset
475
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
476 %!error strrep ()
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
477 %!error strrep ("foo", "bar", 3, 4)
10053
830986c43dee implement compiled strrep
Jaroslav Hajek <highegg@gmail.com>
parents: 10022
diff changeset
478 */